Skip to content

Commit

Permalink
- s/6/7 where relevant
Browse files Browse the repository at this point in the history
- strip out 6 from "Plone 6", just call it "Plone" where relevant
- Hide all submodules, Classic UI, and backend docs
  • Loading branch information
stevepiercy committed Jan 31, 2025
1 parent 0961c41 commit 6e14147
Show file tree
Hide file tree
Showing 78 changed files with 241 additions and 220 deletions.
2 changes: 1 addition & 1 deletion .readthedocs.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ build:
# If there are no changes (git diff exits with 0) we force the command to return with 183.
# This is a special exit code on Read the Docs that will cancel the build immediately.
- |
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/6.0 -- docs/ .readthedocs.yaml requirements-initial.txt requirements.txt;
if [ "$READTHEDOCS_VERSION_TYPE" = "external" ] && git diff --quiet origin/7 -- docs/ .readthedocs.yaml requirements-initial.txt requirements.txt;
then
exit 183;
fi
Expand Down
11 changes: 9 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,22 @@
[![Testing Status](https://github.com/plone/documentation/actions/workflows/test.yml/badge.svg?branch=6.0 "Testing Status")](https://github.com/plone/documentation/actions/workflows/test.yml)
[![Testing Status](https://github.com/plone/documentation/actions/workflows/test.yml/badge.svg?branch=7 "Testing Status")](https://github.com/plone/documentation/actions/workflows/test.yml)

# Plone Documentation

This is the repository for Plone Documentation.


## Plone 7

Browse the Plone 7 Documentation at https://7.docs.plone.org/.

Active development on the Plone 7 Documentation takes place on the branch [`7`](https://github.com/plone/documentation/tree/7).


## Plone 6

Browse the Plone 6 Documentation at https://6.docs.plone.org/.

Active development on the Plone 6 Documentation takes place on the branch [`6.0`](https://github.com/plone/documentation/tree/6.0).
Development on the Plone 6 Documentation takes place on the branch [`6.0`](https://github.com/plone/documentation/tree/6.0).


## Plone 5.2
Expand Down
7 changes: 6 additions & 1 deletion docs/_static/switcher.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,11 @@
[
{
"name": "6 (stable)",
"name": "7 (stable)",
"version": "7",
"url": "https://7.docs.plone.org/"
},
{
"name": "6",
"version": "6",
"url": "https://6.docs.plone.org/"
},
Expand Down
4 changes: 2 additions & 2 deletions docs/_templates/404.html
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
{% block body %}
<div>
<h1>Page not found</h1>
<p>We could not find the page you requested in Plone 6 documentation.</p>
<p>You can <a href="/search.html">search</a> Plone 6 documentation.</p>
<p>We could not find the page you requested in Plone 7 documentation.</p>
<p>You can <a href="/search.html">search</a> Plone 7 documentation.</p>
<p>Previous versions of Plone documentation:</p>
<ul>
<li><a href="https://5.docs.plone.org/">Plone 5</a></li>
Expand Down
2 changes: 1 addition & 1 deletion docs/admin-guide/add-ons.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ myst:
"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"
"keywords": "Plone, add-on, package, plugin, extension, install"
---

(install-plone-add-ons-label)=
Expand Down
2 changes: 1 addition & 1 deletion docs/admin-guide/add-site.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ myst:
"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"
"keywords": "Plone, create, add, factory, distributions"
---

(add-a-plone-site-label)=
Expand Down
2 changes: 1 addition & 1 deletion docs/admin-guide/configure-zope.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ myst:
"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"
"keywords": "Plone, Zope, instance, app server, config, Cookieplone, Buildout, pip, cookiecutter-plone-starter, cookiecutter-zope-instance, plone.recipe.zope2instance"
---

(configure-zope-label)=
Expand Down
2 changes: 1 addition & 1 deletion docs/admin-guide/export-import.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ myst:
"description": "Export and import Plone site data with plone.exportimport"
"property=og:description": "Export and import Plone site data with plone.exportimport"
"property=og:title": "Export and import Plone site data with plone.exportimport"
"keywords": "Plone 6, plone.exportimport, export, import, site, data, Content, Principals, Relations, Translations, Discussions, Redirects"
"keywords": "Plone, plone.exportimport, export, import, site, data, Content, Principals, Relations, Translations, Discussions, Redirects"
---

(exportimport)=
Expand Down
6 changes: 3 additions & 3 deletions docs/admin-guide/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
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"
"description": "How to install, operate, configure, and deploy Plone"
"property=og:description": "How to install, operate, configure, and deploy Plone"
"property=og:title": "Admin guide"
"keywords": "Plone 6, admin, install, configuration, deploy"
"keywords": "Plone, admin, install, configuration, deploy"
---

(admin-index-label)=
Expand Down
2 changes: 1 addition & 1 deletion docs/admin-guide/install-buildout.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ myst:
"description": "Install Plone with Buildout"
"property=og:description": "Install Plone with Buildout"
"property=og:title": "Install Plone with Buildout"
"keywords": "Plone 6, install, Classic UI, Buildout"
"keywords": "Plone, install, Classic UI, Buildout"
---

(install-buildout-label)=
Expand Down
2 changes: 1 addition & 1 deletion docs/admin-guide/install-pip.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ myst:
"description": "Install Plone with pip"
"property=og:description": "Install Plone with pip"
"property=og:title": "Install Plone with pip"
"keywords": "Plone 6, install, Classic UI, pip"
"keywords": "Plone, install, Classic UI, pip"
---

(install-pip-label)=
Expand Down
2 changes: 1 addition & 1 deletion docs/admin-guide/override-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ myst:
"description": "Override core Plone packages"
"property=og:description": "Override core Plone packages"
"property=og:title": "Override core Plone packages"
"keywords": "Plone 6, core, package, version, override, Cookieplone, cookiecutter-plone-starter, Buildout"
"keywords": "Plone, core, package, version, override, Cookieplone, cookiecutter-plone-starter, Buildout"
---

(override-core-plone-packages-label)=
Expand Down
2 changes: 1 addition & 1 deletion docs/admin-guide/run-plone.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ myst:
"description": "Run Plone"
"property=og:description": "Run Plone"
"property=og:title": "Run Plone"
"keywords": "Plone 6, run, start, command, Cookieplone, Buildout, pip, cookiecutter-plone-starter"
"keywords": "Plone, run, start, command, Cookieplone, Buildout, pip, cookiecutter-plone-starter"
---

(run-plone-label)=
Expand Down
8 changes: 4 additions & 4 deletions docs/backend/configuration-registry.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
myst:
html_meta:
"description": "Configuration Registry in Plone 6"
"property=og:description": "Configuration Registry in Plone 6"
"property=og:title": "Configuration Registry in Plone 6"
"keywords": "Plone 6, Configuration Registry, backend, plone.registry, plone.app.registry, GenericSetup"
"description": "Configuration Registry in Plone"
"property=og:description": "Configuration Registry in Plone"
"property=og:title": "Configuration Registry in Plone"
"keywords": "Plone, Configuration Registry, backend, plone.registry, plone.app.registry, GenericSetup"
---

(backend-configuration-registry-label)=
Expand Down
8 changes: 4 additions & 4 deletions docs/backend/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
myst:
html_meta:
"description": "Plone 6 Backend"
"property=og:description": "Plone 6 Backend"
"property=og:title": "Plone 6 Backend"
"keywords": "Plone 6, Classic UI, frontend, backend, plone.restapi, plone.api"
"description": "Plone Backend"
"property=og:description": "Plone Backend"
"property=og:title": "Plone Backend"
"keywords": "Plone, Classic UI, frontend, backend, plone.restapi, plone.api"
---

(backend-index-label)=
Expand Down
6 changes: 3 additions & 3 deletions docs/backend/relations.md
Original file line number Diff line number Diff line change
Expand Up @@ -97,7 +97,7 @@ directives.widget(
### Configure the relations widget

```{note}
These settings only have an effect in Plone 6 Classic UI.
These settings only have an effect in Plone Classic UI.
```

`RelatedItemsFieldWidget` is the Python class of the default widget used by relation fields.
Expand Down Expand Up @@ -161,7 +161,7 @@ directives.widget(
### Using the search mode of the relations widget

```{note}
These settings only have an effect in Plone 6 Classic UI.
These settings only have an effect in Plone Classic UI.
```

So far we only used the vocabulary `plone.app.vocabularies.Catalog`, which returns the full content tree.
Expand Down Expand Up @@ -447,7 +447,7 @@ This returns the related items so that you will be able to render them any way y

## Inspecting relations

In Plone 6 Classic UI, you can inspect all relations and back relations in your site using the control panel {guilabel}`Relations` at the browser path `/@@inspect-relations`.
In Plone Classic UI, you can inspect all relations and back relations in your site using the control panel {guilabel}`Relations` at the browser path `/@@inspect-relations`.

```{figure} /_static/inspect-relations.png
:alt: The Relations controlpanel
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ myst:
"description": "Migrating from Plone Classic UI to Volto"
"property=og:description": "Migrating from Plone Classic UI to Volto"
"property=og:title": "Migrating from Plone Classic UI to Volto"
"keywords": "Migrating, Upgrading, Plone 6, Volto, Classic UI"
"keywords": "Migrating, Upgrading, Plone, Volto, Classic UI"
---

(backend-migrate-to-volto-label)=
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ myst:
"description": "Upgrading to Plone 6.0"
"property=og:description": "Upgrading to Plone 6.0"
"property=og:title": "Upgrading to Plone 6.0"
"keywords": "Upgrading, Plone 6"
"keywords": "Upgrading, Plone"
---

(backend-upgrade-plone-v60-label)=
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ myst:
"description": "How to upgrade to Plone 6.1"
"property=og:description": "How to upgrade to Plone 6.1"
"property=og:title": "How to upgrade to Plone 6.1"
"keywords": "Upgrade, Plone 6"
"keywords": "Upgrade, Plone"
---

(backend-upgrade-plone-v61-label)=
Expand Down
4 changes: 2 additions & 2 deletions docs/classic-ui/icons.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ myst:

# Icons

This sections describes how to work with icons in Plone 6 Classic UI.
This sections describes how to work with icons in Plone Classic UI.
Examples include the following.

- Bootstrap icons
Expand All @@ -23,7 +23,7 @@ Examples include the following.

## Bootstrap Icons

Bootstrap 5 is the default CSS framework in Plone 6.
Bootstrap 5 is the default CSS framework in Plone Classic UI.
Plone uses its icons.
Check out all the available Bootstrap icons at [icons.getbootstrap.com](https://icons.getbootstrap.com/).

Expand Down
2 changes: 1 addition & 1 deletion docs/classic-ui/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ myst:
"description": "Classic UI is a secondary user interface for Plone, but updated to use Bootstrap 5. It is familiar to users of Plone 5."
"property=og:description": "Classic UI is a secondary user interface for Plone, but updated to use Bootstrap 5. It is familiar to users of Plone 5."
"property=og:title": "Classic UI"
"keywords": "Plone 6, Classic UI, Bootstrap 5"
"keywords": "Plone, Classic UI, Bootstrap 5"
---

(classic-ui-index-label)=
Expand Down
2 changes: 1 addition & 1 deletion docs/classic-ui/layers.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ myst:
html_meta:
"description": "Layers allow you to enable and disable views and other site functionality based on installed add-ons and themes."
"property=og:description": "Layers allow you to enable and disable views and other site functionality based on installed add-ons and themes."
"property=og:title": "Layers in Plone 6"
"property=og:title": "Layers in Plone"
"keywords": "layer, layers, browser layer, views, viewlets, portlets"
---

Expand Down
2 changes: 1 addition & 1 deletion docs/classic-ui/mockup.md
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,6 @@ Alternatively you can implement it in your own templates by adding the CSS class
- [`bobtemplates.plone` repository](https://github.com/plone/bobtemplates.plone)
- [`mr.bob` repository](https://github.com/collective/mr.bob)
- [Plone CLI (`plonecli`) repository](https://github.com/plone/plonecli)
- {ref}`v60-mockup-resource-registry-label` in Plone 6.0
- {ref}`v60-mockup-resource-registry-label` in Plone 6
- [Mockup repository on GitHub](https://github.com/plone/mockup)
- [Patternslib](https://patternslib.com/)
2 changes: 1 addition & 1 deletion docs/classic-ui/recipes.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ myst:

# Recipes

This chapter provides several recipes to working with the Classic UI in Plone 6.
This chapter provides several recipes to working with the Classic UI in Plone.


(classic-ui-recipes-add-custom-classes-to-body-label)=
Expand Down
12 changes: 6 additions & 6 deletions docs/classic-ui/static-resources.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
---
myst:
html_meta:
"description": "Static resources in Plone 6"
"property=og:description": "Static resources in Plone 6"
"property=og:title": "Static resources in Plone 6"
"description": "Static resources in Plone"
"property=og:description": "Static resources in Plone"
"property=og:title": "Static resources in Plone"
"keywords": "Plone, static, resources, JavaScript, CSS"
---

Expand All @@ -27,10 +27,10 @@ For some additional implementation information, see {ref}`classic-ui-theming-fro

## Registering JavaScript and CSS

To register a static resource in Plone 6, we need to use the `plone.base.interfaces.resources.IBundleRegistry` interface.
To register a static resource in Plone, we need to use the `plone.base.interfaces.resources.IBundleRegistry` interface.

The following example registers a JavaScript resource in `browser/profiles/default/registry` of your Plone 6 project.
The JavaScript files have to be in the `browser/static` folder of your Plone 6 project.
The following example registers a JavaScript resource in `browser/profiles/default/registry` of your Plone project.
The JavaScript files have to be in the `browser/static` folder of your Plone project.

```xml
<registry>
Expand Down
10 changes: 5 additions & 5 deletions docs/classic-ui/theming/color-mode.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ myst:
# Color modes

Bootstrap 5.3 has introduced [color modes](https://getbootstrap.com/docs/5.3/customize/color-modes/).
This chapter is a guide for how to implement color modes in Plone 6.
This chapter is a guide for how to implement color modes in Plone.

```{versionadded} Plone 6.0.6
```
Expand All @@ -24,8 +24,8 @@ This chapter is a guide for how to implement color modes in Plone 6.
## Preferred color modes

You will need to add some JavaScript functionality to set the Bootstrap theme to the user's preferred color scheme.
Add the JavaScript file to the `browser/static` folder of your Plone 6 project.
Register it in the `browser/profiles/default/registry` of your Plone 6 project.
Add the JavaScript file to the `browser/static` folder of your Plone project.
Register it in the `browser/profiles/default/registry` of your Plone project.
See {ref}`classic-ui-static-resources-registering-label` for more information.

```js
Expand Down Expand Up @@ -75,8 +75,8 @@ If you want to add a theme toggler to your site, you can use the following examp
You will need to add some JavaScript functionality to the toggler.
The following code snippet is based on the [Bootstrap 5.3 documentation](https://getbootstrap.com/docs/5.3/customize/color-modes/#javascript).

Add the JavaScript file to the `browser/static` folder of your Plone 6 project.
Register it in the `browser/profiles/default/registry` of your Plone 6 project.
Add the JavaScript file to the `browser/static` folder of your Plone project.
Register it in the `browser/profiles/default/registry` of your Plone project.
See {ref}`classic-ui-static-resources-registering-label` for more information.

```js
Expand Down
4 changes: 2 additions & 2 deletions docs/classic-ui/theming/from-scratch.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ See https://github.com/plone/documentation/issues/1645

Theming based on a filesystem package without any dependency.

- Theming for Plone 6 Classic UI
- Theming for Plone Classic UI
- Theme stored in a filesystem package
- Built from scratch
- No dependencies to Barceloneta
Expand Down Expand Up @@ -66,7 +66,7 @@ Directory: `src/plonetheme/munich/browser/static`
```ini
[theme]
title = Munich Theme
description = A modernized Plone 6 theme
description = A modernized Plone theme
preview = preview.png
rules =
prefix = /++theme++plonetheme.munich
Expand Down
8 changes: 4 additions & 4 deletions docs/classic-ui/theming/index.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
myst:
html_meta:
"description": "Theming of Plone 6 Classic UI"
"property=og:description": "Theming of Plone 6 Classic UI"
"property=og:title": "Theming of Plone 6 Classic UI"
"keywords": "Theming, Plone 6, Classic UI, Barceloneta, Diazo, scratch, through-the-web"
"description": "Theming of Plone Classic UI"
"property=og:description": "Theming of Plone Classic UI"
"property=og:title": "Theming of Plone Classic UI"
"keywords": "Theming, Plone, Classic UI, Barceloneta, Diazo, scratch, through-the-web"
---

(classic-ui-theming-index-label)=
Expand Down
10 changes: 5 additions & 5 deletions docs/classic-ui/theming/through-the-web.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
---
myst:
html_meta:
"description": "Through-the-web (TTW) theme customization in Plone 6 Classic UI"
"property=og:description": "Through-the-web (TTW) theme customization in Plone 6 Classic UI"
"property=og:title": "Through-the-web (TTW) theme customization in Plone 6 Classic UI"
"keywords": "Plone 6, Classic UI, Through-the-web, TTW, theme, customization"
"description": "Through-the-web (TTW) theme customization in Plone Classic UI"
"property=og:description": "Through-the-web (TTW) theme customization in Plone Classic UI"
"property=og:title": "Through-the-web (TTW) theme customization in Plone Classic UI"
"keywords": "Plone, Classic UI, Through-the-web, TTW, theme, customization"
---

(classic-ui-through-the-web-label)=
Expand All @@ -17,7 +17,7 @@ See https://github.com/plone/documentation/issues/1645
```

TTW customization is useful when you need to make small CSS changes.
Theme changes can be made via control panels or by updating Plone 6 Classic UI's `custom.css`.
Theme changes can be made via control panels or by updating Plone Classic UI's `custom.css`.
Other theming methods should be used for larger customizations or entire website designs.


Expand Down
Loading

0 comments on commit 6e14147

Please sign in to comment.