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

Create "How to write – Quick Start" page #12945

Merged
merged 10 commits into from
Mar 13, 2025

Conversation

inventarSarah
Copy link
Collaborator

DESCRIBE YOUR PR

  • created a new page How to write -- Quick Start
    • informs about the motivation behind the change & differences between a quick start and a getting started guide
    • guides writing QS guides for manual setup and wizard setup
    • reuses some content from the current "How to write -- Getting Started" page
  • updated the "How to write -- Getting Started" page and "SDK Documentation Structure" page
    • helps writers use the right guide for their use case

Relevant issues:

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

Copy link

vercel bot commented Mar 6, 2025

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

Name Status Preview Comments Updated (UTC)
sentry-docs ✅ Ready (Inspect) Visit Preview 💬 Add feedback Mar 13, 2025 9:05am
2 Skipped Deployments
Name Status Preview Comments Updated (UTC)
changelog ⬜️ Ignored (Inspect) Visit Preview Mar 13, 2025 9:05am
develop-docs ⬜️ Ignored (Inspect) Visit Preview Mar 13, 2025 9:05am

Copy link

codecov bot commented Mar 6, 2025

Bundle Report

Changes will increase total bundle size by 201 bytes (0.0%) ⬆️. This is within the configured threshold ✅

Detailed changes
Bundle name Size Change
sentry-docs-server-cjs 10.53MB 207 bytes (0.0%) ⬆️
sentry-docs-client-array-push 9.39MB -6 bytes (-0.0%) ⬇️

Affected Assets, Files, and Routes:

view changes for bundle: sentry-docs-client-array-push

Assets Changed:

Asset Name Size Change Total Size Change (%)
static/chunks/pages/_app-*.js -3 bytes 868.16kB -0.0%
static/chunks/3319-*.js -3 bytes 393.41kB -0.0%
server/middleware-*.js -5.55kB 1.0kB -84.74%
server/middleware-*.js 5.55kB 6.55kB 555.3% ⚠️
static/HKVqXGZMig2e85JgxNpQl/_buildManifest.js (New) 578 bytes 578 bytes 100.0% 🚀
static/HKVqXGZMig2e85JgxNpQl/_ssgManifest.js (New) 77 bytes 77 bytes 100.0% 🚀
static/xXTu2b4SqVpvTXFwgk4b1/_buildManifest.js (Deleted) -578 bytes 0 bytes -100.0% 🗑️
static/xXTu2b4SqVpvTXFwgk4b1/_ssgManifest.js (Deleted) -77 bytes 0 bytes -100.0% 🗑️
view changes for bundle: sentry-docs-server-cjs

Assets Changed:

Asset Name Size Change Total Size Change (%)
1729.js -3 bytes 1.57MB -0.0%
../instrumentation.js -3 bytes 904.32kB -0.0%
9523.js -3 bytes 880.37kB -0.0%
../app/[[...path]]/page.js.nft.json 72 bytes 378.49kB 0.02%
../app/platform-redirect/page.js.nft.json 72 bytes 378.41kB 0.02%
../app/sitemap.xml/route.js.nft.json 72 bytes 376.38kB 0.02%

- Achieve a functional Sentry setup with visible results in a customer's Sentry project
- Serve as the basis for further customization

## config.yml
Copy link
Contributor

@coolguyzone coolguyzone Mar 6, 2025

Choose a reason for hiding this comment

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

This transition feels a little abrupt, how about giving a little context to what this file is and why we are setting it up? For example something like:

Structuring the config.yml File

The config.yml file provides SDK-level details such as the support level and device categories . . . This file resides in the . . .

1. New users lack the context that our Docs provide (think of it this way, there's no left-hand sidebar to review).
2. Experienced users likely have alerts and so forth turned off, so don't expect one clear workflow. Also, don't review the workflow. Point users to the product for a tour.

As a result, a simple copy/paste of the Quick Start won't suffice. See the JavaScript wizard as an example.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
As a result, a simple copy/paste of the Quick Start won't suffice. See the JavaScript wizard as an example.
As a result, a simple copy/paste of the Quick Start won't suffice. See the JavaScript wizard as an example.
Suggested change
As a result, a simple copy/paste of the Quick Start won't suffice. See the JavaScript wizard as an example.
As a result, a simple copy/paste of the Quick Start won't suffice. See the Next.js wizard as an example.

Not sure if you wanted to link this one?

Copy link
Collaborator Author

@inventarSarah inventarSarah Mar 13, 2025

Choose a reason for hiding this comment

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

@inventarSarah inventarSarah merged commit 950f7b3 into master Mar 13, 2025
11 checks passed
@inventarSarah inventarSarah deleted the smi/contributing/how-to-qs-guide branch March 13, 2025 09:08
@github-actions github-actions bot locked and limited conversation to collaborators Mar 29, 2025
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