Skip to content

Hosting Documentation

Context and Problem Statement

This document discusses a concept on how to publish the documentation of a product (e.g. PSS®X) and distribute it as part of the customer installation.

The process to create the documentation itself is out-of-scope of this document and should be handled separately.

Decision Drivers

  • Overall concept to thost the user manuals as part of product delivery
  • Concept shall work for multiple products per customer installation
  • Concept shall cover initial distribution and subsequent updates
  • Documentations & user manuals shall be hosted as static web sites

Considered Options

Decision Outcome

Chosen option: "mkdocs" because,

  • Need to invest development effort to able host documents at gitlab repository with volo documentation module.