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

[EPIC] Setup Docs Refactor #48144

Closed
26 tasks done
matejminar opened this issue Apr 28, 2023 · 0 comments
Closed
26 tasks done

[EPIC] Setup Docs Refactor #48144

matejminar opened this issue Apr 28, 2023 · 0 comments
Assignees

Comments

@matejminar
Copy link
Member

matejminar commented Apr 28, 2023

Problem:

The current experience to add, fetch and render our onboarding docs is very painful because:

  1. It is not easy to see your changes in your local dev environment
  2. To see your changes in production, sentry-docs has to be released
  3. We have hacky CSS to make everything look like Sentry style
  4. 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.
  5. To provide a dynamic code snippet experience it is necessary to replicate the same document in the docs. See Onboarding wizard for errors + replay + performance sentry-docs#6633

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:

  • 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.

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

  1. Status: Stale
    priscilawebdev
  2. priscilawebdev

Gradually migrate "Getting Started" documentation from sentry-docs to sentry's main repository

  1. 1 of 1
    romtsn
  2. 3 of 3
    romtsn
  3. 1 of 1
    priscilawebdev
  4. 1 of 1
    priscilawebdev
  5. 1 of 1
    romtsn
  6. 10 of 10
    priscilawebdev
  7. 1 of 1
    Lms24
  8. 1 of 1
    priscilawebdev
  9. 1 of 1
    romtsn
  10. 1 of 1
    priscilawebdev
  11. 1 of 1
    priscilawebdev
  12. 5 of 5
    priscilawebdev
  13. 10 of 10
    priscilawebdev
  14. 1 of 1
    priscilawebdev
  15. 1 of 1
    priscilawebdev
  16. 2 of 2
    priscilawebdev
  17. 8 of 8
    Lms24 stephanie-anderson
  18. 3 of 3
    priscilawebdev
  19. 20 of 20
    priscilawebdev
  20. 1 of 1
    priscilawebdev
  21. 3 of 3
    priscilawebdev
  22. 1 of 1
    priscilawebdev
  23. 1 of 1
    priscilawebdev
  24. 1 of 1
    priscilawebdev
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
Archived in project
Development

No branches or pull requests

2 participants