Skip to content

Customer Environment Deployment

Some customers will not want a public documentation site at all.

Internal docs host

Serve the built site on an internal hostname.

Best when:

  • customer has internal DNS
  • docs access is controlled separately from the product

Path-based hosting

Serve the docs under:

  • /docs

Best when:

  • customer wants one platform hostname
  • ingress and auth should stay centralized

Static artifact handoff

Build the site and deliver it as static HTML.

Best when:

  • environment is air-gapped
  • the customer runs strict offline or approved-artifact processes

Operational Notes

  • avoid absolute hard-coded app URLs in docs content
  • prefer relative docs asset paths when embedding local media
  • if the customer environment uses internal auth, terminate it at the ingress or reverse proxy layer

Documentation-Specific Recommendation

Use the same MkDocs source for both public and customer-hosted deployments.

That keeps:

  • navigation consistent
  • operations guidance consistent
  • architecture language consistent