Documentation
Docs that don't go stale
Our docs are captured in source control, with a number of Practiv designed components, templates and themes to build your documentation, based on your use of Practiv tools. Your docs will continuously deploy - every time you build an application, Jenkins and Maven will automatically redeploy your docs, with any updates to the applications, as well as any relevant change notes. They are extensible, so you can build your own Hugo components and incorporate anything you want into the base docs.
| Component Name | Description |
|---|---|
| documentation-basalt | Roll up of the change notes for all the Docker Base Imagess Providing the available base images and their change history to the end user |
| documentation-chalk | Roll up of the change notes for all the Build Tile Sets Providing the available Build Tile Sets and their change history to the end user |
| documentation-config-default | Set of sample configuration for configuring the developer documentation Testing the developer documentation |
| documentation-dust | Roll up of the change notes for all the Jenkins pipeline rules Providing the available Jenkins pipeline rules and their change history |
| documentation-example | Build of the documentation template with a default configuration Running the documentation with a known testing configuration to review that it builds and looks acceptable |
| documentation-product-platform | Documentation templates for the Practiv Digital Platform Providing documentation of the digital platform to the end user |
| documentation-template | The Practiv Developer Experience documentation template Building the base for documentation website that collates patterns, processes, as builts and playbooks in once place |
| documentation-theme | The Practiv Book Theme for Hugo Styling all Practiv documentation in a consistent way and linting it in the process |
| documentation-tiles | Roll up of the change notes for the Build Tiles Providing the available Build Tiles and their change history to the end user |
| practiv-build-decisions | The decisions for the Practiv BUILD platform Use to include the standard Practiv BUILD decisions in the developer documentation |
| practiv-infrastructure-documentation | The decisions for the Practiv RUN Infrastructure platform |
| practiv-run-decisions | The decisions for the Practiv RUN platform |