Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: Mention developer docs in Contributing #12101

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

philipphofmann
Copy link
Member

@philipphofmann philipphofmann commented Dec 12, 2024

DESCRIBE YOUR PR

It took me quite a while to figure out how to run the developer docs locally. I would expect that info also in the Contributing.md.

Explain how to start the dev server for the developer docs in the Contributing.md and not just the environment.mdx.

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

Explain how to start the dev server for the developer docs in the
Contributing.md and not just the environment.mdx.
Copy link

vercel bot commented Dec 12, 2024

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 Dec 12, 2024 9:03am
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Dec 12, 2024 9:03am
1 Skipped Deployment
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Dec 12, 2024 9:03am

@philipphofmann philipphofmann requested a review from a team December 12, 2024 08:52
Copy link

codecov bot commented Dec 12, 2024

Bundle Report

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

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.34MB 9 bytes (-0.0%) ⬇️
sentry-docs-client-array-push 9.27MB 6 bytes (-0.0%) ⬇️

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant