Skip to content

Conversation

cmanallen
Copy link
Member

DESCRIBE YOUR PR

Tell us what you're changing and why. If your PR resolves an issue, please link it so it closes automatically.
Simplifies deployment and review by putting all the documentation together in a shared PR.

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.

  • Urgent deadline (GA date, etc.): 2024/12/02
  • Other deadline:
  • None: Not urgent, can wait up to 1 week+

SLA

  • Teamwork makes the dream work, so please add a reviewer to your PRs.
  • Please give the docs team up to 1 week to review your PR unless you've added an urgent due date to it.
    Thanks in advance for your help!

PRE-MERGE CHECKLIST

Make sure you've checked the following before merging your changes:

  • Checked Vercel preview for correctness, including links
  • PR was reviewed and approved by any necessary SMEs (subject matter experts)
  • PR was reviewed and approved by a member of the Sentry docs team

LEGAL BOILERPLATE

Look, I get it. The entity doing business as "Sentry" was incorporated in the State of Delaware in 2015 as Functional Software, Inc. and is gonna need some rights from me in order to utilize my contributions in this here PR. So here's the deal: I retain all rights, title and interest in and to my contributions, and by keeping this boilerplate intact I confirm that Sentry can use, modify, copy, and redistribute my contributions, under Sentry's choice of terms.

EXTRA RESOURCES

cmanallen and others added 30 commits November 6, 2024 13:58
Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
Co-authored-by: Ryan Albrecht <ryan.albrecht@sentry.io>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
Co-authored-by: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com>
Co-authored-by: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com>
Co-authored-by: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
@aliu39 aliu39 removed the request for review from a team December 2, 2024 21:48
@ryan953
Copy link
Member

ryan953 commented Dec 3, 2024

Structurally I think we're set.

Links all look good and work. And the large sections of each page make sense to me in terms of:

  • what content is on each page
  • the sidebar link order and organization (it's messy).

@ryan953
Copy link
Member

ryan953 commented Dec 3, 2024

Everything basically links back to the Home > Product Walkthrough > Explore > FF page, so in my mind that's the starting point

Then you've got the Issues > Issue Details walkthrough page sort of side quest, which links back to explore

Setup wise there are two paths: Eval Tracking & Change Tracking

Eval Tracking:
From the Explore page we link to each SDK landing page: Python & JS. The landing pages also pivot back to explore for Change Tracking.
Then from each landing page we link into the provider specific pages; those provider pages pivot uses back to the Explore page too

Change Tracking:
Just LD change tracking right now, but that page has quick links to the SDK pages for LD. Instead of linking to the Explore page it links to that Issues Details side-quest page.

@cmanallen cmanallen merged commit 8ffac55 into master Dec 3, 2024
11 checks passed
@cmanallen cmanallen deleted the cmanallen/consolidate-ff-docs branch December 3, 2024 17:30
Lms24 pushed a commit that referenced this pull request Dec 13, 2024
* Revert "Remove feature flag documentation from issue details page (#11734)"

This reverts commit 9a7bded.

* Add feature flag documentation to issue-details page

* Fix spelling

Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>

* Add more docs

* Clean up sentence

* Point to 'Change Tracking Integration' heading

* Update docs/product/issues/issue-details/index.mdx

Co-authored-by: Ryan Albrecht <ryan.albrecht@sentry.io>

* Clean up

* Add comma

Co-authored-by: Liza Mock <liza.mock@sentry.io>

* Another comma

Co-authored-by: Liza Mock <liza.mock@sentry.io>

* Fix wording

Co-authored-by: Liza Mock <liza.mock@sentry.io>

* Formatting

Co-authored-by: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com>

* Use correct naming

Co-authored-by: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com>

* Formatting and naming corrections

Co-authored-by: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com>

* Fix wording

Co-authored-by: Liza Mock <liza.mock@sentry.io>

* Clean up redundant documentation

* Add OpenFeature integration docs

* Fix namespacing

* Remove extraneous information

* Remove unused images

* docs(flags): add index flag docs for python

* :add beta label

* docs(flags): add product index page for feature flags

* add link to js

* add info about second step

* new link

* docs(flags): add js index page

* Simplify language specific documentation

* Add prereqs

* Simplify language

* Update instructions

* Add LaunchDarkly documentation

* Misc updates

* Cross link change tracking

* Wording

* De-dupe prerelease alert

* Wording

* Fix urls

* Fix urls

* Remove trailing slash

* Remove trailing slash

* Remove trailing slash

* Add exposition

* Reorganize includes

* Re-word description

* Remove change tracking include

* Use platform-includes rather than regular includes since I can't make the latter work

* Update links

* Wording and styles

* Hard code change tracking documentation

* Reintroduce enable change tracking template

* Wording

* More language

* Wording

* Update version requirement

* Remove closed beta message

* Indent installation instructions

* Add install and configure heading

* Add evaluation tracking note

* Move python after user feedback

* s/LaunchDarkly/OpenFeature

Co-authored-by: Ryan Albrecht <ryan.albrecht@sentry.io>

* Fix link

* Remove options section

* Link directly to the integration

Co-authored-by: Ryan Albrecht <ryan.albrecht@sentry.io>

* Wording

Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

* Capitalization

Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>

* Change order

* Fix commas

* Capitalization

* Remove word

* Wording

* Move feature flags to the bottom

* Remove reference to releases

* Remove redundant link

* Capitalization

* Feedback

* Add next steps include

* Add supported list

* Add DSN to examples

* Remove metrics comment

* Update next-steps text

* Fix casing

* Remove supported section

* Fix nits

* Use correct name

* Use a bullet list

* Remove word

* Ordering

* Link

* Wording

* Wording

* Reword

* Wording

* Add Install, Configure, Verify, and Support Notes section for js integration docs

* [getsentry/action-github-commit] Auto commit

* Revert js change

* Revert yarn

* [getsentry/action-github-commit] Auto commit

* [getsentry/action-github-commit] Auto commit

* Better url

* Wording

* Add notice

* Remove extraneous docs

* Remove extraneous docs

* Add magic url

* Copy

---------

Co-authored-by: Alex Krawiec <alex.krawiec@sentry.io>
Co-authored-by: Ryan Albrecht <ryan.albrecht@sentry.io>
Co-authored-by: Liza Mock <liza.mock@sentry.io>
Co-authored-by: Michelle Zhang <56095982+michellewzhang@users.noreply.github.com>
Co-authored-by: Michelle Zhang <56095982+michellewzhang@users.noreplay.github.com>
Co-authored-by: Jasmin <77064737+jas-kas@users.noreply.github.com>
Co-authored-by: Andrew Liu <159852527+aliu39@users.noreply.github.com>
Co-authored-by: getsantry[bot] <66042841+getsantry[bot]@users.noreply.github.com>
@github-actions github-actions bot locked and limited conversation to collaborators Dec 19, 2024
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants