Some Tips on how to use docToolchain in an Enterprise Environment

Some things are different when you use them at a larger scale. Here are some tips from experience with docToolchain in enterprise environments.

Corporate Identity

Customize the microsite design so your employees can better identify with the documentation. Take a look at 040_microsite/130_theming.html to see how to change the look and feel.

CI/CD Pipelines

To automatically build and deploy documentation, see the demo project: ci-cd-demo. It contains a GitHub workflow and a .gitlab-ci.yml as starters.

GitHub and GitLab each provide only one static page per repository. Restrict the deploy pipeline to your main branch to avoid overwriting production docs from feature branches.

Set DTC_HEADLESS=true in your CI environment to skip interactive prompts.

Docker

The docToolchain Docker image is self-contained with all dependencies. Run your build pipeline directly on this image — dtcw4 detects it and uses the bundled tools.

./dtcw4 docker generateSite