Project: Update Getting Started docs for enhanced simplicity

[priscilawebdev]

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 getsentry/sentry#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/

Tasks

Preview Give feedback

1. Streamline and align the "Getting Started" docs to fit in the new structure sentry-python#2292
   Component: Docs Enhancement +2
   
2. Streamline and align the "Getting Started" docs to fit in the new structure sentry-react-native#3228
   Platform: React-Native +1
3. Streamline and align the "Getting Started" docs to fit in the new structure sentry-dotnet#2532
   1 of 4
   Documentation Feature +2
4. Streamline and align the "Getting Started" docs to fit in the new structure sentry-go#688
   Status: Backlog +1
5. Streamline and align the "Getting Started" docs to fit in the new structure sentry-cocoa#3205
   Platform: Cocoa Type: Enhancement Type: Feature Request +3
6. Streamline and align the "Getting Started" docs to fit in the new structure sentry-kotlin-multiplatform#111
   Platform: KMP Type: Feature Request +2
7. Streamline and align the "Getting Started" docs to fit in the new structure sentry-unity#1415
   Documentation +1
8. Streamline and align the "Getting Started" docs to fit in the new structure sentry-unreal#345
   Feature +1
9. Streamline and align the "Getting Started" docs to fit in the new structure sentry-rust#602
   +0
10. Streamline and align the "Getting Started" docs to fit in the new structure sentry-clj#57
    +0
11. Streamline and align the "Getting Started" docs to fit in the new structure sentry-javascript#8735
    Type: Improvement +1
12. Streamline and align the "Getting Started" docs to fit in the new structure sentry-php#1579
    +0
13. Streamline and align the "Getting Started" docs to fit in the new structure sentry-java#2884
    Platform: Android Platform: Java +2
14. Streamline and align the "Getting Started" docs to fit in the new structure sentry-java#2885
    Platform: Java +1
    
15. Streamline and align the "Getting Started" docs to fit in the new structure sentry-ruby#2085
    enhancement +1
16. Streamline and align the "Getting Started" docs to fit in the new structure sentry-laravel#760
    Type: Documentation +1
17. Streamline and align the "Getting Started" docs to fit in the new structure sentry-elixir#586
    Area: Documentation Type: Enhancement +2
    
18. Streamline and align the "Getting Started" docs to fit in the new structure sentry-capacitor#433
    Platform: Capacitor Status: Backlog +2
    
19. Streamline and align the "Getting Started" docs to fit in the new structure sentry-dart#1585
    Platform: Dart enhancement +2
    
20. Streamline and align the "Getting Started" docs to fit in the new structure sentry-symfony#752
    +0
21. Streamline and align the "Getting Started" docs to fit in the new structure sentry-native#869
    +0
    
22. Streamline and align the "Getting Started" docs to fit in the new structure sentry-cordova#315
    Platform: Cordova Status: Backlog +2
    

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