Skip to content

Commit 5ad2633

Browse files
stevepiercystevepiercy
authored
Merge branch '6.0' into rohnsha0-control-panel
2 parents 228a0d3 + fa8c090 commit 5ad2633

File tree

15 files changed

+990
-27
lines changed

15 files changed

+990
-27
lines changed

‎docs/_static/searchtools.js‎

Lines changed: 699 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/_templates/search.html‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
{%- extends "page.html" %}
2+
{# Over-ride the body to be custom search structure we want #}
3+
{% block docs_body %}
4+
<div class="bd-search-container">
5+
<h1>{{ _("Search") }}</h1>
6+
<noscript>
7+
<div class="admonition error">
8+
<p class="admonition-title">{% trans %}Error{% endtrans %}</p>
9+
<p>{% trans %}Please activate JavaScript to enable the search functionality.{% endtrans %}</p>
10+
</div>
11+
</noscript>
12+
{% block searchtext %}
13+
<div>
14+
{% trans %}Searching for multiple words only shows matches that contain
15+
all words.{% endtrans %}
16+
</div>
17+
{% endblock %}
18+
{% include "components/search-field.html" %}
19+
<div id="search-results"></div>
20+
</div>
21+
<script>
22+
// Activate the search field on page load
23+
let searchInput = document.querySelector("form.bd-search input");
24+
if (searchInput) {
25+
searchInput.focus();
26+
searchInput.select();
27+
console.log("[PST]: Set focus on search field.");
28+
}
29+
</script>
30+
{% endblock docs_body %}
31+
{# Below sections just re-create the behavior of Sphinx default search #}
32+
{# Page metadata #}
33+
{%- block htmltitle -%}
34+
<title>{{ _("Search") }} - {{ title or docstitle }}</title>
35+
{%- endblock htmltitle -%}
36+
{# Manually include the search JS that Sphinx includes #}
37+
{% block scripts -%}
38+
{{ super() }}
39+
<script src="{{ pathto('_static/searchtools.js', 1) }}"></script>
40+
<script src="{{ pathto('_static/language_data.js', 1) }}"></script>
41+
<script src="{{ pathto('searchindex.js', 1) }}"></script>
42+
{%- endblock scripts %}

‎docs/conf.py‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -132,9 +132,13 @@
132132
# This pattern also affects html_static_path and html_extra_path.
133133
exclude_patterns = [
134134
"spelling_wordlist.txt",
135+
"**/CHANGES.md",
135136
"**/CHANGES.rst",
137+
"**/LICENSE.rst",
138+
"**/CONTRIBUTORS.md",
136139
"**/CONTRIBUTORS.rst",
137140
"**/LICENSE.rst",
141+
"**/README.md",
138142
"**/README.rst",
139143
"**/eggs",
140144
"_inc/.*",
@@ -151,6 +155,7 @@
151155
"plone.restapi/parts",
152156
"plone.restapi/performance",
153157
"plone.restapi/src",
158+
"plone.restapi/styles",
154159
"plone.restapi/var",
155160
"volto/_inc/*",
156161
]
@@ -394,6 +399,12 @@
394399
"install/install-from-packages": "/install/create-project.html",
395400
"manage/frontend": "/volto/addons/index.html",
396401
"install/create-project": "/install/create-project-cookieplone.html",
402+
"user-guide/editor": "/volto/user-manual/index.html",
403+
"reference-guide/volto-configuration-settings.html": "/volto/configuration/settings-reference.html",
404+
"reference-guide/volto-javascript-client.html": "/volto/client/index.html",
405+
"reference-guide/plone.restapi-usage.html": "/plone.restapi/docs/source/usage/index.html",
406+
"reference-guide/plone.restapi-endpoints.html": "/plone.restapi/docs/source/endpoints/index.html",
407+
"reference-guide/plone.api-methods.html": "/plone.api/api/index.html",
397408
}
398409

399410

‎docs/contributing/volto.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ myst:
99

1010
# Contributing to Volto
1111

12-
See {doc}`/volto/contributing/index` under {guilabel}`Frontend`.
12+
See {doc}`/volto/contributing/index` under {guilabel}`Volto UI`.

‎docs/developer-guide/create-a-distribution.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -295,8 +295,8 @@ Then add it to your {file}`dependencies.zcml` file.
295295
<!-- List all packages your distribution depends on here -->
296296
<include package="plone.volto" />
297297
<include package="plone.restapi" />
298-
<include package="collective.person" />
299298
<include package="plone.distribution" />
299+
<include package="collective.person" />
300300
301301
</configure>
302302
```

‎docs/index.md‎

Lines changed: 103 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
myst:
33
html_meta:
4-
"description": "This website is the HTML documentation of Plone, an open source, enterprise-level content management system."
5-
"property=og:description": "This website is the HTML documentation of Plone, an open source, enterprise-level content management system."
4+
"description": "This website is the documentation of Plone, an open source, enterprise-level content management system."
5+
"property=og:description": "This website is the documentation of Plone, an open source, enterprise-level content management system."
66
"property=og:title": "Plone 6 Documentation"
77
"keywords": "Plone 6, content management system, CMS, open source, Documentation, Volto, Classic UI, frontend, backend, plone.restapi, plone.api"
88
---
@@ -13,13 +13,106 @@ myst:
1313

1414
This is the community-maintained documentation for the Plone content management system.
1515

16-
This documentation is for:
16+
`````{grid} 1 1 2 2
17+
:gutter: 3 3 4 5
1718
18-
- Editors who write and update content on a site
19-
- Site administrators who install Plone and add-ons, and set up a site
20-
- Designers who create site themes
21-
- Deployers who configure servers for site hosting
22-
- Developers who customize a site’s capabilities, create add-ons, and contribute to Plone itself
19+
````{grid-item-card}
20+
:link: install/index
21+
:link-type: doc
22+
{octicon}`zap;1.5em;sd-text-info`
23+
Get started
24+
^^^
25+
This part of the documentation describes how to get started with Plone.
26+
Choose from a trying a demo of Plone or installing Plone.
27+
+++
28+
```{button-ref} install/index
29+
:color: primary
30+
:expand:
31+
Go to Get started
32+
```
33+
````
34+
35+
````{grid-item-card}
36+
:link: user-guide/index
37+
:link-type: doc
38+
{octicon}`person;1.5em;sd-text-info`
39+
User guide
40+
^^^
41+
This part of the documentation describes how to use Plone effectively, covering tasks for site editors and administrators.
42+
+++
43+
```{button-ref} user-guide/index
44+
:ref-type: doc
45+
:color: primary
46+
:expand:
47+
Go to User guide
48+
```
49+
````
50+
51+
````{grid-item-card}
52+
:link: developer-guide/index
53+
:link-type: doc
54+
{octicon}`person-add;1.5em;sd-text-info`
55+
Developer guide
56+
^^^
57+
This part of the documentation describes how to develop a Plone project.
58+
+++
59+
```{button-ref} developer-guide/index
60+
:ref-type: doc
61+
:color: primary
62+
:expand:
63+
Go to Developer guide
64+
```
65+
````
66+
67+
````{grid-item-card}
68+
:link: reference-guide/index
69+
:link-type: doc
70+
{octicon}`bookmark;1.5em;sd-text-info`
71+
Reference guide
72+
^^^
73+
This part of the documentation describes the APIs, functions, modules, and objects included in Plone.
74+
+++
75+
```{button-ref} reference-guide/index
76+
:ref-type: doc
77+
:color: primary
78+
:expand:
79+
Go to Reference guide
80+
```
81+
````
82+
83+
````{grid-item-card}
84+
:link: conceptual-guides/index
85+
:link-type: doc
86+
{octicon}`light-bulb;1.5em;sd-text-info`
87+
Conceptual guides
88+
^^^
89+
This part of the documentation provides explanation of concepts to deepen and broaden your understanding of Plone.
90+
+++
91+
```{button-ref} conceptual-guides/index
92+
:ref-type: doc
93+
:color: primary
94+
:expand:
95+
Go to Conceptual guides
96+
```
97+
````
98+
99+
````{grid-item-card}
100+
:link: contributing/index
101+
:link-type: doc
102+
{octicon}`git-pull-request;1.5em;sd-text-info`
103+
Contributor guide
104+
^^^
105+
This part of the documentation describes how to contribute to Plone, including all its projects and repositories under the Plone GitHub organization.
106+
+++
107+
```{button-ref} contributing/index
108+
:ref-type: doc
109+
:color: primary
110+
:expand:
111+
Go to Contributor guide
112+
```
113+
````
114+
115+
`````
23116

24117
```{seealso}
25118
Read the [documentation for the previous version, Plone 5](https://5.docs.plone.org/).
@@ -42,6 +135,8 @@ backend/index
42135
i18n-l10n/index
43136
conceptual-guides/index
44137
contributing/index
138+
reference-guide/index
139+
user-guide/index
45140
```
46141

47142
```{toctree}

‎docs/install/index.md‎

Lines changed: 0 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -60,20 +60,3 @@ If you are following a [Plone training](https://training.plone.org/), it should
6060

6161
{doc}`Install Plone as a contributor </contributing/index>`
6262
: This option is for developers who want to contribute to Plone and its packages.
63-
64-
65-
(get-started-learn-more-label)=
66-
67-
## Learn more about Plone
68-
69-
The {doc}`/conceptual-guides/index` explain concepts to help you understand Plone.
70-
71-
The community has created a set of [Plone trainings](https://training.plone.org/) which are hosted separately from the documentation.
72-
Plone trainings take place at every annual Plone Conference.
73-
74-
75-
(get-started-contribute-label)=
76-
77-
## Contribute to Plone
78-
79-
See the {doc}`Contributor Guide </contributing/index>` to learn how to participate in the Plone community and contribute to our open source software.

‎docs/reference-guide/index.md‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description": "Plone reference guide"
5+
"property=og:description": "Plone reference guide"
6+
"property=og:title": "Plone reference guide"
7+
"keywords": "Plone, reference, guide"
8+
---
9+
10+
# Reference guide
11+
12+
This reference guide details application programming interfaces (APIs), functions, modules, and objects included in Plone, describing what they are and what they do.
13+
Its audience is primarily developers of Plone and its projects and add-ons.
14+
15+
{doc}`Volto configuration settings </volto/configuration/settings-reference>`
16+
: This reference contains a summary of the configuration options and what they control.
17+
18+
{doc}`Plone REST API JavaScript client endpoints </volto/client/index>`
19+
: Plone REST API JavaScript client is a framework agnostic library based on TanStack Query.
20+
21+
{doc}`Plone REST API usage </plone.restapi/docs/source/usage/index>`
22+
: This reference describes how to authenticate, batch records, manipulate content, and other common usage of the Plone REST API.
23+
24+
{doc}`Plone REST API endpoints </plone.restapi/docs/source/endpoints/index>`
25+
: This reference describes each of the endpoints in the Plone REST API.
26+
It includes usage and examples of HTTP requests and expected responses.
27+
28+
{doc}`Plone API methods </plone.api/api/index>`
29+
: The list of Plone API methods and their descriptions for Plone backend functionality.
30+
31+
```{toctree}
32+
:hidden:
33+
volto-configuration-settings
34+
volto-javascript-client
35+
plone.restapi-usage
36+
plone.restapi-endpoints
37+
plone.api-methods
38+
```

‎docs/reference-guide/plone.api-methods.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description": "Plone API methods"
5+
"property=og:description": "Plone API methods"
6+
"property=og:title": "Plone API methods"
7+
"keywords": "Plone, API, methods"
8+
---
9+
10+
# Plone API methods
11+
12+
See {doc}`/plone.api/api/index`.

‎docs/reference-guide/plone.restapi-endpoints.md‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
---
2+
myst:
3+
html_meta:
4+
"description": "Plone REST API endpoints"
5+
"property=og:description": "Plone REST API endpoints"
6+
"property=og:title": "Plone REST API endpoints"
7+
"keywords": "Plone, REST, API, endpoints"
8+
---
9+
10+
# Plone REST API endpoints
11+
12+
See {doc}`/plone.restapi/docs/source/endpoints/index`.

0 commit comments

Comments
 (0)