Reorganize `develop` docs sidebar #11766

antonpirker · 2024-11-08T09:22:32Z

DESCRIBE YOUR PR

Inspired by #11619 and with the input of @markstory I updated the organization of content in our develop docs.

No content was changed/added, I moved pages around and added a few pages that group existing pages in a better way.

Preview:

https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/getting-started/

TODOs:

Get some feedback
Add redirects when sure that content structure will not change anymore.

(updated) Here a before/after comparison of the develop docs sidebar (miro link):

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.):
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

Sentry Docs contributor guide

vercel · 2024-11-08T09:22:37Z

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

Name	Status	Preview	Comments	Updated (UTC)
develop-docs	✅ Ready (Inspect)	Visit Preview	💬 Add feedback	Nov 16, 2024 11:50am

2 Skipped Deployments

Name	Status	Preview	Comments	Updated (UTC)
changelog	⬜️ Ignored (Inspect)	Visit Preview		Nov 16, 2024 11:50am
sentry-docs	⬜️ Ignored (Inspect)	Visit Preview		Nov 16, 2024 11:50am

codecov · 2024-11-08T09:38:05Z

Bundle Report

Changes will increase total bundle size by 11.02kB (0.06%) ⬆️. This is within the configured threshold ✅

Detailed changes

Bundle name	Size	Change
sentry-docs-server-cjs	8.6MB	5.53kB (0.06%) ⬆️
sentry-docs-edge-server-array-push	339.25kB	5.5kB (1.65%) ⬆️
sentry-docs-client-array-push	8.94MB	6 bytes (-0.0%) ⬇️

lizokm

Thanks for making these updates! They make sense to me :)

develop-docs/architecture/index.mdx

develop-docs/ingestion/index.mdx

Co-authored-by: Liza Mock <[email protected]>

antonpirker · 2024-11-16T11:35:39Z

This is the script to check if all the sidebar items are still on the same url, or redirect somewhere that is not a 404:

import requests


def main():
    urls = [
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/getting-started/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/getting-started/philosophy/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/getting-started/inclusive-language/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/environment/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/environment/ports/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/environment/u2f/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/environment/pycharm/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/commit-messages/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/code-review/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/documentation/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/workflow/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/testing/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/continuous-integration/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/ngrok/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/devservices/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/rust/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/development/analytics/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/application/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/application/architecture/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/application/dynamic-sampling/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/application/dynamic-sampling/the-big-picture/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/application/dynamic-sampling/fidelity-and-biases/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/application/dynamic-sampling/architecture/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/application/dynamic-sampling/outcomes/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/application/feedback-architecture/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/application/control-silo/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/application/cross-region-replication/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/application/cross-region-rpc/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/application/config/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/application/sentry-vs-getsentry/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/frontend/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/frontend/development-server/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/frontend/design-tenets/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/frontend/component-library/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/api/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/api/basics/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/api/design/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/api/concepts/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/api/public/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/api/checklist/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/api/serializers/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/api/design/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/development-server/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/python-dependencies/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/database-migrations/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/feature-flags/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/feature-flags/flagpole/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/feature-flags/options-backed-features/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/options/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/transaction-clustering/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/grouping/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/outboxes/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/issue-platform/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/issue-platform-detectors/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/queue/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/email/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/kafka/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/metrics/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/nodestore/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/digests/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/quotas/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/tsdb/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/pii/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/pii/methods/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/pii/types/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/pii/selectors/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/buffers/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/translations/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/backend/ab-testing/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/sdk/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/sdk/expected-features/rate-limiting/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/relay/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/relay/projectconfig-versioning/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/relay/transaction-span-ratelimits/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/services/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/services/chartcuterie/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/integrations/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/integrations/azuredevops/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/self-hosted/",
        "https://develop-docs-git-antonpirker-develop-docs-sidebar.sentry.dev/self-hosted/geolocation/",
    ]

    for url in urls:
        response = requests.get(url)
        if response.status_code >= 400:
            print(f"{url} - ~~~{response.status_code}~~~")
        else:
            print(f"{url} - OK")


if __name__ == "__main__":
    main()

antonpirker added 7 commits November 7, 2024 17:16

Moved some pages into new Engineering Practices

6721b42

Renamed 'Application' to 'Architecture' and moved pages around in it.

459653e

New page API Server with Developed moved underneath it.

d7318f3

Moved API Development under API Server

58b9df7

Moved Issue Platform under API Server

88798ff

Moved Backend into API Server

de00380

Renamed relay and sdk top level pages

801a0d7

Merge branch 'master' into antonpirker/develop-docs-sidebar

0dc3ce1

vercel bot deployed to Preview – changelog November 8, 2024 09:27 View deployment

vercel bot deployed to Preview – develop-docs November 8, 2024 09:33 View deployment

vercel bot deployed to Preview – sentry-docs November 8, 2024 09:50 View deployment

Made Development top level and named it def infra

b4012f2

vercel bot deployed to Preview – changelog November 8, 2024 11:31 View deployment

vercel bot had a problem deploying to Preview – develop-docs November 8, 2024 11:38 Failure

vercel bot deployed to Preview – sentry-docs November 8, 2024 11:47 View deployment

Added missing files.

424adff

vercel bot deployed to Preview – changelog November 8, 2024 11:50 View deployment

vercel bot deployed to Preview – develop-docs November 8, 2024 11:56 View deployment

lizokm approved these changes Nov 11, 2024

View reviewed changes

develop-docs/architecture/index.mdx Outdated Show resolved Hide resolved

develop-docs/ingestion/index.mdx Outdated Show resolved Hide resolved

Apply suggestions from code review

6c9ea6a

Co-authored-by: Liza Mock <[email protected]>

vercel bot deployed to Preview – develop-docs November 16, 2024 08:30 View deployment

antonpirker added 2 commits November 16, 2024 09:30

Architecture became Application Architecture

bb0f8ff

Merge branch 'master' into antonpirker/develop-docs-sidebar

a9d8594

vercel bot deployed to Preview – changelog November 16, 2024 08:36 View deployment

Cleanup

b3ef168

vercel bot deployed to Preview – develop-docs November 16, 2024 08:55 View deployment

antonpirker marked this pull request as ready for review November 16, 2024 09:03

vercel bot deployed to Preview – sentry-docs November 16, 2024 09:08 View deployment

antonpirker added 2 commits November 16, 2024 10:45

Added redirects

65d65d2

Keep the old url for sdks

d16d6f3

vercel bot deployed to Preview – develop-docs November 16, 2024 10:00 View deployment

vercel bot deployed to Preview – sentry-docs November 16, 2024 10:21 View deployment

Fixed redirects

7f6e4d2

vercel bot deployed to Preview – develop-docs November 16, 2024 10:36 View deployment

More redirect fixes

32c8d0e

vercel bot deployed to Preview – develop-docs November 16, 2024 10:50 View deployment

vercel bot deployed to Preview – sentry-docs November 16, 2024 11:04 View deployment

Fixed link

01f8e53

vercel bot deployed to Preview – develop-docs November 16, 2024 11:50 View deployment

antonpirker merged commit 5bd251a into master Nov 16, 2024
12 checks passed

antonpirker deleted the antonpirker/develop-docs-sidebar branch November 16, 2024 11:56

github-actions bot locked and limited conversation to collaborators Dec 2, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

Reorganize `develop` docs sidebar #11766

Reorganize `develop` docs sidebar #11766

Uh oh!

antonpirker commented Nov 8, 2024 •

edited

Loading

Uh oh!

vercel bot commented Nov 8, 2024 •

edited

Loading

Uh oh!

codecov bot commented Nov 8, 2024 •

edited

Loading

Uh oh!

lizokm left a comment

Uh oh!

Uh oh!

Uh oh!

antonpirker commented Nov 16, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Reorganize develop docs sidebar #11766

Reorganize develop docs sidebar #11766

Uh oh!

Conversation

antonpirker commented Nov 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

DESCRIBE YOUR PR

Preview:

TODOs:

IS YOUR CHANGE URGENT?

SLA

PRE-MERGE CHECKLIST

LEGAL BOILERPLATE

EXTRA RESOURCES

Uh oh!

vercel bot commented Nov 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Nov 8, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Bundle Report

Uh oh!

lizokm left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

antonpirker commented Nov 16, 2024

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Reorganize `develop` docs sidebar #11766

Reorganize `develop` docs sidebar #11766

antonpirker commented Nov 8, 2024 •

edited

Loading

vercel bot commented Nov 8, 2024 •

edited

Loading

codecov bot commented Nov 8, 2024 •

edited

Loading