Repository navigation
docs: align control-plane docs with the current API and CLI - #3404
Merged
Luiz Oliveira (laoj2) merged 1 commit intoOct 30, 2026
Merged
Conversation
haiyanmeng
marked this pull request as draft
October 28, 2026 20:22
haiyanmeng
force-pushed
the
doc-control-plane
branch
4 times, most recently
from
October 29, 2026 13:41
e3f4920 to
73a5e35
Compare
haiyanmeng
marked this pull request as ready for review
October 29, 2026 13:43
haiyanmeng
added
kind/docs
haiyanmeng
requested review from
Julian Gutierrez Oschmann (juli4n) and
Luiz Oliveira (laoj2)
October 29, 2026 13:43
Several control-plane docs and the kubectl-ate reference still described earlier field names, empty-atespace rules, and older CLI columns and flags. Update them to match the current implementation: - docs/reference/glossary.md: list Tag as a record, and note that deleting an atespace requires its actors, actor templates, and tags to be gone. - docs/reference/api-guide.md: fix durableSnapshot.state, document deletion checks on CreateActor and UpdateActor, and add GetWorker and ListWorkerActorAssignments. - docs/api-style-guide.md: rename source_snapshot_tag to source_tag. - docs/guides/authorization.md: note that CreateActor skips can_use_tag when sourceTag is omitted. - docs/reference/kubectl-ate.md: document --preview, --sandbox-class, top workers, current get worker and get actor columns, template removal before deleting an atespace, and automatic upload on create tag. Signed-off-by: Haiyan Meng <[email protected]>
haiyanmeng
force-pushed
the
doc-control-plane
branch
from
October 30, 2026 13:35
73a5e35 to
8e59935
Compare
Luiz Oliveira (laoj2)
approved these changes
Oct 30, 2026
Luiz Oliveira (laoj2)
enabled auto-merge
October 30, 2026 13:57
github-merge-queue
Bot
removed this pull request from the merge queue due to failed status checks
Oct 30, 2026
1 of 2 tasks
Dmitry Berkovich (dberkov)
pushed a commit
that referenced
this pull request
Nov 2, 2026
Several control-plane docs and the `kubectl-ate` reference still described earlier field names (`durableSnapshot.status`, `source_snapshot_tag`), empty-atespace rules, and older CLI columns and flags. Updates them to match the current implementation: - `docs/reference/glossary.md`: lists `Tag` under control-plane records, and notes that deleting an atespace requires its actors, actor templates, and tags to be gone. - `docs/reference/api-guide.md`: fixes `durableSnapshot.state`, documents deletion checks on `CreateActor` and `UpdateActor`, and adds `GetWorker` and `ListWorkerActorAssignments`. - `docs/api-style-guide.md`: renames `source_snapshot_tag` to `source_tag`. - `docs/guides/authorization.md`: `CreateActor` skips `can_use_tag` when `sourceTag` is omitted. - `docs/reference/kubectl-ate.md`: documents `--preview`, `--sandbox-class`, `top workers`, the current `get worker` and `get actor` columns, template removal before `delete atespace`, and automatic snapshot upload on `create tag`. AI use: AI-assisted to audit control-plane docs against the codebase and draft the documentation updates. I reviewed and verified the changes. - [x] Tests pass - [x] Docs updated Signed-off-by: Haiyan Meng <[email protected]> (cherry picked from commit f475d8b) Signed-off-by: Eitan Yarmush <[email protected]>
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.
Several control-plane docs and the
kubectl-atereference still described earlier field names (durableSnapshot.status,source_snapshot_tag), empty-atespace rules, and older CLI columns and flags.Updates them to match the current implementation:
docs/reference/glossary.md: listsTagunder control-plane records, and notes that deleting an atespace requires its actors, actor templates, and tags to be gone.docs/reference/api-guide.md: fixesdurableSnapshot.state, documents deletion checks onCreateActorandUpdateActor, and addsGetWorkerandListWorkerActorAssignments.docs/api-style-guide.md: renamessource_snapshot_tagtosource_tag.docs/guides/authorization.md:CreateActorskipscan_use_tagwhensourceTagis omitted.docs/reference/kubectl-ate.md: documents--preview,--sandbox-class,top workers, the currentget workerandget actorcolumns, template removal beforedelete atespace, and automatic snapshot upload oncreate tag.AI use: AI-assisted to audit control-plane docs against the codebase and draft the documentation updates. I reviewed and verified the changes.