End User Documentation Generation

[samrocketman]

Jervis API already has thorough documentation. This documentation is for Jenkins administrators to provide to their end users who would be using Jenkins with Jervis deployed within a company.

Depending on where Jervis is deployed, different organizations have different needs for platforms, operating systems, languages supported, and the build toolchains available for the supported language. Because of this, keeping up to date documentation is really hard.

This issue is for automatically generating end user documentation for Jervis. This will be similar to the contents referenced in the wiki but take entries directly from the JSON files used to define platforms and operating systems. Each operating system would have its own lifecycle and toolchain availability for every language with differences depending on the OS.

This issue is to track documentation generation.

Documentation checklist

• Language lifecycle
• Language toolchains.
• Language introduction.
• Toolchains introduction.
• All toolchains.
• Operating system.
• Platform documentation.

Additional notes

Templates should come from jar resources or a user provided template directory. The template should fall back to a resource if the user does not provide one.

Documentation generation should support multiple modes

• Write out to string.
• Write out to file directory structure with hierarchy.

Markdown links should be supported. Two types:

• Inline markdown links auto-generated within docs.
• Optional user-provided markdown links to be substituted throughout documentation.

Finalize checklist

• 100% test coverage
• 100% Groovy doc; including some docs on templating

[samrocketman]

8ad9e89 provides Language lifecycle documentation generation.