Skip to content

docs(flags): add index flag docs for python #11879

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.

Sign up for GitHub

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

Jump to bottom
Closed
wants to merge 6 commits into from
Closed

docs(flags): add index flag docs for python #11879

wants to merge 6 commits into from

Conversation

michellewzhang
Copy link
Member

@michellewzhang michellewzhang commented Nov 19, 2024 •
edited
Loading

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/

figjam ref mapping out the docs

localhost_3000_platforms_python_feature-flags_ (1)

@vercel Vercel
Copy link

vercel bot commented Nov 19, 2024 •
edited
Loading

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 30, 2024 9:21pm
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Nov 30, 2024 9:21pm
develop-docs ⬜️ Ignored (Inspect) Visit Preview Nov 30, 2024 9:21pm

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

codecov bot commented Nov 19, 2024 •
edited
Loading

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%) ⬇️

@michellewzhang michellewzhang mentioned this pull request Nov 19, 2024
Merged
2 tasks
ryan953
ryan953 reviewed Nov 20, 2024
View reviewed changes
docs/platforms/python/feature-flags/index.mdx Outdated
---
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 •
edited
Loading

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 •
edited
Loading

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

coolguyzone
coolguyzone approved these changes Nov 20, 2024
View reviewed changes
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

This comment was marked as outdated.

Sign in to view
@michellewzhang michellewzhang mentioned this pull request Nov 27, 2024
Closed
jas-kas
jas-kas approved these changes Nov 29, 2024
View reviewed changes
Copy link
Member

@jas-kas jas-kas left a comment

Choose a reason for hiding this comment

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

Same feedback as what's on #11971 :)

@cmanallen
Copy link
Member

@michellewzhang Simplifying the language here to focus on short exposition and explanation of enabling the feature set. I'm doing the same for the Javascript PR and more shift more of the exposition burden onto the consolidated product docs page.

@ryan953
Copy link
Member

ryan953 commented Dec 2, 2024

Looks like this got pulled into the big docs PR here: https://github.com/getsentry/sentry-docs/pull/12005/files#diff-92bc49d4e80dcc25621cfea3389eea5cb6d268e5cdd9d7674a87e18933a8e7c7

closing this so we can focus there.

@ryan953 ryan953 closed this Dec 2, 2024
@github-actions github-actions bot locked and limited conversation to collaborators Dec 18, 2024
@michellewzhang michellewzhang deleted the mz/python-main branch March 17, 2025 17:32
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

@ryan953 ryan953 ryan953 approved these changes

@coolguyzone coolguyzone coolguyzone approved these changes

@jas-kas jas-kas jas-kas approved these changes

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

5 participants

@michellewzhang @ryan953 @cmanallen @coolguyzone @jas-kas