Skip to content

Feat: [demo-feature-banners]: Add demo feature availability banners #8770

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

Draft
wants to merge 9 commits into
base: main
Choose a base branch
from

Conversation

rtblack2701
Copy link

@rtblack2701 rtblack2701 commented May 8, 2025

Description

This PR introduces a reusable featureflag Liquid block plugin that allows documentation writers to indicate feature availability (Enterprise, Cloud, or OSS) and associate version constraints. This improves consistency, reduces duplication, and centralizes formatting for feature-level callouts across the docs.

Authors can now use the following syntax:

{% featureflag availability="enterprise" version="3.5+" %}
Only available in Kong Gateway Enterprise {version} and later.
{% endfeatureflag %}
  • The {version} token is automatically replaced with a clean version string (e.g. 3.5, stripping .x or +).
  • An appropriate icon (🏢, ☁️, 🌱) and label are rendered in a styled block to increase visibility and maintain a consistent tone.
  • Inline badge support was intentionally excluded to keep implementation and visual standards simple.

Why? This provides a scalable, low-maintenance way to mark feature gating across versions or product editions and supports future refactoring or automation efforts.

Preview

CleanShot 2025-05-09 at 01 47 30@2x

Testing instructions

To test:

  1. Add the block to any Markdown file under app/_src/ using the above syntax.
  2. Verify that the rendered output includes:
  • Correct icon and label.
  • Version displayed in parentheses.
  • {version} properly replaced in content.
  • No rendering issues or extra icons.

Copy link

netlify bot commented May 8, 2025

👷 Deploy request for kongdocs pending review.

Visit the deploys page to approve it

Name Link
🔨 Latest commit ba139f6

@rtblack2701 rtblack2701 changed the title feat: [demo-feature-banners]: Add demo feature availability banners Feat: [demo-feature-banners]: Add demo feature availability banners May 8, 2025
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.

1 participant