Skip to content

Commit 55625ca

Browse files
stevepiercystevepiercy
committed
Merge 6-dev
2 parents 2c4c03d + 88182aa commit 55625ca

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

71 files changed

+473
-363
lines changed

‎Makefile‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -221,6 +221,7 @@ deploy: clean html
221221
livehtml: deps ## Rebuild Sphinx documentation on changes, with live-reload in the browser
222222
cd "$(DOCS_DIR)" && ${SPHINXAUTOBUILD} \
223223
--ignore "*.swp" \
224+
--port 8050 \
224225
-b html . "$(BUILDDIR)/html" $(SPHINXOPTS) $(O)
225226

226227
.PHONY: netlify

‎README.md‎

Lines changed: 16 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -19,11 +19,6 @@ Browse the Plone 5.2 Documentation at https://docs.plone.org/.
1919
Development on the Plone 5.2 Documentation takes place on the branch [`5.2`](https://github.com/plone/documentation/tree/5.2).
2020

2121

22-
## Overview
23-
24-
The community is writing guides, installation instructions, and everything you need to know to enjoy working with Plone 6.
25-
26-
2722
## Contribute
2823

2924
- [Contributing to Plone 6 Documentation](https://6.dev-docs.plone.org/contributing/index.html)
@@ -32,9 +27,24 @@ The community is writing guides, installation instructions, and everything you n
3227
- [Source Code](https://github.com/plone/documentation/tree/6-dev)
3328

3429

30+
### Contributing to frontend (Volto), `plone.api`, and `plone.restapi` documentation
31+
32+
Plone documentation consists of this repository, `plone/documentation`, and it includes external packages' documentation through git submodules.
33+
Those packages include:
34+
35+
- [`volto`](https://github.com/plone/volto)
36+
- [`plone.api`](https://github.com/plone/plone.api)
37+
- [`plone.restapi`](https://github.com/plone/plone.restapi)
38+
39+
To contribute documentation, please open a pull request in the appropriate repository.
40+
For details, see [Editing external package documentation](https://6.dev-docs.plone.org/contributing/index.html#contributing-editing-external-package-documentation-label).
41+
42+
3543
## Support
3644

37-
If you have issues, please open an issue in our [Issue Tracker](https://github.com/plone/documentation/issues) or ask a question on our [Community Forum, Documentation category](https://community.plone.org/c/documentation/13).
45+
For technical support for **Plone documentation only**, please ask a question on our [Community Forum, Documentation category](https://community.plone.org/c/documentation/13).
46+
47+
For technical support for **Plone in general**, please ask a question on our [Community Forum](https://community.plone.org/) in the appropriate category.
3848

3949

4050
## Training

‎docs/addMetaData.py‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,15 @@
11
import os
22
import logging
33
metadata_check = """---
4-
html_meta:
4+
myst:
55
"""
66
metadata = """---
7-
html_meta:
8-
"description": ""
9-
"property=og:description": ""
10-
"property=og:title": ""
11-
"keywords": ""
7+
myst:
8+
html_meta:
9+
"description": ""
10+
"property=og:description": ""
11+
"property=og:title": ""
12+
"keywords": ""
1213
---
1314
1415
"""

‎docs/backend/annotations.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
2+
myst:
3+
html_meta:
4+
"description": ""
5+
"property=og:description": ""
6+
"property=og:title": ""
7+
"keywords": ""
78
---
89

910
(backend-annotations-label)=

‎docs/backend/behaviors.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
2+
myst:
3+
html_meta:
4+
"description": ""
5+
"property=og:description": ""
6+
"property=og:title": ""
7+
"keywords": ""
78
---
89

910
(backend-behaviors-label)=

‎docs/backend/content-types.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
2+
myst:
3+
html_meta:
4+
"description": ""
5+
"property=og:description": ""
6+
"property=og:title": ""
7+
"keywords": ""
78
---
89

910
(backend-content-types-label)=

‎docs/backend/control-panels.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
html_meta:
3-
"description": "How to add a Control Panel"
4-
"property=og:description": "How to add a Control Panel"
5-
"property=og:title": "Control panels"
6-
"keywords": "Plone, Add, Control Panel"
2+
myst:
3+
html_meta:
4+
"description": "How to add a Control Panel"
5+
"property=og:description": "How to add a Control Panel"
6+
"property=og:title": "Control panels"
7+
"keywords": "Plone, Add, Control Panel"
78
---
89

910
(backend-controlpanels-label)=

‎docs/backend/fields.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": ""
6-
"keywords": ""
2+
myst:
3+
html_meta:
4+
"description": ""
5+
"property=og:description": ""
6+
"property=og:title": ""
7+
"keywords": ""
78
---
89

910
(backend-fields-label)=

‎docs/backend/global-utils.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
html_meta:
3-
"description": "Global functions defined in CMFPlone and plone.app.layout."
4-
"property=og:description": "Global functions defined in CMFPlone and plone.app.layout."
5-
"property=og:title": "Global utils and helpers"
6-
"keywords": "Plone, Classic UI, templates, global variables, portal_state, context_state, plone_view, portal_url, helper methods"
2+
myst:
3+
html_meta:
4+
"description": "Global functions defined in CMFPlone and plone.app.layout."
5+
"property=og:description": "Global functions defined in CMFPlone and plone.app.layout."
6+
"property=og:title": "Global utils and helpers"
7+
"keywords": "Plone, Classic UI, templates, global variables, portal_state, context_state, plone_view, portal_url, helper methods"
78
---
89

910

‎docs/backend/index.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,10 @@
11
---
2-
html_meta:
3-
"description": ""
4-
"property=og:description": ""
5-
"property=og:title": "Backend"
6-
"keywords": "Plone 6, Volto, Classic UI, frontend, backend, plone.restapi, plone.api"
2+
myst:
3+
html_meta:
4+
"description": ""
5+
"property=og:description": ""
6+
"property=og:title": "Backend"
7+
"keywords": "Plone 6, Volto, Classic UI, frontend, backend, plone.restapi, plone.api"
78
---
89

910
(backend-index-label)=

0 commit comments

Comments
 (0)