-
-
Notifications
You must be signed in to change notification settings - Fork 154
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Create Development guide as a primary navigation item and entry point #1731
Closed
Closed
Changes from 2 commits
Commits
Show all changes
8 commits
Select commit
Hold shift + click to select a range
abf9f8f
Create Development guide as a primary navigation item and entry point
stevepiercy bb1e8ba
Merge branch '6.0' into development-guide
stevepiercy c56aa62
Revise Test section, adding an admonition for the frontend, and remov…
stevepiercy 68fd8d8
Update tips submodules/volto
stevepiercy 03a811e
Add a preliminary outline to Development Guide, creating a space for …
stevepiercy 639d69b
Tag links with Plone 5 as needed.
stevepiercy a54ed8e
Add a local reference for content type schemas.
stevepiercy ee7d5bc
Merge branch '6.0' into development-guide
stevepiercy File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,47 @@ | ||
| --- | ||
| myst: | ||
| html_meta: | ||
| "description": "Development guide for Plone 6" | ||
| "property=og:description": "Development guide for Plone 6" | ||
| "property=og:title": "Development guide for Plone 6" | ||
| "keywords": "Plone, development, guide, tests, Volto, frontend, REST API, plone.api, backend" | ||
| --- | ||
|
|
||
| (development-guide-label)= | ||
|
|
||
| # Development guide | ||
|
|
||
| This part of Plone 6 documentation provides guidance for the development of Plone. | ||
|
|
||
| Development of Plone uses both the Python and JavaScript ecosystems. | ||
|
|
||
| - Volto, the default frontend for Plone 6, is based on the React JavaScript framework. | ||
| - Classic UI, the legacy frontend in Plone 6 and earlier versions, is based on the Twitter Bootstrap 5 framework and other JavaScript tools. | ||
| - The backend consists of dozens of Python packages. | ||
| Plone REST API and `plone.api` are two of the more prominent Python packages in the Plone backend. | ||
|
|
||
| Each frontend and backend package may have its own specific development methods. | ||
| This development guide points you, as a developer, to the appropriate resource. | ||
|
|
||
|
|
||
| ## Tests | ||
|
|
||
| Tests ensure that Plone functions as expected, and that changes to the code base during development don't break anything. | ||
|
|
||
|
|
||
| ### Volto | ||
|
|
||
| - {doc}`Volto acceptance tests </volto/contributing/acceptance-tests>` | ||
| - {doc}`Volto unit tests </volto/contributing/testing>` | ||
|
|
||
|
|
||
| ### Backend | ||
|
|
||
| - {doc}`Plone REST API tests </plone.restapi/docs/source/contributing/index>` | ||
| - {doc}`plone.api tests </plone.api/contribute>` | ||
| - {doc}`Backend tests <develop/testing/index>` (Plone 5) | ||
|
|
||
| ```{note} | ||
| Backend testing for Plone 6 is in the process of being written using Cookieplone and pytest. | ||
| Until it is complete, Plone 5 documentation is the authoritative source for testing the Plone backend, except for the explicitly listed backend packages above. | ||
| ``` | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The above 2 lines are about how to contribute to Plone itself, not how to develop your own projects based on Plone. They belong in the "Contributing to Plone" section, not the development guide.
There's a bunch of other stuff that should go in a development guide... how to use ZCML, GenericSetup, write content type schemas, register views, register API services, the various topics under https://6.docs.plone.org/volto/development/index.html ... should we try to tackle some of that now, or just merge this info on tests as the first step, and then continue later?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yeah, the testing standards are higher for contributing, but what else do we have to demonstrate how to write and run tests?
I will add empty headings for the stuff you mentioned, create issues for each to expose our needs, and add a todo in the docs with a link to the issue for each thing. Please feel free to list other concepts, and I'll add them. I'm fine with creating the outline, and adding content as time allows.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I added a few headings and references for the backend to get us started.
I think that the much of the content in the Backend folder will eventually end up under Development as a subdirectory. After that is done, I would break out the explanation and other non-how-to content into an appropriate section.