Skip to content

Commit 4bb1454

Browse files
committed
Create new Admin Guide, moving content from Authors Guide
1 parent e06cdbb commit 4bb1454

File tree

2 files changed

+36
-22
lines changed

2 files changed

+36
-22
lines changed

docs/contributing/admins.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
---
2+
html_meta:
3+
"description": "Administrators' guide to writing Plone Documentation. It covers automated deployments, hosting, automated testing, previewing, and importing external package documentation into Plone Documentation."
4+
"property=og:description": "Administrators' guide to writing Plone Documentation. It covers automated deployments, hosting, automated testing, previewing, and importing external package documentation into Plone Documentation."
5+
"property=og:title": "Administrators Guide"
6+
"keywords": "Plone, Documentation, automated deployments, hosting, automated testing, importing external packages"
7+
---
8+
9+
(administrators-guide-label)=
10+
11+
# Administrators Guide
12+
13+
This guide is for administrators of Plone Documentation.
14+
It covers automated deployments, hosting, automated testing, previewing, and importing external package documentation into Plone Documentation.
15+
16+
17+
(administrators-import-docs-submodule-label)=
18+
19+
## Importing external docs with submodules
20+
21+
To add an external package to Plone Documentation, we use git submodules.
22+
We did this with Volto documentation.
23+
Your package must be available under the Plone GitHub organization.
24+
25+
Inside the repository `plone/documentation`, add a git submodule that points to your project.
26+
27+
```shell
28+
git submodule add [email protected]:plone/my_package.git submodules/my_package
29+
```
30+
31+
To make it easier for other contributors to work with your project, update the following files, using `volto` as a model.
32+
33+
- `Makefile` targets `docs/my_package` and `deps`
34+
- The documentation section {ref}`contributing-documentation-and-volto-label`
35+
36+
Commit and push your changes to a remote, and submit a pull request against [`plone/documentation@6-dev`](https://github.com/plone/documentation/compare).

docs/contributing/authors.md

Lines changed: 0 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,28 +15,6 @@ It covers configuring quality checks and syntax for writing markup that is of pa
1515
For general markup syntax, see {doc}`writing-docs-guide`.
1616

1717

18-
(authors-import-docs-submodule-label)=
19-
20-
## Importing external docs with submodules
21-
22-
To add an external package to Plone Documentation, we use git submodules.
23-
We did this with Volto documentation.
24-
Your package must be available under the Plone GitHub organization.
25-
26-
Inside the repository `plone/documentation`, add a git submodule that points to your project.
27-
28-
```shell
29-
git submodule add [email protected]:plone/my_package.git submodules/my_package
30-
```
31-
32-
To make it easier for other contributors to work with your project, update the following files, using `volto` as a model.
33-
34-
- `Makefile` targets `docs/my_package` and `deps`
35-
- The documentation section {ref}`contributing-documentation-and-volto-label`
36-
37-
Commit and push your changes to a remote, and submit a pull request against [`plone/documentation@6-dev`](https://github.com/plone/documentation/compare).
38-
39-
4018
(authors-html-meta-data-label)=
4119

4220
## HTML and Open Graph Metadata

0 commit comments

Comments
 (0)