Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare for plone.app.dexterity docs #1455

Merged
merged 58 commits into from
Apr 21, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
58 commits
Select commit Hold shift + click to select a range
9af23e4
Prepare for plone.app.dexterity docs
stevepiercy Feb 24, 2023
02d6c1d
Document how to add external documentation for administrators of docu…
stevepiercy Feb 24, 2023
a0a719b
Merge branch '6-dev' into plone.app.dexterity-init
jensens Feb 27, 2023
675ced2
Update docs/contributing/admins.md
stevepiercy Feb 27, 2023
f046db6
Merge branch '6-dev' into plone.app.dexterity-init
stevepiercy Feb 27, 2023
de0df2e
Initial conversion of reStructuredText to MyST
stevepiercy Mar 6, 2023
9d08f32
Initial commit of plone.app.dexterity conversion of reStructuredText …
stevepiercy Mar 6, 2023
ca037d9
Add introductory sentence
stevepiercy Mar 6, 2023
3ec8e9d
Tidy designing.md
stevepiercy Mar 6, 2023
665d100
Tidy prerequisite.md
stevepiercy Mar 6, 2023
e4a1f5a
Tidy schema-driven-types.md
stevepiercy Mar 6, 2023
2cc3305
Merge branch '6-dev' into plone.app.dexterity-init
jensens Mar 6, 2023
147f9c6
Tidy model-driven-types.md
stevepiercy Apr 5, 2023
b6d57e4
Tidy custom-views.md
stevepiercy Apr 5, 2023
1275e3c
Tidy install.md
stevepiercy Apr 5, 2023
8a89be5
Tidy advanced/index.md
stevepiercy Apr 5, 2023
cbacb72
Strip file extensions
stevepiercy Apr 5, 2023
781f956
Tidy defaults.md
stevepiercy Apr 7, 2023
e366c16
Tidy validators.md
stevepiercy Apr 15, 2023
84677d8
Tidy vocabularies.md
stevepiercy Apr 15, 2023
f847ec7
Merge branch '6-dev' into plone.app.dexterity-init
stevepiercy Apr 15, 2023
7bc8cc7
Tidy references.md
stevepiercy Apr 15, 2023
9c339ef
Strip Unicode specifier after dropping Python 2 support
stevepiercy Apr 15, 2023
e6d1318
Merge branch '6-dev' into plone.app.dexterity-init
stevepiercy Apr 15, 2023
bf3c1fc
Tidy rich-text-markup-transformations.md
stevepiercy Apr 16, 2023
c3799cd
Tidy files-and-images.md
stevepiercy Apr 16, 2023
e502f9f
tidy static-resources.md
stevepiercy Apr 16, 2023
d47f17b
US English spelling
stevepiercy Apr 16, 2023
aadcec3
Tidy behaviors.md, add label and reference to Built-in behaviors
stevepiercy Apr 16, 2023
dcdd699
Tidy event-handlers.md
stevepiercy Apr 16, 2023
85225d0
Tidy permissions.md
stevepiercy Apr 16, 2023
4234148
Tidy workflow.md
stevepiercy Apr 16, 2023
60536db
Tidy catalog-indexing-strategies.md
stevepiercy Apr 16, 2023
f9e0ab9
Tidy custom-add-and-edit-forms.md
stevepiercy Apr 17, 2023
9024f08
Tidy custom-content-classes.md
stevepiercy Apr 17, 2023
0360684
Tidy webdav-and-other-file-representations.md
stevepiercy Apr 18, 2023
9185cf2
Tidy testing/index.md
stevepiercy Apr 18, 2023
0b37989
Tidy unit-tests.md
stevepiercy Apr 19, 2023
a85c02d
Tidy integration-tests.md
stevepiercy Apr 19, 2023
8c9e9a4
Tidy mock-testing.md
stevepiercy Apr 19, 2023
082d478
Tidy reference/index.md and correct to American English spelling
stevepiercy Apr 19, 2023
2e9ff77
Tidy reference/index.md
stevepiercy Apr 19, 2023
0197766
tidy reference/fields.md, add label
stevepiercy Apr 20, 2023
f408515
Tidy widgets.md
stevepiercy Apr 20, 2023
642a5bc
Fix indentation
stevepiercy Apr 20, 2023
6296667
Tidy standard-behaviors.md
stevepiercy Apr 20, 2023
940939d
Tidy form-schema-hints.md
stevepiercy Apr 20, 2023
f6ec984
Tidy manipulating-content-objects.md
stevepiercy Apr 20, 2023
f3582cf
Tidy dexterity-xml.md
stevepiercy Apr 21, 2023
52eda40
Tidy misc.md
stevepiercy Apr 21, 2023
9ee3e86
Grammar
stevepiercy Apr 21, 2023
aad39ee
Tidy index.md and intro.md
stevepiercy Apr 21, 2023
dd6771f
Tidy behavior-basics.md
stevepiercy Apr 21, 2023
27c63e9
Tidy creating-and-registering-behaviors.md
stevepiercy Apr 21, 2023
de8f3ab
Tidy providing-marker-interfaces.md
stevepiercy Apr 21, 2023
3694766
Tidy schema-only-behaviors.md
stevepiercy Apr 21, 2023
6ae26f6
Strip file suffix
stevepiercy Apr 21, 2023
a5e04d5
Tidy testing-behaviors.md
stevepiercy Apr 21, 2023
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes.
2 changes: 1 addition & 1 deletion docs/backend/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Insert introduction here.
:maxdepth: 2
configuration-registry
control-panels
content-types
content-types/index
behaviors
annotations
vocabularies
Expand Down
36 changes: 36 additions & 0 deletions docs/contributing/admins.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,42 @@ This guide is for administrators of Plone Documentation.
It covers automated deployments, hosting, automated testing, previewing, and importing external package documentation into Plone Documentation.


(administrators-import-docs-submodule-label)=

## Importing external docs and converting to MyST

This section describes how to import external projects and convert their docs to MyST.
We did this for `plone.app.dexterity` and several other projects.

1. Create a new branch using the name of the project.
1. Install [rst-to-myst](https://pypi.org/project/rst-to-myst/).

```shell
bin/pip install "rst-to-myst[sphinx]"
```

1. Clone the project repository to the root of `plone/documentation`.
1. Delete any non-documentation files from the clone.
1. Move the documentation files and subfolders to the root of the clone, retaining the documentation structure.
1. Convert the reStructuredText documentation files to MyST.
The example commands below assume that there are files at the root of the clone and in one sub-level of nested directories. For deeper nesting, insert globbing syntax for each sub-level as `**/`
stevepiercy marked this conversation as resolved.
Show resolved Hide resolved

```shell
bin/rst2myst convert -R project/*.rst
bin/rst2myst convert -R project/**/*.rst
```

1. Add HTML meta data to the converted files.

```shell
cd project
../bin/python ../docs/addMetaData.py
```

1. Optionally clean up any MyST syntax.
1. Commit and push your branch to GitHub and create a pull request.


(administrators-import-docs-submodule-label)=

## Importing external docs with submodules
Expand Down