From ef0354f581c32fe30beb4f381c6d291db8ec1ff2 Mon Sep 17 00:00:00 2001 From: Manik Khajuria Date: Tue, 2 Dec 2025 11:06:48 +0530 Subject: [PATCH 01/12] docs: Add 'Related content' as the final section in most pages (#1973) --- docs/_inc/_continuous-integration.md | 3 +++ docs/_inc/_create-classic-ui-instance.md | 6 ++++++ docs/_inc/_install-python-plone61.md | 5 +++++ docs/admin-guide/add-site.md | 6 ++++++ docs/admin-guide/backup-restore-plone-buildout.md | 8 +++++++- docs/admin-guide/export-import.md | 5 +++++ docs/admin-guide/install-buildout.md | 7 +++++++ docs/admin-guide/install-pip.md | 6 ++++++ docs/backend/behaviors.md | 6 ++++++ docs/backend/content-types/creating-content-types.md | 8 ++++++++ docs/backend/fields.md | 7 +++++++ docs/backend/relations.md | 7 +++++++ docs/backend/schemas.md | 7 +++++++ docs/backend/vocabularies.md | 8 +++++++- docs/backend/widgets.md | 7 +++++++ 15 files changed, 94 insertions(+), 2 deletions(-) diff --git a/docs/_inc/_continuous-integration.md b/docs/_inc/_continuous-integration.md index 4b29642242..aaa39ccf52 100644 --- a/docs/_inc/_continuous-integration.md +++ b/docs/_inc/_continuous-integration.md @@ -5,3 +5,6 @@ All of a project's CI jobs must pass before a contribution may be accepted. ```{seealso} {doc}`/contributing/core/continuous-integration` ``` + + + diff --git a/docs/_inc/_create-classic-ui-instance.md b/docs/_inc/_create-classic-ui-instance.md index 2c768d90e3..6b592f56da 100644 --- a/docs/_inc/_create-classic-ui-instance.md +++ b/docs/_inc/_create-classic-ui-instance.md @@ -13,3 +13,9 @@ You will be redirected to your new Classic UI Plone site. To stop the Plone instance in foreground mode, type {kbd}`ctrl-c`. +## Related content + +- {doc}`Classic UI ` + + + diff --git a/docs/_inc/_install-python-plone61.md b/docs/_inc/_install-python-plone61.md index b819d58578..9ddfa9fa83 100644 --- a/docs/_inc/_install-python-plone61.md +++ b/docs/_inc/_install-python-plone61.md @@ -7,3 +7,8 @@ The instructions below will create one. ``` Plone 6.1 requires Python version {{SUPPORTED_PYTHON_VERSIONS_PLONE61}}. + +## Related content + +- {doc}`Plone installation requirements ` + diff --git a/docs/admin-guide/add-site.md b/docs/admin-guide/add-site.md index 0fd93872de..4f3017b7df 100644 --- a/docs/admin-guide/add-site.md +++ b/docs/admin-guide/add-site.md @@ -71,3 +71,9 @@ 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. ``` + +## Related Content + +- {doc}`/install/create-project-cookieplone` — Create a new Plone project using Cookiecutter. +- {doc}`/admin-guide/install-buildout` — Install Plone using Buildout. +- {doc}`/admin-guide/install-pip` — Install Plone using pip. diff --git a/docs/admin-guide/backup-restore-plone-buildout.md b/docs/admin-guide/backup-restore-plone-buildout.md index aa204b3ef8..13ab933e0d 100644 --- a/docs/admin-guide/backup-restore-plone-buildout.md +++ b/docs/admin-guide/backup-restore-plone-buildout.md @@ -92,4 +92,10 @@ Tune these to meet your needs. When you enable incremental backups, the database packing operation will automatically cause the next backup to be a full backup. If your backup continuity need is critical, then your incremental backup schedule may need to be frequent. -Some Plone sites require incremental backups every few minutes. \ No newline at end of file +Some Plone sites require incremental backups every few minutes. + +## Related content + +- {doc}`/admin-guide/export-import` — Export and import content +- {doc}`/admin-guide/install-buildout` — Install Plone using Buildout +- {doc}`/admin-guide/install-pip` — Install Plone using pip diff --git a/docs/admin-guide/export-import.md b/docs/admin-guide/export-import.md index 76132a1847..cd0540f072 100644 --- a/docs/admin-guide/export-import.md +++ b/docs/admin-guide/export-import.md @@ -111,3 +111,8 @@ Consider a File content item with UID `3e0dd7c4b2714eafa1d6fc6a1493f953` and a P | --- | --- | | `content/3e0dd7c4b2714eafa1d6fc6a1493f953/data.json` | JSON File with serialized representation of a content item | | `content/3e0dd7c4b2714eafa1d6fc6a1493f953/file/plone.pdf` | Blob file stored in the `file` field in the content item | + +## Related content + +- {doc}`/admin-guide/backup-restore-plone-buildout` — Back up and restore Plone sites +- {doc}`/admin-guide/add-site` — Add a Plone site to an existing instance diff --git a/docs/admin-guide/install-buildout.md b/docs/admin-guide/install-buildout.md index da4dfc386c..894b9b771b 100644 --- a/docs/admin-guide/install-buildout.md +++ b/docs/admin-guide/install-buildout.md @@ -126,3 +126,10 @@ Stop the instance. ```shell bin/instance stop ``` + +## Related content + +- {doc}`/admin-guide/add-site` — Add a Plone site after installation +- {doc}`/admin-guide/install-pip` — Alternative installation method using pip +- {doc}`/admin-guide/backup-restore-plone-buildout` — Back up and restore your Plone site +- {doc}`/conceptual-guides/compare-buildout-pip` — Compare Buildout and pip installation methods diff --git a/docs/admin-guide/install-pip.md b/docs/admin-guide/install-pip.md index 0cd7bc7aef..e0b17e380e 100644 --- a/docs/admin-guide/install-pip.md +++ b/docs/admin-guide/install-pip.md @@ -97,3 +97,9 @@ bin/runwsgi -v instance/etc/zope.ini ```{include} /_inc/_create-classic-ui-instance.md ``` + +## Related content + +- {doc}`/admin-guide/add-site` — Add a Plone site after installation +- {doc}`/admin-guide/install-buildout` — Alternative installation method using Buildout +- {doc}`/conceptual-guides/compare-buildout-pip` — Compare Buildout and pip installation methods diff --git a/docs/backend/behaviors.md b/docs/backend/behaviors.md index 3cb7271c28..f939e46ec9 100644 --- a/docs/backend/behaviors.md +++ b/docs/backend/behaviors.md @@ -378,3 +378,9 @@ The [README file of `plone.behavior`](https://github.com/plone/plone.behavior/bl Plone content objects have logic to look up the behaviors' names registered from their types' configuration, the {term}`Factory Type Information` (FTI). At runtime, the logic provides the interface (or marker) from the behavior to the object. This dynamically provided interface enables the component architecture to react to this new interface by adding additional form fields, bindings events, enabling more specific views, and more. + +## Related content + +- {doc}`/backend/content-types/index` — Add behaviors to content types +- {doc}`/backend/schemas` — Define schemas for behaviors +- {doc}`/backend/fields` — Field types used in behavior schemas diff --git a/docs/backend/content-types/creating-content-types.md b/docs/backend/content-types/creating-content-types.md index 29781858ef..c9b67b653c 100644 --- a/docs/backend/content-types/creating-content-types.md +++ b/docs/backend/content-types/creating-content-types.md @@ -118,3 +118,11 @@ For now your content type doesn't have any custom schema with fields defined. See {doc}`/backend/schemas`, {doc}`/backend/fields` and {doc}`/backend/widgets` for information on how to add custom fields and widgets to your content type. Also have a look at Plone {doc}`/backend/behaviors`, which provide default features you can enable per content type. + +## Related content + +- {doc}`/backend/schemas` — Define schemas for your content types +- {doc}`/backend/fields` — Field types for content type schemas +- {doc}`/backend/widgets` — Customize form widgets +- {doc}`/backend/behaviors` — Add reusable behaviors to content types +- {doc}`/backend/content-types/fti` — Configure Factory Type Information diff --git a/docs/backend/fields.md b/docs/backend/fields.md index a7d261ad35..13235ce1d6 100644 --- a/docs/backend/fields.md +++ b/docs/backend/fields.md @@ -363,3 +363,10 @@ In supermodel XML, the directives are `security:read-permission` and Secret ``` + +## Related content + +- {doc}`/backend/schemas` — How fields compose schemas +- {doc}`/backend/content-types/index` — Use fields in content type schemas +- {doc}`/backend/vocabularies` — Define vocabularies for Choice fields +- {doc}`/backend/relations` — Relation fields for linking content diff --git a/docs/backend/relations.md b/docs/backend/relations.md index dc1cf66434..b7ab5bd898 100644 --- a/docs/backend/relations.md +++ b/docs/backend/relations.md @@ -643,3 +643,10 @@ Thus the API for getting the target uses: In addition, the relation value knows under which attribute it has been stored as `from_attribute`. It is usually the name of the field with which the relation is created. But it can also be the name of a relation that is created by code, for example, through link integrity relations (`isReferencing`) or the relation between a working copy and the original (`iterate-working-copy`). + +## Related content + +- {doc}`/backend/schemas` — Define schemas for content types and forms +- {doc}`/backend/fields` — Field types including `RelationChoice` and `RelationList` +- {doc}`/backend/content-types/index` — Create custom content types with relations +- {doc}`/backend/vocabularies` — Control which items can be related using vocabularies diff --git a/docs/backend/schemas.md b/docs/backend/schemas.md index 24bc654a10..00ec171c48 100644 --- a/docs/backend/schemas.md +++ b/docs/backend/schemas.md @@ -729,4 +729,11 @@ def fields(self): f.field = schema_field ``` +## Related content + +- {doc}`/backend/fields` — Field types used in schemas +- {doc}`/backend/content-types/index` — Use schemas to define content types +- {doc}`/classic-ui/forms` — Use schemas to create forms +- {doc}`/backend/vocabularies` — Define vocabularies for Choice fields + diff --git a/docs/backend/vocabularies.md b/docs/backend/vocabularies.md index e4bc50cc22..ca27c2a6b0 100644 --- a/docs/backend/vocabularies.md +++ b/docs/backend/vocabularies.md @@ -18,4 +18,10 @@ See the chapter {ref}`training:vocabularies-label` from the Mastering Plone 6 Tr ```{todo} Contribute to this documentation! See issue [Backend > Vocabularies needs content](https://github.com/plone/documentation/issues/1306). -``` \ No newline at end of file +``` + +## Related content + +- {doc}`/backend/fields` — Use vocabularies with Choice fields +- {doc}`/backend/schemas` — Define schemas with Choice fields +- {doc}`/backend/content-types/index` — Use vocabularies in content type schemas \ No newline at end of file diff --git a/docs/backend/widgets.md b/docs/backend/widgets.md index e4ad686fe2..bf863493fd 100644 --- a/docs/backend/widgets.md +++ b/docs/backend/widgets.md @@ -783,3 +783,10 @@ The code renders both widgets, {guilabel}`min` and {guilabel}`max`, in a single ``` + +## Related content + +- {doc}`/backend/fields` — Field types that use widgets +- {doc}`/backend/schemas` — Define schemas with widget directives +- {doc}`/classic-ui/forms` — Use widgets in forms +- {doc}`/backend/content-types/index` — Customize widgets for content types From 59a411b3cb309c20b01c19ed6f77c8512ae237c3 Mon Sep 17 00:00:00 2001 From: Manik Khajuria Date: Tue, 2 Dec 2025 11:38:31 +0530 Subject: [PATCH 02/12] Updated file: deleted unnecessary lines --- docs/_inc/_continuous-integration.md | 5 +---- docs/_inc/_create-classic-ui-instance.md | 5 +---- docs/_inc/_install-python-plone61.md | 3 +-- docs/admin-guide/backup-restore-plone-buildout.md | 2 +- 4 files changed, 4 insertions(+), 11 deletions(-) diff --git a/docs/_inc/_continuous-integration.md b/docs/_inc/_continuous-integration.md index aaa39ccf52..ef9ceccf2c 100644 --- a/docs/_inc/_continuous-integration.md +++ b/docs/_inc/_continuous-integration.md @@ -4,7 +4,4 @@ All of a project's CI jobs must pass before a contribution may be accepted. ```{seealso} {doc}`/contributing/core/continuous-integration` -``` - - - +``` \ No newline at end of file diff --git a/docs/_inc/_create-classic-ui-instance.md b/docs/_inc/_create-classic-ui-instance.md index 6b592f56da..51929147fc 100644 --- a/docs/_inc/_create-classic-ui-instance.md +++ b/docs/_inc/_create-classic-ui-instance.md @@ -15,7 +15,4 @@ To stop the Plone instance in foreground mode, type {kbd}`ctrl-c`. ## Related content -- {doc}`Classic UI ` - - - +- {doc}`Classic UI ` \ No newline at end of file diff --git a/docs/_inc/_install-python-plone61.md b/docs/_inc/_install-python-plone61.md index 9ddfa9fa83..0e18d5ec9e 100644 --- a/docs/_inc/_install-python-plone61.md +++ b/docs/_inc/_install-python-plone61.md @@ -10,5 +10,4 @@ Plone 6.1 requires Python version {{SUPPORTED_PYTHON_VERSIONS_PLONE61}}. ## Related content -- {doc}`Plone installation requirements ` - +- {doc}`Plone installation requirements ` \ No newline at end of file diff --git a/docs/admin-guide/backup-restore-plone-buildout.md b/docs/admin-guide/backup-restore-plone-buildout.md index 13ab933e0d..d3023ed20d 100644 --- a/docs/admin-guide/backup-restore-plone-buildout.md +++ b/docs/admin-guide/backup-restore-plone-buildout.md @@ -98,4 +98,4 @@ Some Plone sites require incremental backups every few minutes. - {doc}`/admin-guide/export-import` — Export and import content - {doc}`/admin-guide/install-buildout` — Install Plone using Buildout -- {doc}`/admin-guide/install-pip` — Install Plone using pip +- {doc}`/admin-guide/install-pip` — Install Plone using pip \ No newline at end of file From 90286569949e14ec7f53e94f48ca9a600e0433d8 Mon Sep 17 00:00:00 2001 From: Manik Khajuria Date: Tue, 2 Dec 2025 18:37:21 +0530 Subject: [PATCH 03/12] Updating pull request --- docs/_inc/_create-classic-ui-instance.md | 2 +- docs/_inc/_install-python-plone61.md | 2 +- docs/admin-guide/add-site.md | 8 ++++---- docs/admin-guide/backup-restore-plone-buildout.md | 6 +++--- docs/admin-guide/export-import.md | 4 ++-- docs/admin-guide/install-buildout.md | 8 ++++---- docs/admin-guide/install-pip.md | 6 +++--- docs/backend/behaviors.md | 6 +++--- docs/backend/content-types/creating-content-types.md | 10 +++++----- docs/backend/content-types/index.md | 2 ++ docs/backend/fields.md | 10 ++++++---- docs/backend/relations.md | 8 ++++---- docs/backend/schemas.md | 10 ++++++---- docs/backend/vocabularies.md | 6 +++--- docs/backend/widgets.md | 8 ++++---- docs/conceptual-guides/compare-buildout-pip.md | 2 ++ 16 files changed, 53 insertions(+), 45 deletions(-) diff --git a/docs/_inc/_create-classic-ui-instance.md b/docs/_inc/_create-classic-ui-instance.md index 51929147fc..c3c31484ee 100644 --- a/docs/_inc/_create-classic-ui-instance.md +++ b/docs/_inc/_create-classic-ui-instance.md @@ -15,4 +15,4 @@ To stop the Plone instance in foreground mode, type {kbd}`ctrl-c`. ## Related content -- {doc}`Classic UI ` \ No newline at end of file +- {ref}`Classic UI ` \ No newline at end of file diff --git a/docs/_inc/_install-python-plone61.md b/docs/_inc/_install-python-plone61.md index 0e18d5ec9e..8cca8c0ba5 100644 --- a/docs/_inc/_install-python-plone61.md +++ b/docs/_inc/_install-python-plone61.md @@ -10,4 +10,4 @@ Plone 6.1 requires Python version {{SUPPORTED_PYTHON_VERSIONS_PLONE61}}. ## Related content -- {doc}`Plone installation requirements ` \ No newline at end of file +- {ref}`Plone installation requirements ` \ No newline at end of file diff --git a/docs/admin-guide/add-site.md b/docs/admin-guide/add-site.md index 4f3017b7df..0cfb15ce75 100644 --- a/docs/admin-guide/add-site.md +++ b/docs/admin-guide/add-site.md @@ -72,8 +72,8 @@ Regardless of the frontend you select, you will be redirected to the backend's u 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. ``` -## Related Content +## Related content -- {doc}`/install/create-project-cookieplone` — Create a new Plone project using Cookiecutter. -- {doc}`/admin-guide/install-buildout` — Install Plone using Buildout. -- {doc}`/admin-guide/install-pip` — Install Plone using pip. +- {ref}`Install Plone with Cookieplone ` +- {ref}`Install Plone with Buildout ` +- {ref}`Install Plone with pip ` diff --git a/docs/admin-guide/backup-restore-plone-buildout.md b/docs/admin-guide/backup-restore-plone-buildout.md index d3023ed20d..ff8acc51d9 100644 --- a/docs/admin-guide/backup-restore-plone-buildout.md +++ b/docs/admin-guide/backup-restore-plone-buildout.md @@ -96,6 +96,6 @@ Some Plone sites require incremental backups every few minutes. ## Related content -- {doc}`/admin-guide/export-import` — Export and import content -- {doc}`/admin-guide/install-buildout` — Install Plone using Buildout -- {doc}`/admin-guide/install-pip` — Install Plone using pip \ No newline at end of file +- {ref}`Export and import site data ` +- {ref}`Install Plone with Buildout ` +- {ref}`Install Plone with pip ` \ No newline at end of file diff --git a/docs/admin-guide/export-import.md b/docs/admin-guide/export-import.md index cd0540f072..e319c1a0e8 100644 --- a/docs/admin-guide/export-import.md +++ b/docs/admin-guide/export-import.md @@ -114,5 +114,5 @@ Consider a File content item with UID `3e0dd7c4b2714eafa1d6fc6a1493f953` and a P ## Related content -- {doc}`/admin-guide/backup-restore-plone-buildout` — Back up and restore Plone sites -- {doc}`/admin-guide/add-site` — Add a Plone site to an existing instance +- {ref}`Back up and restore a Plone buildout ` +- {ref}`Add a Plone site ` diff --git a/docs/admin-guide/install-buildout.md b/docs/admin-guide/install-buildout.md index 894b9b771b..a51dd29edd 100644 --- a/docs/admin-guide/install-buildout.md +++ b/docs/admin-guide/install-buildout.md @@ -129,7 +129,7 @@ bin/instance stop ## Related content -- {doc}`/admin-guide/add-site` — Add a Plone site after installation -- {doc}`/admin-guide/install-pip` — Alternative installation method using pip -- {doc}`/admin-guide/backup-restore-plone-buildout` — Back up and restore your Plone site -- {doc}`/conceptual-guides/compare-buildout-pip` — Compare Buildout and pip installation methods +- {ref}`Add a Plone site ` +- {ref}`Install Plone with pip ` +- {ref}`Back up and restore a Plone buildout ` +- {ref}`Compare Buildout and pip ` diff --git a/docs/admin-guide/install-pip.md b/docs/admin-guide/install-pip.md index e0b17e380e..820b73b155 100644 --- a/docs/admin-guide/install-pip.md +++ b/docs/admin-guide/install-pip.md @@ -100,6 +100,6 @@ bin/runwsgi -v instance/etc/zope.ini ## Related content -- {doc}`/admin-guide/add-site` — Add a Plone site after installation -- {doc}`/admin-guide/install-buildout` — Alternative installation method using Buildout -- {doc}`/conceptual-guides/compare-buildout-pip` — Compare Buildout and pip installation methods +- {ref}`Add a Plone site ` +- {ref}`Install Plone with Buildout ` +- {ref}`Compare Buildout and pip ` diff --git a/docs/backend/behaviors.md b/docs/backend/behaviors.md index f939e46ec9..e81f391c1f 100644 --- a/docs/backend/behaviors.md +++ b/docs/backend/behaviors.md @@ -381,6 +381,6 @@ This dynamically provided interface enables the component architecture to react ## Related content -- {doc}`/backend/content-types/index` — Add behaviors to content types -- {doc}`/backend/schemas` — Define schemas for behaviors -- {doc}`/backend/fields` — Field types used in behavior schemas +- {ref}`Content types ` +- {ref}`Schemas ` +- {ref}`Fields ` diff --git a/docs/backend/content-types/creating-content-types.md b/docs/backend/content-types/creating-content-types.md index c9b67b653c..a7ae56618f 100644 --- a/docs/backend/content-types/creating-content-types.md +++ b/docs/backend/content-types/creating-content-types.md @@ -121,8 +121,8 @@ Also have a look at Plone {doc}`/backend/behaviors`, which provide default featu ## Related content -- {doc}`/backend/schemas` — Define schemas for your content types -- {doc}`/backend/fields` — Field types for content type schemas -- {doc}`/backend/widgets` — Customize form widgets -- {doc}`/backend/behaviors` — Add reusable behaviors to content types -- {doc}`/backend/content-types/fti` — Configure Factory Type Information +- {ref}`Schemas ` +- {ref}`Fields ` +- {ref}`Widgets ` +- {ref}`Behaviors ` +- {ref}`Factory Type Information ` diff --git a/docs/backend/content-types/index.md b/docs/backend/content-types/index.md index 165fbfec9e..676bccf8d4 100644 --- a/docs/backend/content-types/index.md +++ b/docs/backend/content-types/index.md @@ -7,6 +7,8 @@ myst: "keywords": "Content types, Dexterity, Plone" --- +(backend-content-types-index-label)= + # Content Types This part of the documentation describes how to develop content types in Plone. diff --git a/docs/backend/fields.md b/docs/backend/fields.md index 13235ce1d6..2ba12ba188 100644 --- a/docs/backend/fields.md +++ b/docs/backend/fields.md @@ -123,6 +123,8 @@ img_obj = api.content.create( +(backend-fields-relation-fields-label)= + ### Fields in `z3c.relationfield.schema` See [`z3c.relationfield`](https://pypi.org/project/z3c.relationfield/) for more details. @@ -366,7 +368,7 @@ In supermodel XML, the directives are `security:read-permission` and ## Related content -- {doc}`/backend/schemas` — How fields compose schemas -- {doc}`/backend/content-types/index` — Use fields in content type schemas -- {doc}`/backend/vocabularies` — Define vocabularies for Choice fields -- {doc}`/backend/relations` — Relation fields for linking content +- {ref}`Schemas ` +- {ref}`Content types ` +- {ref}`Vocabularies ` +- {ref}`Relations ` diff --git a/docs/backend/relations.md b/docs/backend/relations.md index 8534d33353..48ad7f497f 100644 --- a/docs/backend/relations.md +++ b/docs/backend/relations.md @@ -646,7 +646,7 @@ But it can also be the name of a relation that is created by code, for example, ## Related content -- {doc}`/backend/schemas` — Define schemas for content types and forms -- {doc}`/backend/fields` — Field types including `RelationChoice` and `RelationList` -- {doc}`/backend/content-types/index` — Create custom content types with relations -- {doc}`/backend/vocabularies` — Control which items can be related using vocabularies +- {ref}`Schemas ` +- {ref}`Relation fields ` +- {ref}`Content types ` +- {ref}`Vocabularies ` diff --git a/docs/backend/schemas.md b/docs/backend/schemas.md index 00ec171c48..25848be05e 100644 --- a/docs/backend/schemas.md +++ b/docs/backend/schemas.md @@ -39,6 +39,8 @@ Zope schemas are used for tasks such as: - specifying required attributes on an object - defining custom validators on input data +(schemas-fields-label)= + The basic unit of data model declaration is the {doc}`field `, which specifies what kind of data each Python attribute can hold. @@ -731,9 +733,9 @@ def fields(self): ## Related content -- {doc}`/backend/fields` — Field types used in schemas -- {doc}`/backend/content-types/index` — Use schemas to define content types -- {doc}`/classic-ui/forms` — Use schemas to create forms -- {doc}`/backend/vocabularies` — Define vocabularies for Choice fields +- {ref}`Fields ` +- {ref}`Content types ` +- {ref}`Forms ` +- {ref}`Vocabularies ` diff --git a/docs/backend/vocabularies.md b/docs/backend/vocabularies.md index ca27c2a6b0..a81d8d695b 100644 --- a/docs/backend/vocabularies.md +++ b/docs/backend/vocabularies.md @@ -22,6 +22,6 @@ See issue [Backend > Vocabularies needs content](https://github.com/plone/docume ## Related content -- {doc}`/backend/fields` — Use vocabularies with Choice fields -- {doc}`/backend/schemas` — Define schemas with Choice fields -- {doc}`/backend/content-types/index` — Use vocabularies in content type schemas \ No newline at end of file +- {ref}`Fields ` +- {ref}`Schemas ` +- {ref}`Content types ` \ No newline at end of file diff --git a/docs/backend/widgets.md b/docs/backend/widgets.md index 8ff59482c7..9c5b9fd1e9 100644 --- a/docs/backend/widgets.md +++ b/docs/backend/widgets.md @@ -786,7 +786,7 @@ The code renders both widgets, {guilabel}`min` and {guilabel}`max`, in a single ## Related content -- {doc}`/backend/fields` — Field types that use widgets -- {doc}`/backend/schemas` — Define schemas with widget directives -- {doc}`/classic-ui/forms` — Use widgets in forms -- {doc}`/backend/content-types/index` — Customize widgets for content types +- {ref}`Fields ` +- {ref}`Schemas ` +- {ref}`Forms ` +- {ref}`Content types ` diff --git a/docs/conceptual-guides/compare-buildout-pip.md b/docs/conceptual-guides/compare-buildout-pip.md index af770a7064..24a56f459b 100644 --- a/docs/conceptual-guides/compare-buildout-pip.md +++ b/docs/conceptual-guides/compare-buildout-pip.md @@ -7,6 +7,8 @@ myst: "keywords": "Plone 6, Conceptual guides, Classic UI, Buildout, pip, install" --- +(compare-buildout-pip-label)= + # Compare Buildout and pip This guide explains the differences between two tools, {term}`Buildout` and {term}`pip`, to install Plone and its Classic UI user interface, helping to inform your choice when developing your new project in Plone. From 97a4fb9547f450118949f7829ab866d260697adc Mon Sep 17 00:00:00 2001 From: Manik Khajuria Date: Wed, 3 Dec 2025 17:09:40 +0530 Subject: [PATCH 04/12] Added Recommended Changes --- docs/_inc/_create-classic-ui-instance.md | 2 +- docs/admin-guide/add-site.md | 6 +++--- docs/admin-guide/backup-restore-plone-buildout.md | 6 +++--- docs/admin-guide/export-import.md | 4 ++-- docs/admin-guide/install-buildout.md | 8 ++++---- docs/admin-guide/install-pip.md | 6 +++--- docs/backend/behaviors.md | 6 +++--- docs/backend/content-types/creating-content-types.md | 10 +++++----- docs/backend/fields.md | 8 ++++---- docs/backend/relations.md | 8 ++++---- docs/backend/schemas.md | 8 ++++---- docs/backend/vocabularies.md | 6 +++--- docs/backend/widgets.md | 8 ++++---- 13 files changed, 43 insertions(+), 43 deletions(-) diff --git a/docs/_inc/_create-classic-ui-instance.md b/docs/_inc/_create-classic-ui-instance.md index c3c31484ee..7a3d69000a 100644 --- a/docs/_inc/_create-classic-ui-instance.md +++ b/docs/_inc/_create-classic-ui-instance.md @@ -15,4 +15,4 @@ To stop the Plone instance in foreground mode, type {kbd}`ctrl-c`. ## Related content -- {ref}`Classic UI ` \ No newline at end of file +- {ref}`classic-ui-index-label` \ No newline at end of file diff --git a/docs/admin-guide/add-site.md b/docs/admin-guide/add-site.md index 0cfb15ce75..62935e3860 100644 --- a/docs/admin-guide/add-site.md +++ b/docs/admin-guide/add-site.md @@ -74,6 +74,6 @@ If you select the Volto frontend, you can switch to it by changing the port numb ## Related content -- {ref}`Install Plone with Cookieplone ` -- {ref}`Install Plone with Buildout ` -- {ref}`Install Plone with pip ` +- {ref}`install-cookieplone-label` +- {ref}`install-buildout-label` +- {ref}`install-pip-label` diff --git a/docs/admin-guide/backup-restore-plone-buildout.md b/docs/admin-guide/backup-restore-plone-buildout.md index ff8acc51d9..7147df1d93 100644 --- a/docs/admin-guide/backup-restore-plone-buildout.md +++ b/docs/admin-guide/backup-restore-plone-buildout.md @@ -96,6 +96,6 @@ Some Plone sites require incremental backups every few minutes. ## Related content -- {ref}`Export and import site data ` -- {ref}`Install Plone with Buildout ` -- {ref}`Install Plone with pip ` \ No newline at end of file +- {ref}`exportimport` +- {ref}`install-buildout-label` +- {ref}`install-pip-label` \ No newline at end of file diff --git a/docs/admin-guide/export-import.md b/docs/admin-guide/export-import.md index e319c1a0e8..50b7e19500 100644 --- a/docs/admin-guide/export-import.md +++ b/docs/admin-guide/export-import.md @@ -114,5 +114,5 @@ Consider a File content item with UID `3e0dd7c4b2714eafa1d6fc6a1493f953` and a P ## Related content -- {ref}`Back up and restore a Plone buildout ` -- {ref}`Add a Plone site ` +- {ref}`back-up-and-restore-a-plone-buildout-label` +- {ref}`add-a-plone-site-label` diff --git a/docs/admin-guide/install-buildout.md b/docs/admin-guide/install-buildout.md index a51dd29edd..a68626e311 100644 --- a/docs/admin-guide/install-buildout.md +++ b/docs/admin-guide/install-buildout.md @@ -129,7 +129,7 @@ bin/instance stop ## Related content -- {ref}`Add a Plone site ` -- {ref}`Install Plone with pip ` -- {ref}`Back up and restore a Plone buildout ` -- {ref}`Compare Buildout and pip ` +- {ref}`add-a-plone-site-label` +- {ref}`install-pip-label` +- {ref}`back-up-and-restore-a-plone-buildout-label` +- {ref}`compare-buildout-pip-label` diff --git a/docs/admin-guide/install-pip.md b/docs/admin-guide/install-pip.md index 820b73b155..c4cb43920b 100644 --- a/docs/admin-guide/install-pip.md +++ b/docs/admin-guide/install-pip.md @@ -100,6 +100,6 @@ bin/runwsgi -v instance/etc/zope.ini ## Related content -- {ref}`Add a Plone site ` -- {ref}`Install Plone with Buildout ` -- {ref}`Compare Buildout and pip ` +- {ref}`add-a-plone-site-label` +- {ref}`install-buildout-label` +- {ref}`compare-buildout-pip-label` diff --git a/docs/backend/behaviors.md b/docs/backend/behaviors.md index e81f391c1f..5953ce775c 100644 --- a/docs/backend/behaviors.md +++ b/docs/backend/behaviors.md @@ -381,6 +381,6 @@ This dynamically provided interface enables the component architecture to react ## Related content -- {ref}`Content types ` -- {ref}`Schemas ` -- {ref}`Fields ` +- {ref}`backend-content-types-index-label` +- {ref}`backend-schemas-label` +- {ref}`backend-fields-label` diff --git a/docs/backend/content-types/creating-content-types.md b/docs/backend/content-types/creating-content-types.md index a7ae56618f..41ded45c55 100644 --- a/docs/backend/content-types/creating-content-types.md +++ b/docs/backend/content-types/creating-content-types.md @@ -121,8 +121,8 @@ Also have a look at Plone {doc}`/backend/behaviors`, which provide default featu ## Related content -- {ref}`Schemas ` -- {ref}`Fields ` -- {ref}`Widgets ` -- {ref}`Behaviors ` -- {ref}`Factory Type Information ` +- {ref}`backend-schemas-label` +- {ref}`backend-fields-label` +- {ref}`backend-widgets-label` +- {ref}`backend-behaviors-label` +- {ref}`backend-content-types-fti-label` diff --git a/docs/backend/fields.md b/docs/backend/fields.md index 2ba12ba188..8a0ae958fc 100644 --- a/docs/backend/fields.md +++ b/docs/backend/fields.md @@ -368,7 +368,7 @@ In supermodel XML, the directives are `security:read-permission` and ## Related content -- {ref}`Schemas ` -- {ref}`Content types ` -- {ref}`Vocabularies ` -- {ref}`Relations ` +- {ref}`backend-schemas-label` +- {ref}`backend-content-types-index-label` +- {ref}`backend-vocabularies-label` +- {ref}`relations-label` diff --git a/docs/backend/relations.md b/docs/backend/relations.md index 48ad7f497f..c9212c2055 100644 --- a/docs/backend/relations.md +++ b/docs/backend/relations.md @@ -646,7 +646,7 @@ But it can also be the name of a relation that is created by code, for example, ## Related content -- {ref}`Schemas ` -- {ref}`Relation fields ` -- {ref}`Content types ` -- {ref}`Vocabularies ` +- {ref}`backend-schemas-label` +- {ref}`backend-fields-relation-fields-label` +- {ref}`backend-content-types-index-label` +- {ref}`backend-vocabularies-label` diff --git a/docs/backend/schemas.md b/docs/backend/schemas.md index 25848be05e..156a08d341 100644 --- a/docs/backend/schemas.md +++ b/docs/backend/schemas.md @@ -733,9 +733,9 @@ def fields(self): ## Related content -- {ref}`Fields ` -- {ref}`Content types ` -- {ref}`Forms ` -- {ref}`Vocabularies ` +- {ref}`backend-fields-label` +- {ref}`backend-content-types-index-label` +- {ref}`classic-ui-forms-label` +- {ref}`backend-vocabularies-label` diff --git a/docs/backend/vocabularies.md b/docs/backend/vocabularies.md index a81d8d695b..a34b01c8ff 100644 --- a/docs/backend/vocabularies.md +++ b/docs/backend/vocabularies.md @@ -22,6 +22,6 @@ See issue [Backend > Vocabularies needs content](https://github.com/plone/docume ## Related content -- {ref}`Fields ` -- {ref}`Schemas ` -- {ref}`Content types ` \ No newline at end of file +- {ref}`backend-fields-label` +- {ref}`backend-schemas-label` +- {ref}`backend-content-types-index-label` \ No newline at end of file diff --git a/docs/backend/widgets.md b/docs/backend/widgets.md index 9c5b9fd1e9..2cbd8f9c0a 100644 --- a/docs/backend/widgets.md +++ b/docs/backend/widgets.md @@ -786,7 +786,7 @@ The code renders both widgets, {guilabel}`min` and {guilabel}`max`, in a single ## Related content -- {ref}`Fields ` -- {ref}`Schemas ` -- {ref}`Forms ` -- {ref}`Content types ` +- {ref}`backend-fields-label` +- {ref}`backend-schemas-label` +- {ref}`classic-ui-forms-label` +- {ref}`backend-content-types-index-label` From 0beca1a264b91eb93653e3b736cda38705bfb789 Mon Sep 17 00:00:00 2001 From: Manik Khajuria Date: Thu, 4 Dec 2025 18:24:46 +0530 Subject: [PATCH 05/12] Added Recommended Changes Latest --- docs/_inc/_create-classic-ui-instance.md | 6 +----- docs/_inc/_install-python-plone61.md | 6 +----- docs/admin-guide/add-site.md | 9 ++++++--- docs/admin-guide/backup-restore-plone-buildout.md | 6 +++--- docs/admin-guide/export-import.md | 4 ++-- docs/admin-guide/install-buildout.md | 8 ++++---- docs/admin-guide/install-pip.md | 6 +++--- docs/backend/behaviors.md | 6 +++--- docs/backend/content-types/creating-content-types.md | 10 +++++----- docs/backend/fields.md | 8 ++++---- docs/backend/relations.md | 8 ++++---- docs/backend/schemas.md | 8 ++++---- docs/backend/vocabularies.md | 6 +++--- docs/backend/widgets.md | 8 ++++---- 14 files changed, 47 insertions(+), 52 deletions(-) diff --git a/docs/_inc/_create-classic-ui-instance.md b/docs/_inc/_create-classic-ui-instance.md index 7a3d69000a..dd0a907996 100644 --- a/docs/_inc/_create-classic-ui-instance.md +++ b/docs/_inc/_create-classic-ui-instance.md @@ -11,8 +11,4 @@ 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`. - -## Related content - -- {ref}`classic-ui-index-label` \ No newline at end of file +To stop the Plone instance in foreground mode, type {kbd}`ctrl-c`. \ No newline at end of file diff --git a/docs/_inc/_install-python-plone61.md b/docs/_inc/_install-python-plone61.md index 8cca8c0ba5..69de9fabc3 100644 --- a/docs/_inc/_install-python-plone61.md +++ b/docs/_inc/_install-python-plone61.md @@ -6,8 +6,4 @@ Do not create or activate a Python virtual environment at this time. The instructions below will create one. ``` -Plone 6.1 requires Python version {{SUPPORTED_PYTHON_VERSIONS_PLONE61}}. - -## Related content - -- {ref}`Plone installation requirements ` \ No newline at end of file +Plone 6.1 requires Python version {{SUPPORTED_PYTHON_VERSIONS_PLONE61}}. \ No newline at end of file diff --git a/docs/admin-guide/add-site.md b/docs/admin-guide/add-site.md index 62935e3860..971f10496c 100644 --- a/docs/admin-guide/add-site.md +++ b/docs/admin-guide/add-site.md @@ -74,6 +74,9 @@ If you select the Volto frontend, you can switch to it by changing the port numb ## Related content -- {ref}`install-cookieplone-label` -- {ref}`install-buildout-label` -- {ref}`install-pip-label` +- {doc}`/install/create-project-cookieplone` +- {doc}`/admin-guide/install-buildout` +- {doc}`/admin-guide/install-pip` +- {doc}`/conceptual-guides/distributions` +- {doc}`/developer-guide/create-a-distribution` +- {doc}`/conceptual-guides/choose-user-interface` diff --git a/docs/admin-guide/backup-restore-plone-buildout.md b/docs/admin-guide/backup-restore-plone-buildout.md index 7147df1d93..5b5c276a3d 100644 --- a/docs/admin-guide/backup-restore-plone-buildout.md +++ b/docs/admin-guide/backup-restore-plone-buildout.md @@ -96,6 +96,6 @@ Some Plone sites require incremental backups every few minutes. ## Related content -- {ref}`exportimport` -- {ref}`install-buildout-label` -- {ref}`install-pip-label` \ No newline at end of file +- {doc}`/admin-guide/export-import` +- {ref}`install-buildout-label` +- {doc}`/admin-guide/install-pip` \ No newline at end of file diff --git a/docs/admin-guide/export-import.md b/docs/admin-guide/export-import.md index 50b7e19500..ea908b7245 100644 --- a/docs/admin-guide/export-import.md +++ b/docs/admin-guide/export-import.md @@ -114,5 +114,5 @@ Consider a File content item with UID `3e0dd7c4b2714eafa1d6fc6a1493f953` and a P ## Related content -- {ref}`back-up-and-restore-a-plone-buildout-label` -- {ref}`add-a-plone-site-label` +- {doc}`/admin-guide/backup-restore-plone-buildout` +- {ref}`add-a-plone-site-label` diff --git a/docs/admin-guide/install-buildout.md b/docs/admin-guide/install-buildout.md index a68626e311..d5b7a15fa1 100644 --- a/docs/admin-guide/install-buildout.md +++ b/docs/admin-guide/install-buildout.md @@ -129,7 +129,7 @@ bin/instance stop ## Related content -- {ref}`add-a-plone-site-label` -- {ref}`install-pip-label` -- {ref}`back-up-and-restore-a-plone-buildout-label` -- {ref}`compare-buildout-pip-label` +- {doc}`/admin-guide/add-site` +- {ref}`install-pip-label` +- {doc}`/admin-guide/backup-restore-plone-buildout` +- {ref}`compare-buildout-pip-label` diff --git a/docs/admin-guide/install-pip.md b/docs/admin-guide/install-pip.md index c4cb43920b..6897029891 100644 --- a/docs/admin-guide/install-pip.md +++ b/docs/admin-guide/install-pip.md @@ -100,6 +100,6 @@ bin/runwsgi -v instance/etc/zope.ini ## Related content -- {ref}`add-a-plone-site-label` -- {ref}`install-buildout-label` -- {ref}`compare-buildout-pip-label` +- {doc}`/admin-guide/add-site` +- {ref}`install-buildout-label` +- {doc}`/conceptual-guides/compare-buildout-pip` diff --git a/docs/backend/behaviors.md b/docs/backend/behaviors.md index 5953ce775c..ce660ac9fe 100644 --- a/docs/backend/behaviors.md +++ b/docs/backend/behaviors.md @@ -381,6 +381,6 @@ This dynamically provided interface enables the component architecture to react ## Related content -- {ref}`backend-content-types-index-label` -- {ref}`backend-schemas-label` -- {ref}`backend-fields-label` +- {doc}`/backend/content-types/index` +- {ref}`backend-schemas-label` +- {doc}`/backend/fields` diff --git a/docs/backend/content-types/creating-content-types.md b/docs/backend/content-types/creating-content-types.md index 41ded45c55..fe6e09b827 100644 --- a/docs/backend/content-types/creating-content-types.md +++ b/docs/backend/content-types/creating-content-types.md @@ -121,8 +121,8 @@ Also have a look at Plone {doc}`/backend/behaviors`, which provide default featu ## Related content -- {ref}`backend-schemas-label` -- {ref}`backend-fields-label` -- {ref}`backend-widgets-label` -- {ref}`backend-behaviors-label` -- {ref}`backend-content-types-fti-label` +- {doc}`/backend/schemas` +- {ref}`backend-fields-label` +- {doc}`/backend/widgets` +- {ref}`backend-behaviors-label` +- {doc}`/backend/content-types/fti` diff --git a/docs/backend/fields.md b/docs/backend/fields.md index 8a0ae958fc..8a11866181 100644 --- a/docs/backend/fields.md +++ b/docs/backend/fields.md @@ -368,7 +368,7 @@ In supermodel XML, the directives are `security:read-permission` and ## Related content -- {ref}`backend-schemas-label` -- {ref}`backend-content-types-index-label` -- {ref}`backend-vocabularies-label` -- {ref}`relations-label` +- {doc}`/backend/schemas` +- {ref}`backend-content-types-index-label` +- {doc}`/backend/vocabularies` +- {ref}`relations-label` diff --git a/docs/backend/relations.md b/docs/backend/relations.md index c9212c2055..f4c7328beb 100644 --- a/docs/backend/relations.md +++ b/docs/backend/relations.md @@ -646,7 +646,7 @@ But it can also be the name of a relation that is created by code, for example, ## Related content -- {ref}`backend-schemas-label` -- {ref}`backend-fields-relation-fields-label` -- {ref}`backend-content-types-index-label` -- {ref}`backend-vocabularies-label` +- {doc}`/backend/schemas` +- {ref}`backend-fields-relation-fields-label` +- {doc}`/backend/content-types/index` +- {ref}`backend-vocabularies-label` diff --git a/docs/backend/schemas.md b/docs/backend/schemas.md index 156a08d341..a25782687e 100644 --- a/docs/backend/schemas.md +++ b/docs/backend/schemas.md @@ -733,9 +733,9 @@ def fields(self): ## Related content -- {ref}`backend-fields-label` -- {ref}`backend-content-types-index-label` -- {ref}`classic-ui-forms-label` -- {ref}`backend-vocabularies-label` +- {doc}`/backend/fields` +- {ref}`backend-content-types-index-label` +- {doc}`/classic-ui/forms` +- {ref}`backend-vocabularies-label` diff --git a/docs/backend/vocabularies.md b/docs/backend/vocabularies.md index a34b01c8ff..6dc7e30b91 100644 --- a/docs/backend/vocabularies.md +++ b/docs/backend/vocabularies.md @@ -22,6 +22,6 @@ See issue [Backend > Vocabularies needs content](https://github.com/plone/docume ## Related content -- {ref}`backend-fields-label` -- {ref}`backend-schemas-label` -- {ref}`backend-content-types-index-label` \ No newline at end of file +- {doc}`/backend/fields` +- {ref}`backend-schemas-label` +- {doc}`/backend/content-types/index` \ No newline at end of file diff --git a/docs/backend/widgets.md b/docs/backend/widgets.md index 2cbd8f9c0a..18fc469f48 100644 --- a/docs/backend/widgets.md +++ b/docs/backend/widgets.md @@ -786,7 +786,7 @@ The code renders both widgets, {guilabel}`min` and {guilabel}`max`, in a single ## Related content -- {ref}`backend-fields-label` -- {ref}`backend-schemas-label` -- {ref}`classic-ui-forms-label` -- {ref}`backend-content-types-index-label` +- {doc}`/backend/fields` +- {ref}`backend-schemas-label` +- {doc}`/classic-ui/forms` +- {ref}`backend-content-types-index-label` From aca54e10219c50bb4daf7699bd12d063bb18f49a Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 8 Dec 2025 01:51:15 -0800 Subject: [PATCH 06/12] revert --- docs/_inc/_continuous-integration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_inc/_continuous-integration.md b/docs/_inc/_continuous-integration.md index ef9ceccf2c..4b29642242 100644 --- a/docs/_inc/_continuous-integration.md +++ b/docs/_inc/_continuous-integration.md @@ -4,4 +4,4 @@ All of a project's CI jobs must pass before a contribution may be accepted. ```{seealso} {doc}`/contributing/core/continuous-integration` -``` \ No newline at end of file +``` From 176de5cec06c2ccb4a78742011a91a6ff40883bf Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 8 Dec 2025 01:51:40 -0800 Subject: [PATCH 07/12] revert --- docs/_inc/_create-classic-ui-instance.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_inc/_create-classic-ui-instance.md b/docs/_inc/_create-classic-ui-instance.md index dd0a907996..2d08e03860 100644 --- a/docs/_inc/_create-classic-ui-instance.md +++ b/docs/_inc/_create-classic-ui-instance.md @@ -11,4 +11,4 @@ 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`. \ No newline at end of file +To stop the Plone instance in foreground mode, type {kbd}`ctrl-c`. From 18cd6368d7559ab20b78d3ae4088a22bd6d8a604 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 8 Dec 2025 01:52:01 -0800 Subject: [PATCH 08/12] revert --- docs/_inc/_install-python-plone61.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/_inc/_install-python-plone61.md b/docs/_inc/_install-python-plone61.md index 69de9fabc3..b819d58578 100644 --- a/docs/_inc/_install-python-plone61.md +++ b/docs/_inc/_install-python-plone61.md @@ -6,4 +6,4 @@ Do not create or activate a Python virtual environment at this time. The instructions below will create one. ``` -Plone 6.1 requires Python version {{SUPPORTED_PYTHON_VERSIONS_PLONE61}}. \ No newline at end of file +Plone 6.1 requires Python version {{SUPPORTED_PYTHON_VERSIONS_PLONE61}}. From 123c7e3a3906623623f17f95978daf498dea7ac2 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 8 Dec 2025 01:52:39 -0800 Subject: [PATCH 09/12] revert --- docs/_inc/_create-classic-ui-instance.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/_inc/_create-classic-ui-instance.md b/docs/_inc/_create-classic-ui-instance.md index 2d08e03860..2c768d90e3 100644 --- a/docs/_inc/_create-classic-ui-instance.md +++ b/docs/_inc/_create-classic-ui-instance.md @@ -12,3 +12,4 @@ 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`. + From a335cb8fe6df8519ce5b5ac8579cb634c65f46be Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 8 Dec 2025 02:18:02 -0800 Subject: [PATCH 10/12] Apply suggestions from code review --- docs/admin-guide/backup-restore-plone-buildout.md | 3 +-- docs/admin-guide/install-buildout.md | 4 ++-- docs/admin-guide/install-pip.md | 2 +- docs/backend/behaviors.md | 2 +- docs/backend/content-types/creating-content-types.md | 4 ++-- docs/backend/fields.md | 4 ++-- docs/backend/relations.md | 2 +- docs/backend/schemas.md | 4 ++-- docs/backend/vocabularies.md | 2 +- docs/backend/widgets.md | 4 ++-- 10 files changed, 15 insertions(+), 16 deletions(-) diff --git a/docs/admin-guide/backup-restore-plone-buildout.md b/docs/admin-guide/backup-restore-plone-buildout.md index 5b5c276a3d..650a41dd5f 100644 --- a/docs/admin-guide/backup-restore-plone-buildout.md +++ b/docs/admin-guide/backup-restore-plone-buildout.md @@ -97,5 +97,4 @@ Some Plone sites require incremental backups every few minutes. ## Related content - {doc}`/admin-guide/export-import` -- {ref}`install-buildout-label` -- {doc}`/admin-guide/install-pip` \ No newline at end of file +- {ref}`install-buildout-label` \ No newline at end of file diff --git a/docs/admin-guide/install-buildout.md b/docs/admin-guide/install-buildout.md index d5b7a15fa1..9a345ee475 100644 --- a/docs/admin-guide/install-buildout.md +++ b/docs/admin-guide/install-buildout.md @@ -130,6 +130,6 @@ bin/instance stop ## Related content - {doc}`/admin-guide/add-site` -- {ref}`install-pip-label` +- {doc}`/admin-guide/install-pip` - {doc}`/admin-guide/backup-restore-plone-buildout` -- {ref}`compare-buildout-pip-label` +- {ref}`/conceptual-guides/compare-buildout-pip` diff --git a/docs/admin-guide/install-pip.md b/docs/admin-guide/install-pip.md index 6897029891..fbdfd32e3c 100644 --- a/docs/admin-guide/install-pip.md +++ b/docs/admin-guide/install-pip.md @@ -101,5 +101,5 @@ bin/runwsgi -v instance/etc/zope.ini ## Related content - {doc}`/admin-guide/add-site` -- {ref}`install-buildout-label` +- {doc}`/admin-guide/install-buildout` - {doc}`/conceptual-guides/compare-buildout-pip` diff --git a/docs/backend/behaviors.md b/docs/backend/behaviors.md index ce660ac9fe..0cab7e8055 100644 --- a/docs/backend/behaviors.md +++ b/docs/backend/behaviors.md @@ -382,5 +382,5 @@ This dynamically provided interface enables the component architecture to react ## Related content - {doc}`/backend/content-types/index` -- {ref}`backend-schemas-label` +- {doc}`/backend/schemas` - {doc}`/backend/fields` diff --git a/docs/backend/content-types/creating-content-types.md b/docs/backend/content-types/creating-content-types.md index fe6e09b827..c3e6433baf 100644 --- a/docs/backend/content-types/creating-content-types.md +++ b/docs/backend/content-types/creating-content-types.md @@ -122,7 +122,7 @@ Also have a look at Plone {doc}`/backend/behaviors`, which provide default featu ## Related content - {doc}`/backend/schemas` -- {ref}`backend-fields-label` +- {doc}`/backend/fields` - {doc}`/backend/widgets` -- {ref}`backend-behaviors-label` +- {doc}`/backend/behaviors` - {doc}`/backend/content-types/fti` diff --git a/docs/backend/fields.md b/docs/backend/fields.md index 8a11866181..8c2c51ae5e 100644 --- a/docs/backend/fields.md +++ b/docs/backend/fields.md @@ -369,6 +369,6 @@ In supermodel XML, the directives are `security:read-permission` and ## Related content - {doc}`/backend/schemas` -- {ref}`backend-content-types-index-label` +- {doc}`/backend/content-types` - {doc}`/backend/vocabularies` -- {ref}`relations-label` +- {doc}`/backend/relations` diff --git a/docs/backend/relations.md b/docs/backend/relations.md index f4c7328beb..18a32c8acd 100644 --- a/docs/backend/relations.md +++ b/docs/backend/relations.md @@ -649,4 +649,4 @@ But it can also be the name of a relation that is created by code, for example, - {doc}`/backend/schemas` - {ref}`backend-fields-relation-fields-label` - {doc}`/backend/content-types/index` -- {ref}`backend-vocabularies-label` +- {doc}`/backend/vocabularies` diff --git a/docs/backend/schemas.md b/docs/backend/schemas.md index a25782687e..8483cefa2a 100644 --- a/docs/backend/schemas.md +++ b/docs/backend/schemas.md @@ -734,8 +734,8 @@ def fields(self): ## Related content - {doc}`/backend/fields` -- {ref}`backend-content-types-index-label` +- {doc}`/backend/content-types/index` - {doc}`/classic-ui/forms` -- {ref}`backend-vocabularies-label` +- {doc}`/backend/vocabularies` diff --git a/docs/backend/vocabularies.md b/docs/backend/vocabularies.md index 6dc7e30b91..8fbc04f612 100644 --- a/docs/backend/vocabularies.md +++ b/docs/backend/vocabularies.md @@ -23,5 +23,5 @@ See issue [Backend > Vocabularies needs content](https://github.com/plone/docume ## Related content - {doc}`/backend/fields` -- {ref}`backend-schemas-label` +- {ref}`/backend/schemas` - {doc}`/backend/content-types/index` \ No newline at end of file diff --git a/docs/backend/widgets.md b/docs/backend/widgets.md index 18fc469f48..5b6cf16f77 100644 --- a/docs/backend/widgets.md +++ b/docs/backend/widgets.md @@ -787,6 +787,6 @@ The code renders both widgets, {guilabel}`min` and {guilabel}`max`, in a single ## Related content - {doc}`/backend/fields` -- {ref}`backend-schemas-label` +- {doc}`/backend/schemas` - {doc}`/classic-ui/forms` -- {ref}`backend-content-types-index-label` +- {doc}`/backend/content-types/index` From fc0b034b51926ec351b3da3c587b78c8b892e760 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 8 Dec 2025 02:20:28 -0800 Subject: [PATCH 11/12] Apply suggestions from code review --- docs/admin-guide/backup-restore-plone-buildout.md | 2 +- docs/admin-guide/install-buildout.md | 2 +- docs/backend/vocabularies.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/admin-guide/backup-restore-plone-buildout.md b/docs/admin-guide/backup-restore-plone-buildout.md index 650a41dd5f..2e36751426 100644 --- a/docs/admin-guide/backup-restore-plone-buildout.md +++ b/docs/admin-guide/backup-restore-plone-buildout.md @@ -97,4 +97,4 @@ Some Plone sites require incremental backups every few minutes. ## Related content - {doc}`/admin-guide/export-import` -- {ref}`install-buildout-label` \ No newline at end of file +- {doc}`/admin-guide/install-buildout` \ No newline at end of file diff --git a/docs/admin-guide/install-buildout.md b/docs/admin-guide/install-buildout.md index 9a345ee475..5888502c1e 100644 --- a/docs/admin-guide/install-buildout.md +++ b/docs/admin-guide/install-buildout.md @@ -132,4 +132,4 @@ bin/instance stop - {doc}`/admin-guide/add-site` - {doc}`/admin-guide/install-pip` - {doc}`/admin-guide/backup-restore-plone-buildout` -- {ref}`/conceptual-guides/compare-buildout-pip` +- {doc}`/conceptual-guides/compare-buildout-pip` diff --git a/docs/backend/vocabularies.md b/docs/backend/vocabularies.md index 8fbc04f612..780644ad64 100644 --- a/docs/backend/vocabularies.md +++ b/docs/backend/vocabularies.md @@ -23,5 +23,5 @@ See issue [Backend > Vocabularies needs content](https://github.com/plone/docume ## Related content - {doc}`/backend/fields` -- {ref}`/backend/schemas` +- {doc}`/backend/schemas` - {doc}`/backend/content-types/index` \ No newline at end of file From ac4b37adbb1dd1828230137bff81912292a498b6 Mon Sep 17 00:00:00 2001 From: Steve Piercy Date: Mon, 8 Dec 2025 02:29:03 -0800 Subject: [PATCH 12/12] /index --- docs/backend/fields.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/backend/fields.md b/docs/backend/fields.md index 8c2c51ae5e..b3c2212c8a 100644 --- a/docs/backend/fields.md +++ b/docs/backend/fields.md @@ -369,6 +369,6 @@ In supermodel XML, the directives are `security:read-permission` and ## Related content - {doc}`/backend/schemas` -- {doc}`/backend/content-types` +- {doc}`/backend/content-types/index` - {doc}`/backend/vocabularies` - {doc}`/backend/relations`