Pull in plone.restapi docs

Author: stevepiercy

.gitignore

@@ -9,3 +9,4 @@ pyvenv.cfg
 
 # symlinked from submodule
 docs/volto
+docs/plone.restapi

.gitmodules

@@ -2,3 +2,7 @@
 	path = submodules/volto
 	url = https://github.com/plone/volto.git
 	branch = master
+[submodule "submodules/plone.restapi"]
+	path = submodules/plone.restapi
+	url = git@github.com:plone/plone.restapi.git
+	branch = plone6docs

Makefile

@@ -43,8 +43,13 @@ docs/volto:
 	git submodule update; \
 	ln -s ../submodules/volto/docs/source ./docs/volto
 
+docs/restapi:
+	git submodule init; \
+	git submodule update; \
+	ln -s ../submodules/plone.restapi/docs ./docs/plone.restapi
+
 .PHONY: deps
-deps: bin/python docs/volto  ## Create Python virtual environment, install requirements, pull in Volto submodule
+deps: bin/python docs/volto docs/restapi  ## Create Python virtual environment, install requirements, and finally initialize or update the volto and plone.restapi submodules.
 
 .PHONY: html
 html: deps  ## Build html

docs/contributing/admins.md

@@ -28,9 +28,19 @@ Inside the repository `plone/documentation`, add a git submodule that points to
 git submodule add git@github.com:plone/my_package.git submodules/my_package
 ```
 
+Add a target `docs/my_package` in `Makefile`, then add `docs/my_package` to the `deps` target, following `volto` as a pattern.
+You might need to adjust the paths to your package's documentation after it is cloned.
+
+To complete setup, generate a symlink to your project's docs, and build the docs, use a single command.
+
+```shell
+make html
+```
+
 To make it easier for other contributors to work with your project, update the following files, using `volto` as a model.
 
--   `Makefile` targets  `docs/my_package` and `deps`
--   The documentation section {ref}`contributing-editing-volto-documentation-label`
+-   Add it to the documentation section {ref}`contributing-editing-volto-documentation-label`.
+-   Add the symlink `docs/my_package` to `.gitignore`.
+-   Optionally set a branch to work on in `.gitmodules`.
 
 Commit and push your changes to a remote, and submit a pull request against [`plone/documentation@6-dev`](https://github.com/plone/documentation/compare).