-
Notifications
You must be signed in to change notification settings - Fork 437
docs: add tips for /latest #5688
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
zirain
commented
Apr 8, 2025

Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #5688 +/- ##
==========================================
- Coverage 65.27% 65.25% -0.03%
==========================================
Files 213 213
Lines 34108 34108
==========================================
- Hits 22264 22256 -8
- Misses 10505 10511 +6
- Partials 1339 1341 +2 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
<div class="alert alert-warning"> | ||
Notice: This is pre-release documentation. | ||
<br /> | ||
Please refer to the <a href="{{ $latest_version | safeURL }}" target="_blank">/docs</a> documentation for the most current information. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Nice!
Can we show the exact version here to avoid confusion?
For example:
Notice: This is pre-release documentation, corresponding to the latest Envoy Gateway image: envoyproxy/gateway-dev:latest.
Please refer to /docs for the documentation of the stable release, v1.3.2.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
we can, but that's another story, should be in another PR.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I meant that the current statement is not clear enough. "most current information" is kind of vague.
"Please refer to /docs for the documentation of the latest release." is better, but the word "latest" could be misleading.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the "latest" release of Envoy Gateway, which contains the most recent commits from the main branch. This release **might not be stable**.
It is only intended for users wishing to try out the latest features in Envoy Gateway, some of which may not be fully implemented. Please refer to /docs for the documentation of the current stable release.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
if too much lets delete It is only intended for users wishing to try out the latest features in Envoy Gateway, some of which may not be fully implemented.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
Signed-off-by: zirain <[email protected]>
Signed-off-by: zirain <[email protected]>
Signed-off-by: zirain <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
thanks !