Skip to content

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

Merged
merged 3 commits into from
Apr 11, 2025
Merged

docs: add tips for /latest #5688

merged 3 commits into from
Apr 11, 2025

Conversation

zirain
Copy link
Member

@zirain zirain commented Apr 8, 2025

image

@zirain zirain requested a review from a team as a code owner April 8, 2025 07:05
Copy link

codecov bot commented Apr 8, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 65.25%. Comparing base (fd09db2) to head (d8f6470).
Report is 9 commits behind head on main.

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.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

<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.
Copy link
Member

@zhaohuabing zhaohuabing Apr 8, 2025

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.

Copy link
Member Author

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.

Copy link
Member

@zhaohuabing zhaohuabing Apr 8, 2025

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.

Copy link
Contributor

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image A little too much?

Copy link
Contributor

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.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

updated

@zirain zirain force-pushed the docs-latest-tips branch from c55d1b0 to 83ab724 Compare April 9, 2025 14:13
zirain added 3 commits April 10, 2025 07:21
Signed-off-by: zirain <[email protected]>
Signed-off-by: zirain <[email protected]>
@zirain zirain force-pushed the docs-latest-tips branch from 83ab724 to d8f6470 Compare April 9, 2025 23:21
@zirain zirain requested review from zhaohuabing and arkodg April 9, 2025 23:34
Copy link
Contributor

@arkodg arkodg left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

thanks !

@arkodg arkodg merged commit 266a1aa into envoyproxy:main Apr 11, 2025
28 checks passed
@zirain zirain deleted the docs-latest-tips branch April 11, 2025 01:20
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.

3 participants