Skip to content

Conversation

@markstory
Copy link
Member

DESCRIBE YOUR PR

The develop docs organization has grown organically and could benefit from some more cohesive organization. The new top level directories roughly map out to:

  • getting started : for general information on philosophy and inclusive language
  • development : getting sentry working locally, contributing code an working with local development services.
  • application : application design and architecture documentation.
  • frontend : frontend documentation - unchanged
  • backend : I've moved a bunch of documentation here. Previously 'services' was used for both application services and standalone applications (services) that compose sentry. Now backend contains everything you'd find in the python monolith, while 'services' contains standalone applications.
  • services : services we operate that exist outside of the monolith
  • integrations : unchanged
  • sdk : unchanged
  • relay : unchanged

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

@vercel
Copy link

vercel bot commented Oct 19, 2024

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

Name Status Preview Comments Updated (UTC)
changelog ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 23, 2024 7:40pm
develop-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 23, 2024 7:40pm
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Oct 23, 2024 7:40pm

@@ -1,5 +1,6 @@
---
title: Configuration
sidebar_order: 60
Copy link
Member Author

Choose a reason for hiding this comment

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

I spaced most of the pages out by increments of 10 as it was easy to count and left holes for future docs to be added.

@markstory markstory requested review from a team and removed request for a team October 19, 2024 00:48
@markstory markstory requested review from a team October 19, 2024 00:53
Copy link
Contributor

@stephanie-anderson stephanie-anderson left a comment

Choose a reason for hiding this comment

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

Big THANKS for investing some time in improving our develop docs! I noticed that you haven't set up any redirects, could you add them for the pages you've moved?

You can add those to this file:

const developerDocsRedirects = [

In terms of user experience, this feature plays a similar role as [Issue Grouping](/grouping/).
In terms of technical implementation, it is similar to [Data Scrubbing](/pii/).
In terms of user experience, this feature plays a similar role as [Issue Grouping](/backend/grouping/).
In terms of technical implementation, it is similar to [Data
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this new line intentional?

Copy link
Member Author

Choose a reason for hiding this comment

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

Nope, that was a mistake.

@markstory
Copy link
Member Author

I noticed that you haven't set up any redirects, could you add them for the pages you've moved?

Updated! I didn't know there were redirects 😊

@codecov
Copy link

codecov bot commented Oct 23, 2024

Bundle Report

Changes will decrease total bundle size by 348 bytes (-0.0%) ⬇️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 7.37MB 339 bytes (-0.0%) ⬇️
sentry-docs-edge-server-array-push 333.11kB 3 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 6.44MB 6 bytes (-0.0%) ⬇️

Copy link
Contributor

@stephanie-anderson stephanie-anderson left a comment

Choose a reason for hiding this comment

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

looks great! thanks for adding the redirects 🙏

@markstory markstory merged commit 51735ea into master Oct 24, 2024
13 checks passed
@markstory markstory deleted the feat-reorder-sidebar branch October 24, 2024 15:40
@antonpirker antonpirker mentioned this pull request Nov 8, 2024
8 tasks
@github-actions github-actions bot locked and limited conversation to collaborators Nov 9, 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.

3 participants