Assembled documentation

Assembled documentation is the product of building many documentation sets and weaving them into a global navigation to produce the fully assembled documentation site.

The assembler:

1. Clones multiple documentation repositories.
2. Reads the configuration files and builds a global navigation.
3. Builds each documentation set independently using the global configuration and navigation to inform path prefixes.
4. Produces a unified documentation website.

Assembled documentation is configured through the site configuration, which defines:

• assembler.yml: Which repositories to include and their branching strategy.
• navigation.yml: Navigation and url prefixes for TOC's.
• versions.yml: Defines the various versioning schemes of products/solutions being documented.
• products.yml: Defines the product catalog (id, name) and ties it to a specific versioning scheme.

Refer to Site Configuration for details on configuring assembled documentation.

The typical build process for assembled documentation consists of three steps:

1. Clone all configured repositories using docs-builder assembler clone.
2. Build all documentation sets using docs-builder assembler build.
3. Serve the documentation on http://localhost:4000 using docs-builder assembler serve.

This uses the embedded configuration files inside the docs-builder binary. To build a specific configuration:

1. Fetch the latest config to $(pwd)/config docs-builder assembler config init --local.
2. Clone all configured repositories using docs-builder assembler clone --local.
3. Build all documentation sets using docs-builder assembler build --local.
4. Serve the documentation on http://localhost:4000 using docs-builder assembler serve.

• Documentation Set: The individual units being assembled.
• Distributed Documentation: How documentation sets work independently.
• Link Catalog: How the assembler knows what to include.