Documentation Policy

Documentation Policy for OpenConext Stepup

Keep documentation close to the source

Keep documentation close to the source code, in the repositories. This allows the documentation to be kept up to date and versioned with the source.

• Do use the standard documentation files. A repository should at least contain:

  • a /README(.md)
  • a /CHANGELOG

• Document configuration files by providing a ".dist" version with comments that clearly explains the use of the available configuraton parameters. E.g. parameters.yml.dist

• Other documentation that is closely associated with the component should be stored in the "/docs" directory in the repository.

Use the Stepup-Deploy wiki for general documentation

The Stepup-Deploy wiki is the place to put documentation that does not fit well with a single component. This wiki is also the place that provides an overview of the entire OpenConext Stepup ecosystem.