Skip to content

docs: Complete operator-workflow docs: role quickstarts, landing index, and truthful stale-content cleanup #24

Description

@Nickfost

Problem

The repository contains substantial standards and architecture documentation, but an operator still has to assemble a complete workflow from multiple files. The first VM pilot exposed ambiguity about what to run, what was already decided, which step was blocked, and which component owns each action.

Documentation should let a new operator, intern, or automation agent complete common work without reconstructing the architecture from conversation history.

Goal

Create a clear documentation structure organized around outcomes and roles:

  • CI worker host;
  • test/staging environment host;
  • production deployment host;
  • application project onboarding;
  • new physical location/VPS onboarding;
  • credentials and GitHub-side prerequisites;
  • installation, upgrade, repair, verification, rollback, and removal.

Required improvements

  • Add a concise documentation landing page with a role and task index.
  • Explain CI worker, tester, and deployer boundaries in plain language.
  • Provide separate quickstarts for each host role.
  • Make prerequisites, required credentials, stopping conditions, and expected results explicit.
  • Link each manual runbook to its eventual one-command Bash installer.
  • Provide copyable configuration examples containing fictional values only.
  • Add end-to-end checklists and final-report templates.
  • Identify which steps occur in GitHub, on Proxmox, on the Linux host, in private configuration, and in an application repository.
  • Mark prototype-only, current, planned, and production-ready material clearly.
  • Remove duplicated or contradictory instructions.
  • Ensure every command states where it runs and whether it changes state.
  • Include troubleshooting for the failures encountered during the first live pilot.
  • Add a glossary for runner, worker, controller, scale set, tester, deployer, environment, artifact, and project contract.
  • Keep public examples free of internal infrastructure details and credentials.
  • Add link validation and documentation checks to CI.

Acceptance

A person unfamiliar with the project can select a goal from the documentation landing page and complete or safely stop the workflow without needing chat history.

The documentation must answer:

  1. What am I installing?
  2. Where does it run?
  3. Which configuration and credentials are required?
  4. What single command performs the operation?
  5. How do I verify success?
  6. How do I upgrade, repair, roll back, or remove it?
  7. What must never be combined or exposed?

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions