openstack-caracal-ipv4 / clientdocs /
..
README.md addendum 22: H1 tenant-assert.sh + harness (7/7 green), clientdocs/ package (DOCFIX-092), A2 + structure + sequencing rulings recorded 15 hours ago
intake-form.md addendum 22: H1 tenant-assert.sh + harness (7/7 green), clientdocs/ package (DOCFIX-092), A2 + structure + sequencing rulings recorded 15 hours ago
self-service-guide.md addendum 22: H1 tenant-assert.sh + harness (7/7 green), clientdocs/ package (DOCFIX-092), A2 + structure + sequencing rulings recorded 15 hours ago
welcome.md addendum 22: H1 tenant-assert.sh + harness (7/7 green), clientdocs/ package (DOCFIX-092), A2 + structure + sequencing rulings recorded 15 hours ago
README.md

clientdocs/ -- client-facing document package (INTERNAL README)

This directory holds everything we hand to a client, separated from internal docs/runbooks by operator ruling (2026-07-06). Everything here is a DRAFT / living document: accurate, but without final client polish.

Rules for this directory:

  • No internal identifiers. Decision numbers, fix numbers, ticket ids, internal hostnames/IPs, and runbook names never appear in client documents. (This also keeps these files out of the internal numbering scans.)
  • Client language. Second person, no charm/Juju/deployment internals. Internal mechanics live in docs/tenant-onboarding-contract.md, which is the authoritative source these documents are derived from -- when the contract changes, sweep this directory.
  • Packaging. A client receives a copy (or export) of the relevant files, never a repo link. Which file goes when:
    • intake-form.md -- BEFORE onboarding (their homework).
    • welcome.md + self-service-guide.md -- AT credential handoff.
  • ASCII + LF, like everything committed.

Contents: intake-form.md, welcome.md, self-service-guide.md.