|
| 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). |
0 commit comments