How to update generated documentation

Several sections of our reference documentation are generated automatically. These include:

To update them, we have a number of Make targets:

make generate-docs            # Update all generated docs

make generate-command-docs    # Update command docs
make generate-config-docs     # Update config docs
make generate-feature-docs    # Update feature docs
make generate-test-step-docs  # Update list of available test steps
make generate-api-docs        # Update API docs

N.B. Updating the Feature docs can take several minutes, as it runs the entire test suite. Also, some of the changes made when updating Command docs are not particularly relevant; eg. updated timestamps in example log output.

Updating these should be a regular part of our release process

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License.
Rugged TUF Server is a trademark of Consensus Enterprises.