Skip to content

Commit 649811f

Browse files
committed
Add instructions for how to add external package documentation to Plone 6 Documentation
1 parent 48b5ab2 commit 649811f

File tree

2 files changed

+22
-1
lines changed

2 files changed

+22
-1
lines changed

Makefile

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@ bin/python:
3939
bin/pip install -r requirements.txt
4040

4141
docs/volto:
42-
# git submodule add [email protected]:plone/volto.git submodules/volto
4342
git submodule init; \
4443
git submodule update; \
4544
ln -s ../submodules/volto/docs/source ./docs/volto

docs/contributing/authors.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,28 @@ 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/6-dev...my_package).
38+
39+
1840
(authors-html-meta-data-label)=
1941

2042
## HTML and Open Graph Metadata

0 commit comments

Comments
 (0)