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

Link GitHub Repositories in develop docs #12131

Open
antonpirker opened this issue Dec 16, 2024 · 0 comments
Open

Link GitHub Repositories in develop docs #12131

antonpirker opened this issue Dec 16, 2024 · 0 comments

Comments

@antonpirker
Copy link
Member

Which section?

All top level sections

Page URL

https://develop.sentry.dev/getting-started/

Description

All the top level sections (Application Architecture, Infrastructure, API Server, Frontend, Services, Integrations, Ingestion, SDKs, Self-Hosted Sentry) should include a section in the index file that lists all related github repositories to that section.

This will help new hires to get an overview of all the important repositories and also surface repos not known to the wider engineering population (like platformicons or static pages).

Suggested Solution

This can be done either by

  • making sure all repositories have the top level section set as an "topic" in Github. Then adding a component to the docs that can list repositories of a given topic.
  • making use of the service registry: https://github.com/getsentry/service-registry
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

1 participant