Create "How to write – Quick Start" page #12945
Open
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
The latest updates on your projects. Learn more about Vercel for Git ↗︎
2 Skipped Deployments
|
Bundle ReportChanges will increase total bundle size by 201 bytes (0.0%) ⬆️. This is within the configured threshold ✅ Detailed changes
Affected Assets, Files, and Routes:view changes for bundle: sentry-docs-server-cjsAssets Changed:
view changes for bundle: sentry-docs-client-array-pushAssets Changed:
|
coolguyzone
reviewed
Mar 6, 2025
|
|
||
| A single, critical page. | ||
|
|
||
| **[How to Write - Getting Started](/contributing/approach/write-getting-started)** | ||
| For new SDKs and updated guides, use: | ||
| **[How to Write - Quick Start](/contributing/approach/write-quick-start)** |
There was a problem hiding this comment.
Suggested change
| **[How to Write - Quick Start](/contributing/approach/write-quick-start)** | |
| **[How to Write - Quick Start](/contributing/approach/sdk-docs/write-quick-start/)** |
coolguyzone
reviewed
Mar 6, 2025
| sidebar_order: 25 | ||
| --- | ||
|
|
||
| We're transitioning from [Getting Started guides](/contributing/approach/sdk-docs/write-getting-started/) to Quick Start Guides. New SDKs should use the Quick Start guide format outlined on this page. This change is still in progress, so you may still encounter "Getting Started" guides in existing SDKs. |
There was a problem hiding this comment.
Suggested change
| We're transitioning from [Getting Started guides](/contributing/approach/sdk-docs/write-getting-started/) to Quick Start Guides. New SDKs should use the Quick Start guide format outlined on this page. This change is still in progress, so you may still encounter "Getting Started" guides in existing SDKs. | |
| We're transitioning from [Getting Started guides](/contributing/approach/sdk-docs/write-getting-started/) to Quick Start Guides. New SDKs should use the Quick Start guide format outlined on this page. This change is still in progress, so you may still encounter Getting Started guides for existing SDKs. |
coolguyzone
reviewed
Mar 6, 2025
| We're transitioning from [Getting Started guides](/contributing/approach/sdk-docs/write-getting-started/) to Quick Start Guides. New SDKs should use the Quick Start guide format outlined on this page. This change is still in progress, so you may still encounter "Getting Started" guides in existing SDKs. | ||
|
|
||
| <Alert type="info" title="Note"> | ||
| For existing Getting Started guides, refer to [How to Write - Getting |
There was a problem hiding this comment.
Suggested change
| For existing Getting Started guides, refer to [How to Write - Getting | |
| If you want to update an existing Getting Started Guide without refactoring it into a Quick Start guide, see [How to Write - Getting |
coolguyzone
reviewed
Mar 6, 2025
|
|
||
| <Alert type="info" title="Note"> | ||
| For existing Getting Started guides, refer to [How to Write - Getting | ||
| Started](/contributing/approach/sdk-docs/write-getting-started/). For example, |
There was a problem hiding this comment.
Suggested change
| Started](/contributing/approach/sdk-docs/write-getting-started/). For example, | |
| Started](/contributing/approach/sdk-docs/write-getting-started/). |
coolguyzone
reviewed
Mar 6, 2025
| <Alert type="info" title="Note"> | ||
| For existing Getting Started guides, refer to [How to Write - Getting | ||
| Started](/contributing/approach/sdk-docs/write-getting-started/). For example, | ||
| when you want to update a guide without changing it into a Quick Start guide. |
There was a problem hiding this comment.
Suggested change
| when you want to update a guide without changing it into a Quick Start guide. |
coolguyzone
reviewed
Mar 6, 2025
| Started](/contributing/approach/sdk-docs/write-getting-started/). For example, | ||
| when you want to update a guide without changing it into a Quick Start guide. | ||
| If you're unsure what kind of guide you're looking at, ask a question by | ||
| opening an issue in GitHub. |
There was a problem hiding this comment.
Suggested change
| opening an issue in GitHub. | |
| [opening an issue in GitHub](https://github.com/getsentry/sentry-docs/issues/new/choose). |
coolguyzone
reviewed
Mar 6, 2025
| </Alert> | ||
|
|
||
| <Expandable type="info" title="Why the change?"> | ||
| This change stems from our commitment to following best practices in documentation and making it easier for everyone to create and use our guides. |
There was a problem hiding this comment.
Suggested change
| This change stems from our commitment to following best practices in documentation and making it easier for everyone to create and use our guides. | |
| This change stems from our commitment to following best practices and making our docs as accessible as possible. |
coolguyzone
reviewed
Mar 6, 2025
| <Expandable type="info" title="Why the change?"> | ||
| This change stems from our commitment to following best practices in documentation and making it easier for everyone to create and use our guides. | ||
|
|
||
| With the new Quick Start guides, we want to provide a more structured and focused approach, helping writers create valuable content with confidence, ultimately assisting customers in reaching their goals with Sentry. |
There was a problem hiding this comment.
Suggested change
| With the new Quick Start guides, we want to provide a more structured and focused approach, helping writers create valuable content with confidence, ultimately assisting customers in reaching their goals with Sentry. | |
| With the new Quick Start guides, we want to provide a more structured and focused approach, helping writers create valuable content with confidence, ultimately assisting users in reaching their goals with Sentry. |
coolguyzone
reviewed
Mar 6, 2025
| | | Quick Start | Getting Started | | ||
| | -------- | ----------------------------------------------------------------------------------- | --------------------------------------------------------------------- | | ||
| | **Focus** | Goal-oriented, immediate action, minimal steps | Learning-oriented, broader concepts, background information | | ||
| | **Content** | Describes critical steps and doesn't explain much about how and why | More explanatory and provides background information | |
There was a problem hiding this comment.
Suggested change
| | **Content** | Describes critical steps and doesn't explain much about how and why | More explanatory and provides background information | | |
| | **Content** | Highlights critical steps with less focus on the how and why | More explanatory and provides background information | |
coolguyzone
reviewed
Mar 6, 2025
|
|
||
| Our Quick Start guides aim to: | ||
|
|
||
| - Enable developer to quickly set up Sentry with features such as Error Monitoring, Tracing, and Session Replay |
There was a problem hiding this comment.
Suggested change
| - Enable developer to quickly set up Sentry with features such as Error Monitoring, Tracing, and Session Replay | |
| - Enable developers to quickly onboard Sentry with features such as Error Monitoring, Tracing, and Session Replay |
coolguyzone
reviewed
Mar 6, 2025
| - Enable developer to quickly set up Sentry with features such as Error Monitoring, Tracing, and Session Replay | ||
| - Keep instructions concise by avoiding unnecessary explanations or background information | ||
| - Focus on action by including code examples and commands | ||
| - Achieve a functional Sentry setup with visible results in a customer's Sentry project |
There was a problem hiding this comment.
Suggested change
| - Achieve a functional Sentry setup with visible results in a customer's Sentry project | |
| - Achieve a functional Sentry setup with visible results in a user's Sentry project |
coolguyzone
reviewed
Mar 6, 2025
| - Achieve a functional Sentry setup with visible results in a customer's Sentry project | ||
| - Serve as the basis for further customization | ||
|
|
||
| ## config.yml |
There was a problem hiding this comment.
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 . . .
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
DESCRIBE YOUR PR
Relevant issues:
IS YOUR CHANGE URGENT?
Help us prioritize incoming PRs by letting us know when the change needs to go live.
SLA
Thanks in advance for your help!
PRE-MERGE CHECKLIST
Make sure you've checked the following before merging your changes:
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