Except for the JavaScript SDKs, all other documentation was migrated as-is. However, this necessitated updating the initially created structure for the Layout and Step components to accommodate the diverse range of documentation. As a result, the structure became complex and confusing, contradicting our goal of maintaining simplicity and user-friendliness for non-developers.
The objective of this task is to thoroughly review all documentation, even those not frequently used, and streamline their content under the structured headings of 'Install,' 'Configure,' and 'Verify' and in the optional heading 'Next Steps'.
If there is critical information essential for new users to get on board, we can include it under the new 'Notes' section. However, the onboarding documentation should strictly focus on the basics to help users get started. All advanced configurations shall be available in the complete documentation displayed on the sentry-docs website.
Additionally, please use this opportunity to update code snippets and copies as needed. If a "Verify" step is not yet available, kindly include it in the documentation.
Project Board
A progress overview of all SDKs can be found on our project board.
Description
We've successfully migrated all the getting-started docs from sentry-docs to the main sentry repository, refer to the initiative https://github.com/getsentry/sentry/issues/48144 for more details.
Except for the JavaScript SDKs, all other documentation was migrated as-is. However, this necessitated updating the initially created structure for the Layout and Step components to accommodate the diverse range of documentation. As a result, the structure became complex and confusing, contradicting our goal of maintaining simplicity and user-friendliness for non-developers.
The objective of this task is to thoroughly review all documentation, even those not frequently used, and streamline their content under the structured headings of 'Install,' 'Configure,' and 'Verify' and in the optional heading 'Next Steps'.
If there is critical information essential for new users to get on board, we can include it under the new 'Notes' section. However, the onboarding documentation should strictly focus on the basics to help users get started. All advanced configurations shall be available in the complete documentation displayed on the sentry-docs website.
Additionally, please use this opportunity to update code snippets and copies as needed. If a "Verify" step is not yet available, kindly include it in the documentation.
Note: A guide was recently added to our "Frontendend Handbook" to help you to add and update getting started docs in sentry's main repository 😉 -> https://develop.sentry.dev/frontend/working-on-getting-started-docs/
Slack-Channel
discuss-onboarding
Notion Document(s)
[EPIC] Setup Docs Refactor Move Docs to Sentry Repository - RFC Setup Docs Refactor Initiative - Notion Doc (Sorry employees only)
Stakeholder(s)
@matejminar @ale-cota @smeubank @stephanie-anderson @kahest
Team(s)
Telemetry Experience Team Mobile Team Backend SDK Team Frontend SDK Team