Skip to content

[RAPTOR-17801] docs: add dr artifact and dr workload command reference#576

Open
wojtekwdr wants to merge 1 commit into
datarobot-oss:mainfrom
wojtekwdr:RAPTOR-17801_dr_artifact_dr_workload_docs
Open

[RAPTOR-17801] docs: add dr artifact and dr workload command reference#576
wojtekwdr wants to merge 1 commit into
datarobot-oss:mainfrom
wojtekwdr:RAPTOR-17801_dr_artifact_dr_workload_docs

Conversation

@wojtekwdr

@wojtekwdr wojtekwdr commented Jun 16, 2026

Copy link
Copy Markdown
Contributor

RATIONALE

The dr artifact and dr workload command groups had no user-facing documentation. This adds their command-reference pages so users can discover and use them.

CHANGES

  • Add docs/commands/artifact.md: reference for the dr artifact group: the draft-to-locked lifecycle (create / get / list / lock / delete), build (create / get / list / logs), and code (init / sync / versions / checkout, backed by the .wapi/ state dir).
  • Add docs/commands/workload.md: reference for the dr workload group (create / get / list / delete / start / stop / status / endpoint / logs), including the async status lifecycle and the artifact-to-workload relationship.
  • Both pages follow the existing pipeline.md structure: synopsis, description, command-groups table with endpoints, per-subcommand usage and flags, examples, and an error-handling table.
  • Link both from docs/commands/README.md (main commands table, command tree, and command details).
  • The pages are left out of the mkdocs.yml nav while both groups remain gated behind DATAROBOT_CLI_FEATURE_WORKLOAD.

TESTING

  • markdownlint-cli2 reports no errors on the two new pages.
  • mkdocs build succeeds; all cross-links resolve and the pages render.

PR Automation

Comment-Commands: Trigger CI by commenting on the PR:

  • /trigger-smoke-test or /trigger-test-smoke - Run smoke tests
  • /trigger-install-test or /trigger-test-install - Run installation tests

Labels: Apply labels to trigger workflows:

  • run-smoke-tests or go - Run smoke tests on demand (only works for non-forked PRs)

Important

For Forked PRs: The run-smoke-tests label won't work. A required Smoke Tests check will block merge until a maintainer acts:

  • A maintainer uses /approve-smoke-tests to run smoke tests (results will set the check)
  • A maintainer uses /skip-smoke-tests to bypass the check without running tests

Please 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 artifact and dr workload (alias wl) groups, which previously had no dedicated docs.

docs/commands/artifact.md documents the draft→locked artifact lifecycle, build subcommands, and code sync via .wapi/, aligned with the existing pipeline.md layout (synopsis, API mapping tables, flags, examples, HTTP error table).

docs/commands/workload.md covers deploy/operate flows (async status, endpoint / logs for scripting), with the same structure.

docs/commands/README.md is 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.

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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant