Skip to content

docs(site): add release announcement banner to landing page - #9948

Open
amarkdotdev wants to merge 1 commit into
envoyproxy:mainfrom
amarkdotdev:docs/6225-release-banner
Open

docs(site): add release announcement banner to landing page#9948
amarkdotdev wants to merge 1 commit into
envoyproxy:mainfrom
amarkdotdev:docs/6225-release-banner

Conversation

@amarkdotdev

Copy link
Copy Markdown
Contributor

Summary

  • Add a dismissible announcement banner component to the docs landing page
  • Banner displays the current release version with a link to GitHub release notes
  • Dismissal state is persisted per version in localStorage

Test plan

  • Build the docs site locally (make docs or hugo server in site/)
  • Verify the banner appears at the top of the landing page
  • Verify the release version and link point to the correct GitHub release
  • Verify the dismiss button hides the banner and persists across page reloads

Fixes #6225

@amarkdotdev
amarkdotdev requested a review from a team as a code owner September 4, 2026 07:36
@netlify

netlify Bot commented Sep 4, 2026

Copy link
Copy Markdown

Deploy Preview for cerulean-figolla-1f9435 ready!

Name Link
🔨 Latest commit b3c5b9c
🔍 Latest deploy log https://app.netlify.com/projects/cerulean-figolla-1f9435/deploys/6a9a7aa7e2c1830008871c4c
😎 Deploy Preview https://deploy-preview-9948--cerulean-figolla-1f9435.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

💡 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".

Comment thread site/content/en/_index.md
no_list: true
---

{{ partial "announcement-banner.html" . }}

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Render the banner through a shortcode or page layout

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">

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Use the complete release tag in the banner URL

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>
@amarkdotdev
amarkdotdev force-pushed the docs/6225-release-banner branch from 2b26abd to b3c5b9c Compare September 4, 2026 08:00
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.

docs: Add release announcement banner to front page

1 participant