-
-
Notifications
You must be signed in to change notification settings - Fork 176
Start Admin Guide, revamp install/getting started #1746
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
Merged
Merged
Changes from 31 commits
Commits
Show all changes
33 commits
Select commit
Hold shift + click to select a range
dda3bd4
Start Admin Guide
davisagli 440c34e
Merge branch '6.0' into admin-guide
davisagli 2603852
Add run-plone to admin guide
davisagli 323429e
Add info about how to stop
davisagli 2645edd
Add chapter about backend add-ons to admin guide
davisagli af5ced1
Add overrides & zope config, remove old manage section
davisagli 4b688a7
move docs back to their old paths to avoid need for redirects
davisagli e74851f
Merge branch '6.0' into admin-guide
davisagli 87562cf
fixes
davisagli 1974821
Merge branch '6.0' into admin-guide
stevepiercy 50873f1
Fix duplicate glossary entry
stevepiercy ad103a9
Revise Admin guide, adding commented link to new Volto add-ons index.
stevepiercy 8ee9339
Comments not supported in toctree, move after it
stevepiercy dda4f2f
Split SUPPORTED_PYTHON_VERSIONS into two replacement variables for Pl…
stevepiercy 6a1211b
Add include for installing Python.
stevepiercy ee90925
Update include for installing Python, to avoid repetition.
stevepiercy a9163ca
The buildout instructions install only Plone 6.0.x
stevepiercy f40a973
Remove redundant installation of buildout
davisagli 0ce3e06
Recommend Plone 6.1 Python versions for core development
davisagli 242ba6f
Make includes for Python version more consistent and explicit
stevepiercy cec89fe
Use an include for creating a Classic UI instance in foreground mode
stevepiercy 1628502
Update create-project.md, removing note about not documenting how to …
stevepiercy b9e86b0
Rename _create-classic-ui-instance.inc to .md
stevepiercy bc07aa7
Tidy up run-plone.md, removing "with "s.
stevepiercy 72bfeee
Tidy up configure-zope.md
stevepiercy 8facc74
Shorten headings
stevepiercy 7f7ba8c
Tidy up add-ons.md
stevepiercy d8900d0
Tidy up override-core.md
stevepiercy 6665d7b
Merge branch '6.0' into admin-guide
stevepiercy e2f617c
Change passive to active voice
stevepiercy 0675809
Tidy up docs/install/index.md by reformatting Try a Plone demo sectio…
stevepiercy c4954cf
Use include for Python section of docs setup
davisagli 52e2cd9
Use a myst-parser comment for TODO in /install/index.md
davisagli 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 hidden or 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,15 @@ | ||
|
||
Your instance starts in foreground mode. | ||
This should be used only for troubleshooting or local demonstration purposes. | ||
|
||
Now you can visit `http://localhost:8080` in your browser. | ||
Click the button {guilabel}`Create Classic UI Plone site`. | ||
|
||
Enter {guilabel}`username` of `admin`, and {guilabel}`password` of `admin`. | ||
|
||
Enter values in the form, and click the button {guilabel}`Create Plone Site`. | ||
|
||
You will be redirected to your new Classic UI Plone site. | ||
|
||
To stop the Plone instance in foreground mode, type {kbd}`ctrl-c`. | ||
|
This file contains hidden or 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,6 @@ | ||
Installing Python is beyond the scope of this documentation. | ||
However, it is recommended to use a Python version manager, {term}`pyenv`, that allows you to install multiple versions of Python on your development environment without destroying your system's Python. | ||
% TODO: uncomment this line after upgrading to plone-sphinx-theme and latest Sphinx which supports replacements inside includes. | ||
% Plone requires Python version {SUPPORTED_PYTHON_VERSIONS_PLONE60}. | ||
|
||
Plone 6.0 requires Python version 3.8, 3.9, 3.10, 3.11, or 3.12. |
4 changes: 2 additions & 2 deletions
4
docs/_inc/_install-python.md → docs/_inc/_install-python-plone61.md
This file contains hidden or 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 |
---|---|---|
@@ -1,6 +1,6 @@ | ||
Installing Python is beyond the scope of this documentation. | ||
However, it is recommended to use a Python version manager, {term}`pyenv`, that allows you to install multiple versions of Python on your development environment without destroying your system's Python. | ||
% TODO: uncomment this line after upgrading to plone-sphinx-theme and latest Sphinx which supports replacements inside includes. | ||
% Plone requires Python version {SUPPORTED_PYTHON_VERSIONS}. | ||
% Plone requires Python version {SUPPORTED_PYTHON_VERSIONS_PLONE61}. | ||
|
||
Plone requires Python version 3.8, 3.9, 3.10, 3.11, or 3.12. | ||
Plone 6.1 requires Python version 3.10, 3.11, or 3.12. |
This file contains hidden or 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,226 @@ | ||
--- | ||
myst: | ||
html_meta: | ||
"description": "Install Plone add-ons" | ||
"property=og:description": "Install Plone add-ons" | ||
"property=og:title": "Install Plone add-ons" | ||
"keywords": "Plone 6, add-on, package, plugin, extension, install" | ||
--- | ||
|
||
(install-plone-add-ons-label)= | ||
|
||
# Install Plone add-ons | ||
|
||
This chapter explains how to install {term}`add-ons <add-on>` as Python packages to extend the functionality of the Plone backend or Classic UI. | ||
|
||
```{note} | ||
The Volto frontend has its own system of add-ons using Node.js packages. | ||
% TODO: update the following link after https://github.com/plone/volto/pull/6397 is merged to point to `/development/add-ons/index`. | ||
See {doc}`/volto/addons/index`. | ||
``` | ||
|
||
|
||
## Cookieplone | ||
|
||
Use the following instructions if you installed Plone with either Cookieplone or `cookiecutter-plone-starter`. | ||
|
||
|
||
### Install an add-on | ||
|
||
Add a line with the name of your add-on in the file {file}`backend/requirements.txt`. | ||
This example uses [`collective.easyform`](https://pypi.org/project/collective.easyform/). | ||
|
||
``` | ||
collective.easyform==4.2.1 | ||
``` | ||
|
||
```{tip} | ||
Including the add-on version, or "pinning a version", ensures that it won't unintentionally get upgraded in the future. | ||
``` | ||
|
||
Also add the add-on to `zcml_package_includes` in the file {file}`backend/instance.yaml` to make sure its configuration will be loaded. | ||
|
||
```yaml | ||
default_context: | ||
zcml_package_includes: project_title, collective.easyform | ||
``` | ||
|
||
Stop the backend with {kbd}`ctrl-c`. | ||
|
||
To actually download and install the new add-on, run the following command. | ||
|
||
```shell | ||
make backend-build | ||
``` | ||
|
||
```{note} | ||
If you installed Plone using `cookiecutter-plone-starter`, run `make build-backend` instead. | ||
``` | ||
|
||
Now restart the backend. | ||
|
||
```{seealso} | ||
{doc}`run-plone` | ||
``` | ||
|
||
In your web browser, and assuming you are currently logged in as an administrator, visit the URL http://localhost:8080/Plone/prefs_install_products_form. | ||
|
||
Then click the {guilabel}`Install` button next to your add-on to complete installation of the add-on. | ||
|
||
Some add-ons have configuration options. | ||
To configure such add-ons, return to the {guilabel}`Site Setup` control panel. | ||
At the bottom of the page, you should see the heading {guilabel}`Add-on Configuration`, and a control panel to configure the add-on that you just installed. | ||
|
||
|
||
### Install an add-on from source | ||
|
||
An add-on can be installed from a source control system such as GitHub. | ||
|
||
Add a line with the name of your add-on in the file {file}`backend/requirements.txt`. | ||
This example uses [`collective.easyform`](https://pypi.org/project/collective.easyform/). | ||
|
||
``` | ||
collective.easyform | ||
``` | ||
|
||
```{note} | ||
When installing an add-on from source, it's best not to pin a version. | ||
This way you always get the version that's currently available in the source control system. | ||
``` | ||
|
||
Next add the add-on to `zcml_package_includes` in the file {file}`backend/instance.yaml` so that its configuration will load. | ||
|
||
```yaml | ||
default_context: | ||
zcml_package_includes: project_title, collective.easyform | ||
``` | ||
|
||
Finally, add the package's source to the file {file}`mx.ini`. | ||
|
||
```cfg | ||
[collective.easyform] | ||
url=git@github.com:collective/collective.easyform.git | ||
branch=dev-branch-name | ||
extras=test | ||
``` | ||
|
||
```{seealso} | ||
The {file}`mx.ini` file configures a tool called {term}`mxdev`. | ||
See the [documentation of `mxdev` in its README.md](https://github.com/mxstack/mxdev/blob/main/README.md) for complete information. | ||
``` | ||
|
||
Stop the backend with {kbd}`ctrl-c`. | ||
|
||
To actually download and install the new add-on, run the following command. | ||
|
||
```shell | ||
make backend-build | ||
``` | ||
|
||
```{note} | ||
If you installed Plone using `cookiecutter-plone-starter`, run `make build-backend` instead. | ||
``` | ||
|
||
Now restart the backend. | ||
|
||
```{seealso} | ||
{doc}`run-plone` | ||
``` | ||
|
||
In your web browser, and assuming you are currently logged in as an administrator, visit the URL http://localhost:8080/Plone/prefs_install_products_form. | ||
An upgrade step might need to be performed in the Plone control panel. | ||
Follow the upgrade information, if present. | ||
Else click the {guilabel}`Install` button to complete installation of the add-on. | ||
|
||
|
||
## with Buildout | ||
|
||
Use the following instructions if you installed Plone with Buildout. | ||
|
||
### Install an add-on | ||
|
||
Update the file {file}`buildout.cfg`. | ||
This example uses [`collective.easyform`](https://pypi.org/project/collective.easyform/). | ||
|
||
```cfg | ||
[buildout] | ||
extends = | ||
https://dist.plone.org/release/6-latest/versions.cfg | ||
|
||
parts = | ||
instance | ||
|
||
[instance] | ||
recipe = plone.recipe.zope2instance | ||
user = admin:admin | ||
http-address = 8080 | ||
eggs = | ||
Plone | ||
collective.easyform | ||
|
||
[versions] | ||
collective.easyform = 4.2.1 | ||
``` | ||
|
||
```{tip} | ||
Including the add-on version, or "pinning a version", ensures that it won't unintentionally get upgraded in the future. | ||
``` | ||
|
||
To actually download and install the new add-on, run the following command. | ||
|
||
```shell | ||
bin/buildout | ||
``` | ||
|
||
Then restart your instance. | ||
|
||
```{seealso} | ||
{doc}`run-plone` | ||
``` | ||
|
||
|
||
### Install an add-on from source | ||
|
||
You can install an add-on from a source control system such as GitHub. | ||
|
||
Update the file {file}`buildout.cfg`. | ||
This example uses [`collective.easyform`](https://pypi.org/project/collective.easyform/). | ||
|
||
```cfg | ||
[buildout] | ||
extends = | ||
https://dist.plone.org/release/6-latest/versions.cfg | ||
extensions = mr.developer | ||
auto-checkout = | ||
collective.easyform | ||
|
||
parts = | ||
instance | ||
|
||
[instance] | ||
recipe = plone.recipe.zope2instance | ||
user = admin:admin | ||
http-address = 8080 | ||
eggs = | ||
Plone | ||
collective.easyform | ||
|
||
[sources] | ||
collective.easyform = git https://github.com/collective/collective.easyform.git | ||
``` | ||
|
||
To actually download and install the new add-on, run the following command. | ||
|
||
```shell | ||
bin/buildout | ||
``` | ||
|
||
Then restart your instance. | ||
|
||
```{seealso} | ||
{doc}`run-plone` | ||
``` | ||
|
||
```{seealso} | ||
This approach uses the [`mr.developer`](https://pypi.org/project/mr.developer/) Buildout extension. | ||
``` |
This file contains hidden or 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,35 @@ | ||
--- | ||
myst: | ||
html_meta: | ||
"description": "Configure Zope options" | ||
"property=og:description": "Configure Zope options" | ||
"property=og:title": "Configure Zope" | ||
"keywords": "Plone 6, Zope, instance, app server, config, Cookieplone, Buildout, pip, cookiecutter-plone-starter, cookiecutter-zope-instance, plone.recipe.zope2instance" | ||
--- | ||
|
||
(configure-zope-label)= | ||
|
||
# Configure Zope | ||
|
||
Plone runs in an application server called {term}`Zope`. | ||
|
||
You can configure your Zope instance's options, including the following. | ||
|
||
- persistent storage: blobs, direct file storage, relational database, ZEO, and other storage mechanisms | ||
- ports | ||
- threads | ||
- cache | ||
- logging | ||
- debugging and profiling for development | ||
|
||
|
||
## Cookieplone | ||
|
||
If you installed Plone using Cookieplone, `cookiecutter-plone-starter`, or pip, then Zope is configured using {term}`cookiecutter-zope-instance`. | ||
For a complete list of features, usage, and options, read [`cookiecutter-zope-instance`'s README](https://github.com/plone/cookiecutter-zope-instance#readme). | ||
|
||
|
||
## Buildout | ||
|
||
If you installed Plone using Buildout, then Zope is configured using `plone.recipe.zope2instance`. | ||
For a complete list of features, usage, and options, read [`plone.recipe.zope2instance`'s README](https://pypi.org/project/plone.recipe.zope2instance/). |
This file contains hidden or 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": "How to install, operate, configure, and deploy Plone 6" | ||
"property=og:description": "How to install, operate, configure, and deploy Plone 6" | ||
"property=og:title": "Admin guide" | ||
"keywords": "Plone 6, admin, install, configuration, deploy" | ||
--- | ||
|
||
(admin-index-label)= | ||
|
||
# Admin guide | ||
|
||
In this part of the documentation, you can find how to install, operate, configure, and deploy Plone. | ||
|
||
|
||
```{toctree} | ||
:caption: Install | ||
:maxdepth: 1 | ||
|
||
/install/create-project-cookieplone | ||
install-buildout | ||
install-pip | ||
/install/create-project | ||
``` | ||
|
||
```{toctree} | ||
:caption: Operate | ||
:maxdepth: 1 | ||
|
||
run-plone | ||
configure-zope | ||
add-ons | ||
override-core | ||
/upgrade/index | ||
``` | ||
% TODO: uncomment and add the following link to the Operate toctree when https://github.com/plone/volto/pull/6397 is merged. | ||
% https://volto--6397.org.readthedocs.build/development/add-ons/install-an-add-on.html | ||
% /volto/development/add-ons/index | ||
|
||
|
||
```{toctree} | ||
:maxdepth: 1 | ||
:caption: Deploy | ||
|
||
/install/containers/index | ||
``` |
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.
Uh oh!
There was an error while loading. Please reload this page.