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(flags): add index flag docs for python #11879

Open
wants to merge 2 commits into
base: master
Choose a base branch
from

Conversation

michellewzhang
Copy link
Member

@michellewzhang michellewzhang commented Nov 19, 2024

create a index page for feature flags under the python platform (currently we only have specific instructions under each of the integrations, e.g. https://docs.sentry.io/platforms/python/integrations/openfeature/)

url will be: https://docs.sentry.io/platforms/python/feature-flags/

SCR-20241120-kvol

Copy link

vercel bot commented Nov 19, 2024

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

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 20, 2024 8:15pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Nov 20, 2024 8:15pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Nov 20, 2024 8:15pm

@michellewzhang michellewzhang requested review from a team November 19, 2024 23:29
Copy link

codecov bot commented Nov 19, 2024

Bundle Report

Changes will increase total bundle size by 165 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 8.6MB 171 bytes (0.0%) ⬆️
sentry-docs-client-array-push 8.94MB 6 bytes (-0.0%) ⬇️

---
title: Set Up Feature Flags
sidebar_order: 5200
description: "Learn how to enable Feature Flags in your app if it is not already set up."
Copy link
Member

Choose a reason for hiding this comment

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

I wanna point out early and often that we should be clear what kind of feature-flag debugging experience this is talking about. "enable Feature Flags" could easily also be interpreted as "i want to setup open feature for the first time" which is not quite the same.

This is the SDK setup... so we should say something specific like 'feature flag evaluation tracking' or something like that, and if there's a similar page 'feature flag change/definition setup (by provider)' page we could link to that from here.

Copy link
Member Author

@michellewzhang michellewzhang Nov 20, 2024

Choose a reason for hiding this comment

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

i don't think we have a PR yet that instructs how to do the feature flag change tracking setup, we should probably make a ticket for that

@ryan953
Copy link
Member

ryan953 commented Nov 20, 2024

something to coordinate merging along with:
#11839
#11837
#11749

Maybe all these need an 'EA' or 'beta' banner along the top then we could start merging now?

@michellewzhang
Copy link
Member Author

michellewzhang commented Nov 20, 2024

something to coordinate merging along with: #11839 #11837 #11749

Maybe all these need an 'EA' or 'beta' banner along the top then we could start merging now?

SCR-20241120-ktoz

added a beta label

Copy link
Contributor

@coolguyzone coolguyzone left a comment

Choose a reason for hiding this comment

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

Thanks for adding! LGTM 🫡

@michellewzhang
Copy link
Member Author

TODO: we should link to the change tracking docs from this index page too.

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.

3 participants