Skip to content

contributing: update contributing page on how to write quick start guides - #20172

Merged
inventarSarah merged 2 commits into
masterfrom
smi/contributing/quick-start
Nov 2, 2026
Merged

inventarSarah merged 2 commits into
masterfrom
smi/contributing/quick-start

Conversation

@inventarSarah

@inventarSarah inventarSarah commented Oct 22, 2026 •

Copy link
Copy Markdown
Collaborator

DESCRIBE YOUR PR

Updates the page "How to write - Quick Starts" to describe our updated template.
See preview: https://sentry-docs-git-smi-contributingquick-start.sentry.dev/contributing/approach/sdk-docs/write-quick-start/

Closes: #20171

IS YOUR CHANGE URGENT?

Help us prioritize incoming PRs by letting us know when the change needs to go live.
Select exactly one option. For deadlines, replace YYYY-MM-DD with the due date. You can update this information later by editing the PR description.

  • Urgent deadline (GA date, etc.): YYYY-MM-DD
  • Other deadline: YYYY-MM-DD
  • No deadline: 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 supplied a deadline.

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

EXTRA RESOURCES

@vercel

vercel Bot commented Oct 22, 2026 •

Copy link
Copy Markdown

The latest updates on your projects. Learn more about Vercel for GitHub.

Project Deployment Actions Updated
sentry-docs Ready Ready Preview Nov 2, 2026 6:06am UTC
1 Skipped Deployment
Project Deployment Actions Updated
develop-docs Ignored Ignored Preview Nov 2, 2026 6:06am UTC

Request Review

@github-actions github-actions Bot added the Priority: Normal Docs review has no urgent deadline label Oct 22, 2026
@codeowner-assignment
codeowner-assignment Bot requested a review from a team October 22, 2026 11:05
@cursor

cursor Bot commented Oct 22, 2026 •

Copy link
Copy Markdown
Contributor

Services awaiting deployment · Rollout details

Status Service Environment
⚪ Not deployed yet sentry-docs

Mention @rollout in a comment to update the plan.

@coolguyzone coolguyzone left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Looks good, thanks for updating the guide!

@codeowner-assignment
codeowner-assignment Bot requested a review from a team November 2, 2026 05:58
@inventarSarah
inventarSarah force-pushed the smi/contributing/quick-start branch from a5a0bef to cb14eb9 Compare November 2, 2026 05:59
@inventarSarah
inventarSarah merged commit 16f9a4d into master Nov 2, 2026
28 checks passed
@inventarSarah
inventarSarah deleted the smi/contributing/quick-start branch November 2, 2026 06:09
@cursor

cursor Bot commented Nov 2, 2026

Copy link
Copy Markdown
Contributor

Rollouts can't watch this change after it deploys: every data source for this team needs to be signed in again, so a check has no telemetry to read. Sign in to your data sources, or ask a team admin to.

This branch was successfully deployed

1 active deployment
Preview – sentry-docs — cb14eb94 Deployed Nov 2, 2026 by vercel[bot]
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Priority: Normal Docs review has no urgent deadline

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update "How to write - Quick Start"

2 participants