docs: add beginner quickstart as the onboarding entry path - #49
Conversation
Issue #24: a new operator no longer has to assemble the flow from architecture documents. docs/QUICKSTART.md walks what ci-fleet does, installing one controller, connecting one repository, and running and verifying one job, with advanced material (schema v3, capacity promotion, monitoring) explicitly out of the initial path. The docs index routes new operators to it first.
|
@codex review |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7d88b60d6b
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
- --install for fresh hosts (--adopt is migration-only) - runners described as host-privileged (Docker socket), secret-free only for long-lived controller credentials - scale-set verification via controller evidence, not runner-name prefix - read-only Git credential / pinned-checkout prerequisite before install - isolated first-job proof retained via LIVE-PILOT.md - GitHub App Self-hosted runners permission requirement - installer management prerequisites (python3, systemd, tar, flock) Signed-off-by: Hermes Agent <hermes@nousresearch.com>
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2f0c5e343e
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
- runners no longer called secret-free; short-lived registration config and job secrets acknowledged - explicit minimal GITHUB_TOKEN permissions in starter workflow guidance - engine checkout must be the pinned reviewed commit before running the installer as root - private config must be fully initialized via init.sh, not only the controllers entry - first-job pointer now targets the in-repo live-pilot example - step 3 correctly attributes execution to the fleet host and transient Docker state Signed-off-by: Hermes Agent <hermes@nousresearch.com>
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: cfbbf10b43
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
- trusted jobs can reach host-local secrets via the Docker socket; no absolute credential-isolation claim - engine clone/checkout moved before the identity-file step - complete init.sh command including the created runner group - merged reviewed configuration required before install; resolve merge SHA - starter job guidance uses the managed label/image, not the experimental live-pilot example Signed-off-by: Hermes Agent <hermes@nousresearch.com>
|
@codex review |
|
Codex Review: Something went wrong. Try again later by commenting “@codex review”. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
…ocs/quickstart-issue-24 # Conflicts: # docs/QUICKSTART.md
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 7c4cef5e37
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
- engine pin must be merged and publicly reachable - split step 1 between management workstation and fleet host; keep write credentials off the host - local config checkout must persist for scheduled drift checks - starter job: timeout-minutes 5, no nested runner-image pinning - initialized repository is confirmed, not added twice Signed-off-by: Hermes Agent <hermes@nousresearch.com>
|
@codex review |
|
Codex Review: Something went wrong. Try again later by commenting “@codex review”. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
…ocs/quickstart-issue-24 # Conflicts: # docs/QUICKSTART.md
|
@codex review |
|
@codex review Please review the exact current head |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 6b77ebbfc2
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
- stage the dispatch-only proof workflow before runner-group authorization so no push-triggered job becomes the first job - executable managed-install cleanup proof (managed-label containers, run-scoped networks/volumes, health, CHECK_OK) - engine clone happens on the fleet host (public repo, no write cred) - root-scoped read-only credential requirement (sudo + drift service) - private config initialized from the pinned engine's vendored template - --repository passed separately from the project slug Signed-off-by: Hermes Agent <hermes@nousresearch.com>
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 45bc6b8abc
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
- commit the initialized fleet.json before pushing (was committed pre-init) - include the dispatch-only proof workflow YAML referenced by step 2 - filter cleanup check by kind=runner so the persistent controller is not flagged; search ci-* project-owned resource names per the PROJECT-STANDARD naming contract - start a fresh health oneshot after the proof job instead of reading the previous timer result - clone the pinned engine on the management workstation before copying the vendored template Signed-off-by: Hermes Agent <hermes@nousresearch.com>
|
@codex review |
|
Codex Review: Something went wrong. Try again later by commenting “@codex review”. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5dc0db87cb
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
- validate the configuration tree before the first commit - proof workflow must land on the default branch for workflow_dispatch - exclude the persistent ci-fleet_default controller network from the residue check Signed-off-by: Hermes Agent <hermes@nousresearch.com>
|
@codex review |
Signed-off-by: Hermes Agent <hermes@nousresearch.com>
|
Codex Review: Something went wrong. Try again later by commenting “@codex review”. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 42fe3d16b2
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
- runner group created without repository selection; authorization deferred to step 2 after the proof workflow is staged - controller excluded by exact names so fleet-named project containers cannot be hidden from the residue check Signed-off-by: Hermes Agent <hermes@nousresearch.com>
|
@codex review |
|
Codex Review: Something went wrong. Try again later by commenting “@codex review”. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: fccfeb1a20
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
Signed-off-by: Hermes Agent <hermes@nousresearch.com>
|
@codex review |
|
Codex Review: Something went wrong. Try again later by commenting “@codex review”. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
…mmit Signed-off-by: Hermes Agent <hermes@nousresearch.com>
|
@codex review |
|
Codex Review: Something went wrong. Try again later by commenting “@codex review”. ℹ️ About Codex in GitHubYour team has set up Codex to review pull requests in this repo. Reviews are triggered when you
If Codex has suggestions, it will comment; otherwise it will react with 👍. Codex can also answer questions or update the PR. Try commenting "@codex address that feedback". |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 5fe251f1a1
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f9b2673a4d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
|
@codex review |
1 similar comment
|
@codex review |
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: f9b2673a4d
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
2 participants
Part of #24.
What changed
docs/QUICKSTART.md: the beginner path in order — (0) what ci-fleet does, (1) install one controller, (2) connect one repository, (3) run and verify one job, (4) links to advanced material. Schema-v3 internals stay out of the onboarding path; each step states where it runs and whether it changes state.docs/README.md: routes new operators to the quickstart first.Docs-only.