Administrators Guide

This guide is for administrators of OpenSPP Documentation. It covers automated deployments, hosting, automated testing, previewing, and importing external package documentation into OpenSPP Documentation.

Importing external docs with submodules

To add an external package to OpenSPP Documentation, we use git submodules. Your package must be available under the OpenSPP GitHub organization.

Inside the repository openspp/documentation, add a git submodule that points to your project.

git submodule add [email protected]:openspp/my_package.git submodules/my_package

Add a target docs/my_package in Makefile, then add docs/my_package to the deps target, following openspp_registry 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.

make html

To make it easier for other contributors to work with your project, update the following files, using openspp_registry as a model.

• Add it to the documentation section for editing external package documentation.

• 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 openspp/documentation.