diff --git a/docs/conf.py b/docs/conf.py index 149ac41bc..33d7dae60 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -132,9 +132,13 @@ # This pattern also affects html_static_path and html_extra_path. exclude_patterns = [ "spelling_wordlist.txt", + "**/CHANGES.md", "**/CHANGES.rst", + "**/LICENSE.rst", + "**/CONTRIBUTORS.md", "**/CONTRIBUTORS.rst", "**/LICENSE.rst", + "**/README.md", "**/README.rst", "**/eggs", "_inc/.*", @@ -151,6 +155,7 @@ "plone.restapi/parts", "plone.restapi/performance", "plone.restapi/src", + "plone.restapi/styles", "plone.restapi/var", "volto/_inc/*", ] @@ -394,6 +399,12 @@ "install/install-from-packages": "/install/create-project.html", "manage/frontend": "/volto/addons/index.html", "install/create-project": "/install/create-project-cookieplone.html", + "user-guide/editor": "/volto/user-manual/index.html", + "reference-guide/volto-configuration-settings.html": "/volto/configuration/settings-reference.html", + "reference-guide/volto-javascript-client.html": "/volto/client/index.html", + "reference-guide/plone.restapi-usage.html": "/plone.restapi/docs/source/usage/index.html", + "reference-guide/plone.restapi-endpoints.html": "/plone.restapi/docs/source/endpoints/index.html", + "reference-guide/plone.api-methods.html": "/plone.api/api/index.html", } diff --git a/docs/contributing/volto.md b/docs/contributing/volto.md index 2b3b8777c..3ef8e8dd4 100644 --- a/docs/contributing/volto.md +++ b/docs/contributing/volto.md @@ -9,4 +9,4 @@ myst: # Contributing to Volto -See {doc}`/volto/contributing/index` under {guilabel}`Frontend`. +See {doc}`/volto/contributing/index` under {guilabel}`Volto UI`. diff --git a/docs/index.md b/docs/index.md index ff0325e63..e2d75ba12 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,8 +1,8 @@ --- myst: html_meta: - "description": "This website is the HTML documentation of Plone, an open source, enterprise-level content management system." - "property=og:description": "This website is the HTML documentation of Plone, an open source, enterprise-level content management system." + "description": "This website is the documentation of Plone, an open source, enterprise-level content management system." + "property=og:description": "This website is the documentation of Plone, an open source, enterprise-level content management system." "property=og:title": "Plone 6 Documentation" "keywords": "Plone 6, content management system, CMS, open source, Documentation, Volto, Classic UI, frontend, backend, plone.restapi, plone.api" --- @@ -13,13 +13,106 @@ myst: This is the community-maintained documentation for the Plone content management system. -This documentation is for: +`````{grid} 1 1 2 2 +:gutter: 3 3 4 5 -- Editors who write and update content on a site -- Site administrators who install Plone and add-ons, and set up a site -- Designers who create site themes -- Deployers who configure servers for site hosting -- Developers who customize a site’s capabilities, create add-ons, and contribute to Plone itself +````{grid-item-card} +:link: install/index +:link-type: doc +{octicon}`zap;1.5em;sd-text-info` +Get started +^^^ +This part of the documentation describes how to get started with Plone. +Choose from a trying a demo of Plone or installing Plone. ++++ +```{button-ref} install/index +:color: primary +:expand: +Go to Get started +``` +```` + +````{grid-item-card} +:link: user-guide/index +:link-type: doc +{octicon}`person;1.5em;sd-text-info` +User guide +^^^ +This part of the documentation describes how to use Plone effectively, covering tasks for site editors and administrators. ++++ +```{button-ref} user-guide/index +:ref-type: doc +:color: primary +:expand: +Go to User guide +``` +```` + +````{grid-item-card} +:link: developer-guide/index +:link-type: doc +{octicon}`person-add;1.5em;sd-text-info` +Developer guide +^^^ +This part of the documentation describes how to develop a Plone project. ++++ +```{button-ref} developer-guide/index +:ref-type: doc +:color: primary +:expand: +Go to Developer guide +``` +```` + +````{grid-item-card} +:link: reference-guide/index +:link-type: doc +{octicon}`bookmark;1.5em;sd-text-info` +Reference guide +^^^ +This part of the documentation describes the APIs, functions, modules, and objects included in Plone. ++++ +```{button-ref} reference-guide/index +:ref-type: doc +:color: primary +:expand: +Go to Reference guide +``` +```` + +````{grid-item-card} +:link: conceptual-guides/index +:link-type: doc +{octicon}`light-bulb;1.5em;sd-text-info` +Conceptual guides +^^^ +This part of the documentation provides explanation of concepts to deepen and broaden your understanding of Plone. ++++ +```{button-ref} conceptual-guides/index +:ref-type: doc +:color: primary +:expand: +Go to Conceptual guides +``` +```` + +````{grid-item-card} +:link: contributing/index +:link-type: doc +{octicon}`git-pull-request;1.5em;sd-text-info` +Contributor guide +^^^ +This part of the documentation describes how to contribute to Plone, including all its projects and repositories under the Plone GitHub organization. ++++ +```{button-ref} contributing/index +:ref-type: doc +:color: primary +:expand: +Go to Contributor guide +``` +```` + +````` ```{seealso} Read the [documentation for the previous version, Plone 5](https://5.docs.plone.org/). @@ -42,6 +135,8 @@ backend/index i18n-l10n/index conceptual-guides/index contributing/index +reference-guide/index +user-guide/index ``` ```{toctree} diff --git a/docs/install/index.md b/docs/install/index.md index 289310156..af66f000c 100644 --- a/docs/install/index.md +++ b/docs/install/index.md @@ -60,20 +60,3 @@ If you are following a [Plone training](https://training.plone.org/), it should {doc}`Install Plone as a contributor ` : This option is for developers who want to contribute to Plone and its packages. - - -(get-started-learn-more-label)= - -## Learn more about Plone - -The {doc}`/conceptual-guides/index` explain concepts to help you understand Plone. - -The community has created a set of [Plone trainings](https://training.plone.org/) which are hosted separately from the documentation. -Plone trainings take place at every annual Plone Conference. - - -(get-started-contribute-label)= - -## Contribute to Plone - -See the {doc}`Contributor Guide ` to learn how to participate in the Plone community and contribute to our open source software. diff --git a/docs/reference-guide/index.md b/docs/reference-guide/index.md new file mode 100644 index 000000000..2c93cbc8a --- /dev/null +++ b/docs/reference-guide/index.md @@ -0,0 +1,38 @@ +--- +myst: + html_meta: + "description": "Plone reference guide" + "property=og:description": "Plone reference guide" + "property=og:title": "Plone reference guide" + "keywords": "Plone, reference, guide" +--- + +# Reference guide + +This reference guide details application programming interfaces (APIs), functions, modules, and objects included in Plone, describing what they are and what they do. +Its audience is primarily developers of Plone and its projects and add-ons. + +{doc}`Volto configuration settings ` +: This reference contains a summary of the configuration options and what they control. + +{doc}`Plone REST API JavaScript client endpoints ` +: Plone REST API JavaScript client is a framework agnostic library based on TanStack Query. + +{doc}`Plone REST API usage ` +: This reference describes how to authenticate, batch records, manipulate content, and other common usage of the Plone REST API. + +{doc}`Plone REST API endpoints ` +: This reference describes each of the endpoints in the Plone REST API. + It includes usage and examples of HTTP requests and expected responses. + +{doc}`Plone API methods ` +: The list of Plone API methods and their descriptions for Plone backend functionality. + +```{toctree} +:hidden: +volto-configuration-settings +volto-javascript-client +plone.restapi-usage +plone.restapi-endpoints +plone.api-methods +``` diff --git a/docs/reference-guide/plone.api-methods.md b/docs/reference-guide/plone.api-methods.md new file mode 100644 index 000000000..2fd2d5179 --- /dev/null +++ b/docs/reference-guide/plone.api-methods.md @@ -0,0 +1,12 @@ +--- +myst: + html_meta: + "description": "Plone API methods" + "property=og:description": "Plone API methods" + "property=og:title": "Plone API methods" + "keywords": "Plone, API, methods" +--- + +# Plone API methods + +See {doc}`/plone.api/api/index`. diff --git a/docs/reference-guide/plone.restapi-endpoints.md b/docs/reference-guide/plone.restapi-endpoints.md new file mode 100644 index 000000000..4dcd7e3cd --- /dev/null +++ b/docs/reference-guide/plone.restapi-endpoints.md @@ -0,0 +1,12 @@ +--- +myst: + html_meta: + "description": "Plone REST API endpoints" + "property=og:description": "Plone REST API endpoints" + "property=og:title": "Plone REST API endpoints" + "keywords": "Plone, REST, API, endpoints" +--- + +# Plone REST API endpoints + +See {doc}`/plone.restapi/docs/source/endpoints/index`. diff --git a/docs/reference-guide/plone.restapi-usage.md b/docs/reference-guide/plone.restapi-usage.md new file mode 100644 index 000000000..7f9aa1b66 --- /dev/null +++ b/docs/reference-guide/plone.restapi-usage.md @@ -0,0 +1,12 @@ +--- +myst: + html_meta: + "description": "Plone REST API usage" + "property=og:description": "Plone REST API usage" + "property=og:title": "Plone REST API usage" + "keywords": "Plone, REST, API, usage" +--- + +# Plone REST API usage + +See {doc}`/plone.restapi/docs/source/usage/index`. diff --git a/docs/reference-guide/volto-configuration-settings.md b/docs/reference-guide/volto-configuration-settings.md new file mode 100644 index 000000000..6a1284b09 --- /dev/null +++ b/docs/reference-guide/volto-configuration-settings.md @@ -0,0 +1,12 @@ +--- +myst: + html_meta: + "description": "Volto configuration settings" + "property=og:description": "Volto configuration settings" + "property=og:title": "Volto configuration settings" + "keywords": "Plone, Volto, configuration, registry, settings" +--- + +# Volto configuration settings + +See {doc}`/volto/configuration/settings-reference`. diff --git a/docs/reference-guide/volto-javascript-client.md b/docs/reference-guide/volto-javascript-client.md new file mode 100644 index 000000000..4e1f498cd --- /dev/null +++ b/docs/reference-guide/volto-javascript-client.md @@ -0,0 +1,12 @@ +--- +myst: + html_meta: + "description": "Plone REST API JavaScript client endpoints" + "property=og:description": "Plone REST API JavaScript client endpoints" + "property=og:title": "Plone REST API JavaScript client endpoints" + "keywords": "Plone, Volto, REST, API, JavaScript, client, endpoints" +--- + +# Plone REST API JavaScript client endpoints + +See {doc}`/volto/client/index`. diff --git a/docs/user-guide/editor.md b/docs/user-guide/editor.md new file mode 100644 index 000000000..e7b0c2545 --- /dev/null +++ b/docs/user-guide/editor.md @@ -0,0 +1,12 @@ +--- +myst: + html_meta: + "description": "How to edit content in Plone" + "property=og:description": "How to edit content in Plone" + "property=og:title": "How to edit content in Plone" + "keywords": "Plone, edit, content" +--- + +# Editor guide + +See {doc}`/volto/user-manual/index` under {guilabel}`Volto UI`. diff --git a/docs/user-guide/index.md b/docs/user-guide/index.md new file mode 100644 index 000000000..a9f06ab53 --- /dev/null +++ b/docs/user-guide/index.md @@ -0,0 +1,23 @@ +--- +myst: + html_meta: + "description": "Plone user guide" + "property=og:description": "Plone user guide" + "property=og:title": "Plone user guide" + "keywords": "Plone, user, guide, editor, administrator" +--- + +# User guide + +This part of the documentation describes how to use Plone effectively, covering tasks for site editors and administrators. + +{doc}`/volto/user-manual/index` +: This guide describes how to work with blocks in Volto, the Plone 6 frontend. + +{doc}`training:content-editing/index` +: This training describes how to create and manage content using Plone. + +```{toctree} +:hidden: +editor +```