Skip to content

Latest commit

 

History

55 Commits

Folders and files

NameName
Last commit message
Last commit date
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Deckhouse Delivery Kit documentation

This is the source for the Deckhouse Delivery Kit documentation website.

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

Read hugo-web-product-module AUTHORING.md for content markup, and its README.md for 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/delivery-kit/documentation/ in your browser (for the english version) or http://ru.localhost/products/delivery-kit/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/delivery-kit.{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.

About

Website for the Deckhouse Delivery Kit documentation

Resources

Code of conduct

Contributing

Security policy

Stars

2 stars

Watchers

3 watching

Forks

Contributors

Languages