docs(site): add release announcement banner to landing page - #9948
amarkdotdev wants to merge 2 commits into
Conversation
✅ Deploy Preview for cerulean-figolla-1f9435 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
![chatgpt-codex-connector[bot]](https://avatars.githubusercontent.com/in/1144995?s=60&v=4){kind=small}
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 2b26abd9a5
ℹ️ About Codex in GitHub
Codex has been enabled to automatically review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
When you sign up for Codex through ChatGPT, Codex can also answer questions or update the PR, like "@codex address that feedback".
| no_list: true | ||
| --- | ||
|
|
||
| {{ partial "announcement-banner.html" . }} |
There was a problem hiding this comment.
Hugo does not evaluate ordinary Go template actions inside Markdown content, so this line is emitted as literal {{ partial "announcement-banner.html" . }} text rather than invoking the partial. Consequently, the landing page displays template syntax and the new banner never renders; expose the partial through a shortcode or include it from the page layout instead.
Useful? React with 👍 / 👎.
| <span class="announcement-title">🎉 New Release Available!</span> | ||
| <span class="announcement-message"> | ||
| Envoy Gateway {{ $latest_version }} is now available with enhanced features and improved performance. | ||
| <a href="{{ $github_repo }}/releases/tag/{{ $latest_version }}" target="_blank" class="announcement-link"> |
There was a problem hiding this comment.
When the banner is rendered, this constructs a link ending in /releases/tag/v1.9 because .Site.Params.version identifies the documentation series, while the repository's v1.9 release announcement records the actual release tag as v1.9.0. The banner's primary “View Release Notes” action therefore points at a nonexistent release instead of the published one; source or configure the full release tag separately.
Useful? React with 👍 / 👎.
Add a dismissible announcement banner on the docs front page that highlights the latest release and links to GitHub release notes. Fixes envoyproxy#6225 Signed-off-by: amarkdotdev <amark@g.jct.ac.il> Signed-off-by: Aaron <amark@g.jct.ac.il>
2b26abd to
b3c5b9c
Compare
|
release announcement banner PR is sitting here waiting on a first review. let me know if anything looks off. |
|
can this be tested / shown using a screenshot or netlify link |
Hugo does not process partial calls in markdown content. Wrap the banner partial in a shortcode so it renders on the landing page. Signed-off-by: Aaron <amark@g.jct.ac.il>
|
@arkodg yeah, Netlify preview is here: https://deploy-preview-9948--cerulean-figolla-1f9435.netlify.app/ I also just pushed a small fix because the banner was showing up as raw template text on the preview. Hugo does not process partials inside markdown, so I wrapped it in a shortcode. Should render correctly on the link above now (purple bar at the top with the v1.9 release note + dismiss button). |
This branch has not been deployed
2 participants
Summary
Test plan
make docsorhugo serverinsite/)Fixes #6225