docs: use version placeholders in installation guidance #518
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the documentation to use version placeholders instead of hardcoded version numbers in installation instructions. This prevents the documentation from becoming outdated when new releases are published.
Changes:
- Replaced hardcoded version
v0.40.0with placeholdervX.Y.Zthroughout installation and Docker documentation - Added instructional notes to replace placeholders with the actual latest release tag
- Updated Docker image tag examples to use consistent placeholder format including release candidate notation
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/installation.md | Replaced hardcoded v0.40.0 with vX.Y.Z placeholders in download URLs and Docker examples, added note about replacing placeholders |
| docs/docker.md | Updated Docker image tag table to use vX.Y.Z placeholders and added note about replacing placeholders |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| ```dockerfile | ||
| ARG CONFD_VERSION=0.40.0 | ||
| ARG CONFD_VERSION=X.Y.Z |
There was a problem hiding this comment.
The CONFD_VERSION should include the 'v' prefix to match the URL pattern used in line 74 which references 'v${CONFD_VERSION}'. Without the 'v' prefix, the download URL will be malformed. Change to 'vX.Y.Z' for consistency.
| | `v0.40.0-amd64` | Architecture-specific (amd64) | | ||
| | `v0.40.0-arm64` | Architecture-specific (arm64) | | ||
| | `vX.Y.Z` | Specific version | | ||
| | `vX.Y.Z-rc.N` | Release candidate | |
There was a problem hiding this comment.
The placeholder 'N' for the release candidate number is inconsistent with the 'X.Y.Z' pattern used elsewhere. Consider using a more descriptive placeholder like 'vX.Y.Z-rc.1' to provide a concrete example, similar to how specific architecture suffixes are shown.
| | `vX.Y.Z-rc.N` | Release candidate | | |
| | `vX.Y.Z-rc.1` | Release candidate | |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #518 +/- ##
==========================================
+ Coverage 62.30% 62.36% +0.05%
==========================================
Files 48 48
Lines 5420 5420
==========================================
+ Hits 3377 3380 +3
+ Misses 1834 1831 -3
Partials 209 209 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
1 participant
Summary\n- replace hardcoded version tags with vX.Y.Z placeholders in installation and Docker docs\n- add notes to swap placeholders for the latest release tag\n\nCloses #515.