Skip to content

docs: add 0.1.0 upgrade guide outline - #3540

Merged
drew merged 11 commits into
mainfrom
codex/3063-upgrade-guide
Sep 23, 2026
Merged

drew merged 11 commits into
mainfrom
codex/3063-upgrade-guide

Conversation

@drew

@drew drew commented Sep 22, 2026 •

Copy link
Copy Markdown
Collaborator

Summary

Add a concise, audience-based outline for the OpenShell 0.1.0 upgrade guide. The page separates operator actions from end-user changes and stays intentionally brief while the remaining 0.1.0 work lands.

Related Issue

Related to #3063. This draft establishes the guide structure and breaking-change inventory; the remaining definition of done stays open for final release validation and expansion.

Changes

  • Add the 0.1.0 guide with separate operator and end-user sections.
  • Summarize the reviewed breaking changes with focused migration examples and links to canonical references.
  • Link every migration item to its defining PR and identify contracts that are still open.
  • Cover external-resource admission, authenticated compute-driver runtime identity, and durable exec launch admission.
  • Update workload-image, watch-stream, endpoint-policy, and interactive-exec guidance to match contracts now on main.
  • Add an Upgrade section below Security in the docs navigation.
  • Add a 0.1.0 announcement and upgrade-guide link to the Overview page.
  • Remove the standalone Release Notes page and point the README status badge to GitHub Releases.
  • Mark the guide as a working outline while targeted changes remain in flight.

Testing

  • mise run pre-commit passes
  • mise run docs passes
  • Unit tests added/updated (not applicable; docs-only change)
  • E2E tests added/updated (not applicable; docs-only change)

Checklist

  • Follows Conventional Commits
  • Commits are signed off (DCO)
  • Architecture docs updated (not applicable; docs-only change)

@copy-pr-bot

copy-pr-bot Bot commented Sep 22, 2026

Copy link
Copy Markdown

Auto-sync is disabled for draft pull requests in this repository. Workflows must be run manually.

Contributors can view more details about this message here.

@github-actions

Copy link
Copy Markdown

Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
@drew
drew force-pushed the codex/3063-upgrade-guide branch from fb09bdb to 12555f7 Compare September 23, 2026 16:46
@drew
drew marked this pull request as ready for review September 23, 2026 16:48
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
Signed-off-by: Drew Newberry <anewberry@nvidia.com>
@drew
drew added this pull request to the merge queue Sep 23, 2026
Merged via the queue into main with commit a649aa4 Sep 23, 2026
72 checks passed
@drew
drew deleted the codex/3063-upgrade-guide branch September 23, 2026 20:37
pimlock added a commit that referenced this pull request Sep 23, 2026
Port the documentation changes from PR #3075 onto PR #3540, retain newer middleware contract guidance, and register the new guides in the docs navigation.

Signed-off-by: Piotr Mlocek <pmlocek@nvidia.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants