Jump to: navigation, search



Currently, the documentation that we produce has no provenance information. If you're looking at a generated PDF or HTML, and you want to make an edit to the docs, there's nothing in the documentation itself to tell you were to go make the change.

In addition, it may be helpful to have this information for troubleshooting problems.

The idea behind this blueprint is to automatically insert the relevant information into the documentation as part of the build, possibly as part of the colophon.

Metadata to include

Possible data we want to include:

Data Example
Git repository https://github.com/openstack-manuals
Directory doc/install-guide
Launchapd project https://launchpad.net/openstack-manuals
git SHA b2b9a0a2bf10b322224ef8873945d9996d1a2220
clouddocs-maven-plugin version 1.12.0