sentry-docs icon indicating copy to clipboard operation
sentry-docs copied to clipboard

Turn repeated thread locality content into an include

Open coolguyzone opened this issue 1 year ago • 3 comments

DESCRIBE YOUR PR

Turn a piece of content that's repeated 3 times into an include that can be managed in one place.

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:
  • [X] 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

coolguyzone avatar Oct 11 '24 22:10 coolguyzone

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

Name Status Preview Comments Updated (UTC)
changelog ❌ Failed (Inspect) Nov 7, 2024 10:46am
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Nov 7, 2024 10:46am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
develop-docs ⬜️ Ignored (Inspect) Visit Preview Nov 7, 2024 10:46am

vercel[bot] avatar Oct 11 '24 22:10 vercel[bot]

Hey @jamescrosswell , in reference to your comment here about this content being repeated in 3x places: https://github.com/getsentry/sentry-docs/pull/11426

In this PR I went ahead and refactored them into a markdown Include so it can be managed in one place, please take a look if you're interested in seeing how this works.

coolguyzone avatar Oct 16 '24 00:10 coolguyzone

please take a look if you're interested in seeing how this works.

Ah cool. Thanks @coolguyzone - much appreciated!

jamescrosswell avatar Oct 16 '24 03:10 jamescrosswell

This pull request has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you add the label WIP, I will leave it alone unless WIP is removed ... forever!


"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

getsantry[bot] avatar Nov 07 '24 08:11 getsantry[bot]

Bundle Report

Changes will increase total bundle size by 684 bytes (0.0%) :arrow_up:. This is within the configured threshold :white_check_mark:

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 7.46MB 219 bytes (0.0%) :arrow_up:
sentry-docs-edge-server-array-push 257.07kB 3 bytes (-0.0%) :arrow_down:
sentry-docs-client-array-push 6.43MB 468 bytes (0.01%) :arrow_up:

codecov[bot] avatar Nov 07 '24 10:11 codecov[bot]