-
-
Notifications
You must be signed in to change notification settings - Fork 174
Document distributions in the 6.1 upgrade guide. #1733
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 41 commits
Commits
Show all changes
42 commits
Select commit
Hold shift + click to select a range
4a4cc22
Document distributions in the 6.1 upgrade guide.
mauritsvanrees 7a20cee
Review of Distributions documentation
stevepiercy 1bc1a9b
Align term definition with upgrade guide docs, avoiding circular refe…
stevepiercy d370c78
Fix admonition syntax
stevepiercy bb99d92
Add link to repo
stevepiercy 7331a00
Enhance screenshot with card syntax
stevepiercy 74dae32
Merge branch '6.0' into maurits-upgrade-61-distributions
stevepiercy 06e3008
Merge branch '6.0' into maurits-upgrade-61-distributions
stevepiercy a1059ca
plone.exportimport is not for upgrading Plone.
mauritsvanrees 486def1
Here we do not start a new project, I just mean: start Plone.
mauritsvanrees 47da6fd
These are not 'frontend distributions'.
mauritsvanrees 8c6e57f
Creating a 6.1 CMFPlone site differs from 6.0, that is the main point…
mauritsvanrees 73facb0
Don't mention installing add-ons here, activating is enough.
mauritsvanrees 729b306
Merge branch '6.0' into maurits-upgrade-61-distributions
stevepiercy 4001a5a
Merge branch '6.0' into maurits-upgrade-61-distributions
MrTango 8052b2a
reorganize distribution docs
davisagli ac367b7
Apply suggestions from code review
davisagli 01869a2
Merge branch '6.0' into maurits-upgrade-61-distributions
davisagli f9b845c
Merge branch '6.0' into maurits-upgrade-61-distributions
stevepiercy e25b72d
Update conceptual guide for distributions, where the significant chan…
stevepiercy d36830f
Create an entry in `index.md` to include a new `developer-guide/index…
stevepiercy a7ead92
Update glossary reference to other distribution material
stevepiercy 007a755
Add cross-reference
stevepiercy 5c0f197
Add JSON Schema to Glossary
stevepiercy 5c45891
Tidy up create-a-distribution.md.
stevepiercy 28d42ec
Revert distribution names and enhance `ALLOWED_DISTRIBUTIONS` usage.
stevepiercy ba0e074
Tidy up add-site.md, mostly docs style guide stuff, and a rewording o…
stevepiercy 7f78901
Tidy up distributions section in upgrade-to-61.md
stevepiercy 11d6d6c
Update docs/backend/upgrading/version-specific-migration/upgrade-to-6…
stevepiercy f024469
Merge branch '6.0' into maurits-upgrade-61-distributions
stevepiercy 606af43
Move add-site into Admin Guide.
stevepiercy fcd9757
Remove stray characters from bad merge
stevepiercy 7ccaecd
Resolve TODOs by moving file and adding link to new choose-user-inter…
stevepiercy 769336a
Merge branch '6.0' into maurits-upgrade-61-distributions
stevepiercy 9267edb
Update glossary with Zope instance and cross-references to Zope itself.
stevepiercy 3d900d1
Fix cross-references
stevepiercy 6fb37ee
Fix link
stevepiercy 585ef0a
Ignore link to static images
stevepiercy 0fc4efe
Ignore searches on GitHub as it rate limits and times out.
stevepiercy 469e63c
Merge branch '6.0' into maurits-upgrade-61-distributions
stevepiercy 4612c57
Merge branch '6.0' into maurits-upgrade-61-distributions
davisagli 90f20f6
Update docs/developer-guide/index.md
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 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,73 @@ | ||
--- | ||
myst: | ||
html_meta: | ||
"description": "How to add a Plone site to an existing Zope instance" | ||
"property=og:description": "How to add a Plone site to an existing Zope instance" | ||
"property=og:title": "Add a Plone site" | ||
"keywords": "Plone 6, create, add, factory, distributions" | ||
--- | ||
|
||
(add-a-plone-site-label)= | ||
|
||
# Add a Plone site | ||
|
||
This section explains how to add a Plone site to an existing Zope instance. | ||
It assumes that you have already {doc}`installed </install/index>` and started Plone. | ||
|
||
Some installation methods create a Plone site for you already. | ||
Follow these instructions if you used an installation method that did not do this, or if you need a second Plone site in the same instance for some reason. | ||
|
||
```{versionadded} Plone 6.1 | ||
The user interface for creating a new Plone site was changed in Plone 6.1. | ||
You can access it the same way in Plone 6.0, but the appearance and options are different. | ||
``` | ||
|
||
Visit the Plone backend in a web browser. | ||
Usually it is running at http://localhost:8080/. | ||
|
||
The launch screen prompts you to choose one of the available {term}`distributions` to create a new site. | ||
You can read {doc}`/conceptual-guides/choose-user-interface` to help inform your choice between Volto and Classic UI. | ||
|
||
````{card} | ||
```{image} /backend/upgrading/version-specific-migration/images/distribution-chooser.png | ||
:alt: Launch screen for choosing a distribution | ||
:target: /_images/distribution-chooser.png | ||
``` | ||
+++ | ||
_Launch screen for choosing a distribution_ | ||
```` | ||
|
||
Hover over your choice and click the {guilabel}`Create` button. | ||
|
||
Now complete the form with initial configuration for your site. | ||
You can configure the following settings. | ||
|
||
Path Identifier | ||
: The ID of the site. | ||
This ends up as part of the URL unless hidden by an upstream web server. | ||
|
||
Title | ||
: The name of the site in the HTML `title` element. | ||
This will be shown as part of the title of the browser tab on each page. | ||
|
||
Site Description | ||
: A brief description that will be served in an HTML `meta` tag. | ||
|
||
Site Logo | ||
: Upload an image as the main site logo. | ||
|
||
Language | ||
: The main language of the site. | ||
|
||
Timezone | ||
: The default timezone setting of the portal. | ||
|
||
Finally, click the {guilabel}`Submit` button. | ||
|
||
Have fun with your new Plone site! | ||
|
||
```{important} | ||
The launch screen for adding a site is hosted by the Plone backend server. | ||
Regardless of the frontend you select, you will be redirected to the backend's user interface after you create the site. | ||
If you select the Volto frontend, you can switch to it by changing the port number in the URL, usually `3000`, and visiting it at http://localhost:3000, for example. | ||
``` |
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 |
---|---|---|
|
@@ -29,6 +29,7 @@ install-pip | |
:maxdepth: 1 | ||
|
||
run-plone | ||
add-site | ||
configure-zope | ||
add-ons | ||
override-core | ||
|
Binary file added
BIN
+106 KB
docs/backend/upgrading/version-specific-migration/images/distribution-chooser.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
stevepiercy marked this conversation as resolved.
Show resolved
Hide resolved
|
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
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,89 @@ | ||
--- | ||
myst: | ||
html_meta: | ||
"description": "A Plone distribution is a pre-packaged version of Plone that includes specific features, themes, modules, and configurations." | ||
"property=og:description": "A Plone distribution is a pre-packaged version of Plone that includes specific features, themes, modules, and configurations." | ||
"property=og:title": "Plone distributions" | ||
"keywords": "Plone 6, distribution, plone.distribution" | ||
--- | ||
|
||
(plone-distributions-label)= | ||
|
||
# Plone distributions | ||
|
||
```{versionadded} Plone 6.1 | ||
``` | ||
|
||
A Plone {term}`distribution` is a pre-packaged version of Plone that includes specific features, themes, modules, and configurations. | ||
It is a convenient way to get a specific type of website up and running quickly, as the distribution includes everything needed to run that type of site. | ||
|
||
```{seealso} | ||
To create your own distribution, see {doc}`/developer-guide/create-a-distribution`. | ||
``` | ||
|
||
|
||
## Built-in distributions | ||
|
||
Plone comes with two built-in distributions, which correspond to the two Plone user interfaces. | ||
|
||
[`plone.volto`](https://github.com/plone/plone.volto) | ||
: Create a Plone site with the Volto frontend. | ||
|
||
[`plone.classicui`](https://github.com/plone/plone.classicui) | ||
: Create a Plone site with the Classic UI frontend. | ||
davisagli marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
stevepiercy marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
## Third-party distributions | ||
|
||
You can create your own distributions to suit your needs. | ||
|
||
```{seealso} | ||
For a how-to guide, see {doc}`/developer-guide/create-a-distribution`. | ||
``` | ||
|
||
For example, a Plone consulting agency can create a distribution demonstrating its favorite setup for Plone. | ||
This would contain the add-ons that they usually add in each project, including example content. | ||
With this, the agency can create a fully configured Plone site filled with content for a potential client. | ||
|
||
Alternatively, an agency or implementer can create a distribution for specific project. | ||
This could create a site with all add-ons activated and configured for this project, including example content, and optionally users and groups. | ||
During the development phase of a new project, all developers would use this to create a fresh site locally so that everyone has the same configuration and content. | ||
|
||
Custom Plone distributions can be distributions for use by others. | ||
Examples of third-party Plone distributions include: | ||
|
||
- [SENAITE](https://www.senaite.com) | ||
- [Quaive](https://quaive.com/) | ||
- [Portal Modelo](https://www.interlegis.leg.br/produtos-servicos/portal-modelo/) | ||
- [Portal Padrão](https://identidade-digital-de-governo-plone.readthedocs.io/en/latest/) | ||
|
||
|
||
## Related packages | ||
|
||
The implementation of distributions in the Plone codebase is found in the following Python packages. | ||
|
||
- [`plone.distribution`](https://github.com/plone/plone.distribution) provides the framework for defining distributions. | ||
- [`plone.exportimport`](https://github.com/plone/plone.exportimport) imports and exports content, users, and other objects between Plone sites. | ||
`plone.distribution` uses it. | ||
- [`plone.volto`](https://github.com/plone/plone.volto) is the distribution to create a Plone site with the Volto frontend. | ||
- [`plone.classicui`](https://github.com/plone/plone.classicui) is the distribution to create a Plone site with the Classic UI frontend. | ||
|
||
```{note} | ||
For Plone 7, the [Plone roadmap](https://plone.org/why-plone/roadmap) guides development toward a clearer separation between the Classic UI frontend and the core `Products.CMFPlone` backend. | ||
This means that in Plone 7, `Products.CMFPlone` will have less code and pull in fewer dependencies, whereas `plone.classicui` may have more code and pull in more dependencies. | ||
This is the direction in which the backend is heading, and the introduction of the `plone.classicui` distribution package is an important step along this path. | ||
``` | ||
|
||
## Comparison with other CMSs | ||
|
||
Drupal | ||
: Drupal has distributions for blogs, e-commerce sites, and intranet portals. | ||
|
||
WordPress | ||
: WordPress has a similar concept in the form of "WordPress Multisite," which allows users to run multiple websites from a single installation of WordPress. | ||
|
||
Joomla | ||
: Joomla has a similar concept in the form of "Joomla Templates," which are pre-designed templates for Joomla websites. | ||
|
||
TYPO3 | ||
: TYPO3 has a similar concept in the form of "TYPO3 Distributions," which are pre-configured installations of TYPO3 for specific types of websites. |
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
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
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
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.