[RAPTOR-17801] docs: add dr artifact and dr workload command reference#576
Open
wojtekwdr wants to merge 1 commit into
Open
[RAPTOR-17801] docs: add dr artifact and dr workload command reference#576wojtekwdr wants to merge 1 commit into
wojtekwdr wants to merge 1 commit into
Conversation
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.
RATIONALE
The
dr artifactanddr workloadcommand groups had no user-facing documentation. This adds their command-reference pages so users can discover and use them.CHANGES
docs/commands/artifact.md: reference for thedr artifactgroup: the draft-to-locked lifecycle (create/get/list/lock/delete),build(create/get/list/logs), andcode(init/sync/versions/checkout, backed by the.wapi/state dir).docs/commands/workload.md: reference for thedr workloadgroup (create/get/list/delete/start/stop/status/endpoint/logs), including the async status lifecycle and the artifact-to-workload relationship.pipeline.mdstructure: synopsis, description, command-groups table with endpoints, per-subcommand usage and flags, examples, and an error-handling table.docs/commands/README.md(main commands table, command tree, and command details).mkdocs.ymlnav while both groups remain gated behindDATAROBOT_CLI_FEATURE_WORKLOAD.TESTING
markdownlint-cli2reports no errors on the two new pages.mkdocs buildsucceeds; all cross-links resolve and the pages render.PR Automation
Comment-Commands: Trigger CI by commenting on the PR:
/trigger-smoke-testor/trigger-test-smoke- Run smoke tests/trigger-install-testor/trigger-test-install- Run installation testsLabels: Apply labels to trigger workflows:
run-smoke-testsorgo- Run smoke tests on demand (only works for non-forked PRs)Important
For Forked PRs: The
run-smoke-testslabel won't work. A required Smoke Tests check will block merge until a maintainer acts:/approve-smoke-teststo run smoke tests (results will set the check)/skip-smoke-teststo bypass the check without running testsPlease comment requesting a maintainer review if you need smoke tests to run.
Note
Low Risk
Documentation-only changes with no runtime or CLI behavior impact.
Overview
Adds user-facing command reference for the feature-gated
dr artifactanddr workload(aliaswl) groups, which previously had no dedicated docs.docs/commands/artifact.mddocuments the draft→locked artifact lifecycle,buildsubcommands, andcodesync via.wapi/, aligned with the existingpipeline.mdlayout (synopsis, API mapping tables, flags, examples, HTTP error table).docs/commands/workload.mdcovers deploy/operate flows (async status,endpoint/logsfor scripting), with the same structure.docs/commands/README.mdis updated to list both commands in the main table, expand the command tree, and add command-details bullets; the main commands table formatting is widened for alignment.Reviewed by Cursor Bugbot for commit dee5fef. Configure here.