Skip to main content

Operational procedure - controlled documentation release

This procedure records the release checkpoints used in the project. It is not an instruction to copy private output into the public site. Commands, addresses and credentials for private administration remain outside the public procedure.

1. Define the target​

Choose either private documentation or the public portfolio. Confirm the intended source repository, build configuration and destination before writing anything. A successful private build is not an approved public artifact.

2. Prepare and review sources​

  • Preserve the current revision or an appropriate file backup.
  • Update factual state on the relevant page and historical outcomes in the journal.
  • For generated pages, change metadata or templates instead of generated output.
  • Review the exact diff, links, status claims and author metadata.
  • Exclude private addresses, key material, tokens and unrelated files.
  • For the public site, use only the explicit content allowlist and selected assets.

3. Build and preview​

Build the intended profile into its own output directory. Review the result locally in a browser, including navigation, assets and any diagrams. A build success establishes compilation, not visual correctness or publication.

4. Release through the correct path​

Private documentation​

Commit only the reviewed files and push to the configured workflow branch. Observe the Actions result and receiver outcome. Record the deployed revision, not just that the runner service is active.

Public portfolio​

The initial public site uses a separate static backend. Before replacing its placeholder, preserve its current content and confirm the exact public output and destination. Public content deployment is not yet covered by an established automated public pipeline. Do not redirect the private workflow to this backend.

5. Verify the result​

Check the actual changed text at the intended URL. For public material, use an anonymous browser outside the VPN and verify that private repositories remain unavailable. Check more than the homepage when multiple pages change.

Recovery decision​

Stop on an unexpected error; do not stack unrelated changes on an unknown state. Preserve logs without secrets and identify which stage failed.

  • Source-only error: return to the last approved source revision and rebuild.
  • Public static content error: use the preserved public content to restore the previous artifact through the same controlled deployment path.
  • Private image deployment error: inspect the receiver result and verify the active backend before any manual correction.

These are recovery actions and implemented mechanisms, not evidence that all failure modes have been tested. In particular, deliberate rollback testing of the private receiver remains future work.