plone / plone/documentation

Add chapter or section to admin guide on how to create a new backend add-on and how to include in backend

Open
#1,768 13 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

04 type: enhancement
Dominant language
Makefile
Stars
106
Forks
190
Avg merge
3d 2h
Merged PRs (30d)
1

Description

Links of affected pages in Plone Documentation, if any.

https://6.docs.plone.org/admin-guide/index.html

Description

https://6.docs.plone.org/admin-guide/index.html is a well improved bundle of chapters, @davisagli
Correct me if I am wrong, but I think it's missing a chapter on how to create a new backend add-on and how to include in backend.
See https://training.plone.org/mastering-plone/voting-story/index.html#integrate-backend-package-in-training-setup where this is done.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the admin guide index at https://6.docs.plone.org/admin-guide/index.html and compare it with the linked Voting Story training section on integrating a backend package. Add a chapter or section that explains how to create a backend add-on and include it in the backend, covering the workflow demonstrated by that example.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.