Skip to content

Add dynamic annoucement banner for live docs#4673

Merged
k8s-ci-robot merged 1 commit intokubernetes-sigs:mainfrom
shraddhabang:dynbanner
Apr 7, 2026
Merged

Add dynamic annoucement banner for live docs#4673
k8s-ci-robot merged 1 commit intokubernetes-sigs:mainfrom
shraddhabang:dynbanner

Conversation

@shraddhabang
Copy link
Copy Markdown
Collaborator

Added a client-side announcement banner to the docs site that dynamically fetches open GitHub issues labeled announcement and displays them below the navigation tabs. This lets maintainers notify users about known issues and workarounds without rebuilding or redeploying the docs — just create an issue with the announcement label and it appears on the site; close it and it disappears.

The banner is collapsible (collapsed by default) with a summary line, and sticky so it stays visible while scrolling. If the GitHub API call fails or there are no matching issues, nothing renders.

Files added/changed:

  • announcements.js — fetches issues via GitHub REST API and renders the banner
  • announcements.css — styling for the sticky collapsible banner
  • main.html — wires up the assets and places the banner div below the nav tabs
image

Checklist

  • Added tests that cover your change (if possible)
  • Added/modified documentation as required (such as the README.md, or the docs directory)
  • Manually tested
  • Made sure the title of the PR is a good description that can go into the release notes

BONUS POINTS checklist: complete for good vibes and maybe prizes?! 🤯

  • Backfilled missing tests for code in same general area 🎉
  • Refactored something and made the world a better place 🌟

@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Apr 7, 2026
@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Apr 7, 2026
Copy link
Copy Markdown
Collaborator

@zac-nixon zac-nixon left a comment

Choose a reason for hiding this comment

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

/lgtm
/approved

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Apr 7, 2026
@k8s-ci-robot
Copy link
Copy Markdown
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: shraddhabang, wweiwei-li, zac-nixon

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Details Needs approval from an approver in each of these files:
  • OWNERS [shraddhabang,wweiwei-li,zac-nixon]

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@k8s-ci-robot k8s-ci-robot merged commit cd4514c into kubernetes-sigs:main Apr 7, 2026
9 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. lgtm "Looks good to me", indicates that a PR is ready to be merged. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants