Deckhouse Development Platform documentation

This is the source for the Deckhouse Development Platform documentation website.

The project uses Hugo SSG and the hugo-web-product-module module for a theme.

Read hugo-web-product-module README.md for information about content markup and other details.

How to run the documentation site locally

To run locally:

1. Install werf and docker.

2. Run:

   make up

3. Open http://localhost/products/development-platform/documentation/ in your browser (for the english version) or http://ru.localhost/products/development-platform/documentation/ (for the russian version).

Generating PDF/DOCX exports

Run make pdf — the werf print-artifacts image is built and the resulting files are extracted into public/{en,ru}/documentation/downloads/print/development-platform.{pdf,docx}. On deploy the same image is imported into web, so the site serves them under the same URL.

This project enables PDF/DOCX through:

• params.pdf: true in config/_default/hugo.yaml;
• outputs: [HTML, search, print] in the front matter of content/documentation/_index.{md,ru.md};
• sidebar download links (rendered automatically by the module theme).

For the full description of the pipeline (werf stages, requirements, how to enable/disable for a new product website) see the PDF/DOCX exports section in the module README.