Skip to content

docs: bump v1.5.0 references to v1.5.1#616

Open
yansun1996 wants to merge 2 commits into
ROCm:release-v1.5.1from
yansun1996:docs-bump-helm-install-v1.5.1
Open

docs: bump v1.5.0 references to v1.5.1#616
yansun1996 wants to merge 2 commits into
ROCm:release-v1.5.1from
yansun1996:docs-bump-helm-install-v1.5.1

Conversation

@yansun1996

@yansun1996 yansun1996 commented Jul 25, 2026

Copy link
Copy Markdown
Member

Summary

Several docs on release-v1.5.1 still referenced v1.5.0 in release-pinned version strings while the chart/images ship as v1.5.1. This updates them:

  • Helm install guide (docs/installation/kubernetes-helm.md): helm install --version, chart parameter-table image tags (controller manager + KMM signer/worker/controller), and DeviceConfig device-metrics-exporter examples.
  • Image tags across guides: device-metrics-exporter, device-config-manager, and test-runner in docs/drivers/installation.md, docs/metrics/exporter.md, docs/dcm/*, docs/test/*, and docs/upgrades/componentupgrades.md.
  • Upgrade guide (docs/upgrades/upgrade.md): helm upgrade --version and the --set controllerManager.manager.image.tag example.
  • Developer guide (docs/contributing/developer-guide.md): e2e -operatortag / OPERATOR_TAG build args.

Intentionally left unchanged

  • docs/releasenotes.md — describes the v1.5.0 release specifically.
  • docs/installation/kubernetes-helm.md "Global Image Pull Secrets (v1.5.0+)" note — marks the feature-introduction version.
  • docs/specialized_networks/airgapped-install.md — the e.g., "v1.5.0" comment example (actual value is v1.4.1).

Test plan

  • Docs render correctly (no broken formatting in changed code blocks / table rows)
  • git grep v1.5.0 -- docs/ returns only the intentional exclusions listed above

The Kubernetes (Helm) installation guide still referenced v1.5.0 in the
helm install --version commands, the chart parameter table image tags,
and the DeviceConfig metrics exporter examples, while the chart itself
has been released as v1.5.1. Update these to v1.5.1. The 'v1.5.0+'
feature-availability note for global image pull secrets is left as-is
since it marks when the feature was introduced.
@yansun1996
yansun1996 marked this pull request as ready for review July 25, 2026 08:17
@yansun1996 yansun1996 added the documentation Improvements or additions to documentation label Jul 25, 2026
Update release-pinned version references across the docs that were still
on v1.5.0 while the release branch ships v1.5.1:

- image tags: device-metrics-exporter, device-config-manager, test-runner
  (drivers, metrics, dcm, test, and upgrades guides)
- upgrade guide helm upgrade --version and --set image.tag examples
- developer guide e2e operatortag / OPERATOR_TAG build args

Release notes (which describe the v1.5.0 release specifically) and the
airgapped-install example comment are intentionally left unchanged.
@yansun1996 yansun1996 changed the title docs: bump helm install guide references to v1.5.1 docs: bump v1.5.0 references to v1.5.1 Jul 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant