You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The current experience to add, fetch and render our onboarding docs is very painful because:
It is not easy to see your changes in your local dev environment
To see your changes in production, sentry-docs has to be released
We have hacky CSS to make everything look like Sentry style
If you need to create a document in a format that does not match the defined pattern, the build won’t pass, forcing you to manually update functions in sentry-docs as well as the sentry repository.
These updates are usually conditional on a case-by-case basis and the list can grow very large and this is not scalable.
At our last 2x Frontend TSC meetings we discussed the RFC “Move Docs to Sentry Repository”, coming to the conclusion that we would just like to move the quick start docs to our sentry repository, where we will either continue to use MDX files or just use our own React components
Expected outcome:
Transition the onboarding documentation (quick-start) from the sentry-docs repository to the main sentry repository, starting with JavaScript platforms.
Implement a simple and user-friendly structure that is easy for non-developers to work with (create/update) and understand.
Ensure that the documentation is properly rendered in all onboarding entry points, including in the onboarding for new organizations, and create project UI.
Create a guide for creating and updating onboarding documents in the sentry repository.
Problem:
The current experience to add, fetch and render our onboarding docs is very painful because:
These updates are usually conditional on a case-by-case basis and the list can grow very large and this is not scalable.
Proposed solution:
At our last 2x Frontend TSC meetings we discussed the RFC “Move Docs to Sentry Repository”, coming to the conclusion that we would just like to move the quick start docs to our sentry repository, where we will either continue to use MDX files or just use our own React components
Expected outcome:
Useful Link:
https://github.com/getsentry/rfcs/blob/main/text/0084-move-docs-to-sentry-repository.md
Notion Doc: https://www.notion.so/sentry/Setup-docs-refactor-01ed795a111d43569e3ccebe9def4989
PoC
Gradually migrate "Getting Started" documentation from sentry-docs to sentry's main repository
The text was updated successfully, but these errors were encountered: