Migrate README content to dev docs

getsentry / self-hosted

Sentry, feature-complete and packaged up for low-volume deployments and proofs-of-concept

https://develop.sentry.dev/self-hosted/

Other

7.57k stars 1.72k forks source link

Migrate README content to dev docs #1996

Open chadwhitacre opened 1 year ago

chadwhitacre commented 1 year ago

Silly and confusing to have two sources of truth. Let's consolidate on dev docs.

https://github.com/getsentry/self-hosted#readme ⇒ https://develop.sentry.dev/self-hosted/

github-actions[bot] commented 1 year ago

This issue has gone three weeks without activity. In another week, I will close it.

But! If you comment or otherwise update it, I will reset the clock, and if you label it Status: Backlog or Status: In Progress, I will leave it alone ... forever!

"A weed is but an unloved flower." ― Ella Wheeler Wilcox 🥀

aldy505 commented 1 month ago

Me and @BYK talked about this a while ago on Discord (link https://discord.com/channels/621778831602221064/796028405833007104/1250449735815401704) since we have two docs in which I think people don't really read the docs on the develop website.

So what I wonder about are:

Which part of the self-hosted documentation should we sync, between the develop docs site and the repo's README?
Or.. should we nuke the README on the repository and point people to go to the website? But I don't think this route is a good idea.

cc @hubertdeng123 @azaslavsky

aldy505 commented 1 week ago

Another ping, what do you guys think about that :point_up:? I need your opinions before we actually move forward and clean up current documentation mess @hubertdeng123 @azaslavsky