docs(custosctl): reference + evaluation pointer + README (DEVCLI-IMPL-011, #962)#975
Merged
Conversation
…-011)
- docs/developers/custosctl.md: new reference — targets (local/remote), the
full command surface (lifecycle, connector/activity, workflow, seed-ootb,
e2e), configuration table, and how it maps to the evaluation quickstart.
- docs/users/evaluation/{local-cluster,overview}.md: point at custosctl as the
scripted equivalent of the Runme flow.
- README.md + docs/developers/README.md: add pointers to the new reference.
- tools/custosctl/README.md: status note -> milestone 0.2 complete; link the
reference. Close design TODO-001 (register accepts folder or --image-ref).
Part of #951. Closes #962
Contributor
There was a problem hiding this comment.
Pull request overview
This PR completes DEVCLI-IMPL-011 by publishing a developer-facing custosctl reference and adding cross-links from the evaluation guides, developer index, and root README to make the CLI discoverable and positioned as the scripted equivalent of the evaluation walkthrough.
Changes:
- Add a new
custosctlreference doc underdocs/developers/describing targets, commands, configuration, and e2e flow. - Add pointers to the CLI from evaluation docs (
overview.md,local-cluster.md) and the repository root README. - Update
custosctlcomponent docs/trackers to mark the milestone/docs task as complete and close a related TODO.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 8 comments.
Show a summary per file
| File | Description |
|---|---|
| tools/custosctl/README.md | Adds a link to the new reference and updates the CLI status note to reflect milestone completion. |
| README.md | Adds a top-level quick link and a docs-table row pointing to the custosctl reference. |
| docs/users/evaluation/overview.md | Adds a related-docs row pointing evaluation readers to the custosctl CLI. |
| docs/users/evaluation/local-cluster.md | Adds a callout and related-docs row suggesting custosctl as a scripted alternative to manual steps. |
| docs/developers/README.md | Adds a section index row linking to the custosctl reference. |
| docs/developers/custosctl.md | New comprehensive CLI reference (targets, command surface, config table, e2e description). |
| design/components/custosctl/todos.md | Closes TODO-001 and marks the open section as empty. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Address PR #975 review: register always reads the manifest from a folder/manifest PATH (--image-ref only overrides the derived image); remote CUSTOS_KUBE_CONTEXT is optional and defaults to the current context; up does not build/load images; drop the non-existent --config global flag; fix the quickstart step mapping and the TODO-001 resolution wording.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #962
Summary
Final DEVCLI-IMPL task: publish the
custosctlreference, point the evaluation guide at the CLI as the scripted equivalent of the notebook flow, and add discoverable pointers from the root README + developer index. No code changes — docs only.Changes
docs/developers/custosctl.md(new) — reference covering thelocal/remotetarget model, the full command surface (lifecycledoctor/up/down/status,connector/activityregister+list,workflowapply/run/status,seed-ootb, and thee2esmoke with a sequence diagram), theCUSTOS_*configuration table, error/exit-code semantics, and a "Relationship to the evaluation quickstart" section.docs/users/evaluation/local-cluster.md— a callout under the M1 note plus a related-docs row:custosctl upperforms steps 2–6 andcustosctl e2ealso seeds + runs a workflow; the quickstart is the readable walkthrough of what the CLI scripts.docs/users/evaluation/overview.md— related-docs row for the CLI.README.md— quick-links bullet + docs-table row.docs/developers/README.md— Sections-table row for the reference.tools/custosctl/README.md— status note → "milestone 0.2 complete"; links the new reference.design/components/custosctl/todos.md— close TODO-001: registration accepts both a local extension folder and a bare--image-ref(implemented in DEVCLI-IMPL-005: connector register / connector list #956/DEVCLI-IMPL-006: activity register / activity list #957, now documented).Validation
Notes
This completes every task under tracker #951; the tracker can close after this merges.