Skip to content
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

docs(Overview & FAQs page) Feature flag update #4259

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

Kritvi-bhatia17
Copy link
Contributor

@Kritvi-bhatia17 Kritvi-bhatia17 commented Sep 12, 2024

Closes #3975

Short description

General guidance on feature flags has been added to the documentation in the following locations on our website:

  1. Components > Overview page > Components tab
  2. Components > Overview page > Feature flags tab (newly created page)
  3. Help > FAQs

Changelog

NEW

Components > Overview page > Components tab

  1. Added medium-sized feature flag tags to the following component cards that have the feature flag property:
    Menu buttons, Modal, Notification, Structured list, Tile, Treeview
  • ⭐️ REQUIRED CODE REVIEW

    image

Components > Overview page > Feature flag tab

  1. Created a new tab under Components > Overview called "Feature flags", and for the content, please refer to the Figma file or this issue #3975.

Help > FAQs

  1. Added 2 more questions: (Figma file for reference)
  • "What are feature flags? Where do I find them?"
  • "What are experimental components? Where do I find them?"

CHANGED

Help > FAQs

  1. Update the copy for one of the questions:
    From: "Where do I find the Experimental components and patterns?"
    To: "Where do I find the community assets?"

Copy link

vercel bot commented Sep 12, 2024

The latest updates on your projects. Learn more about Vercel for Git ↗︎

Name Status Preview Comments Updated (UTC)
carbondesignsystem ✅ Ready (Inspect) Visit Preview 💬 Add feedback Sep 24, 2024 2:46pm

Copy link
Member

@alisonjoseph alisonjoseph left a comment

Choose a reason for hiding this comment

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

This approach works, however instead of storing the data in this file I would probably recommend updating the data/components.json file with something like this

{
  "component": "Tile",
  "featureFlag": true,
  "testing": {
    "screenreader": "manual"
  }
},

That way all the data is in one place.
and then filter based on that.

@Kritvi-bhatia17
Copy link
Contributor Author

updating the data/components.json

Hi @alisonjoseph, thanks for the review. I've updated the data/components.json as suggested.

I have a quick question: In the Menu button components, the Overflow menu, which is a variant of Menu buttons, has a feature flag, but it doesn't appear in the overview card view. Should I add "featureFlag": true for the Overflow menu as well, like this:

{
  "component": "Overflow menu",
  "parentComponent": "Menu buttons",
  "featureFlag": true,
  "overview": false,
  "testing": {
  "screenreader": "manual"
  } 
},

Or should I leave it as is for now? Here’s a screenshot for reference of what is currently in the code:

Screenshot 2024-09-13 at 2 55 28 PM

Copy link
Member

@laurenmrice laurenmrice left a comment

Choose a reason for hiding this comment

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

Looks good Kritvi! Just a couple things:

src/pages/components/overview/feature-flags.mdx Outdated Show resolved Hide resolved
src/pages/components/overview/feature-flags.mdx Outdated Show resolved Hide resolved
src/pages/components/overview/feature-flags.mdx Outdated Show resolved Hide resolved
src/pages/help/faq/index.mdx Outdated Show resolved Hide resolved
src/pages/help/faq/index.mdx Show resolved Hide resolved
@Kritvi-bhatia17 Kritvi-bhatia17 changed the title Added feature flag guidance to Overview & FAQs pages docs(Overview & FAQs page) Feature flag update Sep 24, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[Feature Flags] Add guidance to Overview Components tab, Feature flag tab, and FAQs page
3 participants