website icon indicating copy to clipboard operation
website copied to clipboard

Look into using docsy and docs.gitpod.io for documentation

Open mrzarquon opened this issue 3 years ago • 2 comments

Currently docs are a subsection of the Gitpod website and a part of the same repository, meaning a change to documentation requires a change to the entire website.

Moving docs to their own domain and repo means the review process can be optimized for technical content and information.

Docsy is a common platform used for this. Many opensource projects use a docsy system and so would be familiar to users of other opensource projects.

mrzarquon avatar Jun 22 '22 08:06 mrzarquon

One consideration / benefit of coupling these two is that we do get link validation between pages, which is super helpful, and quite easy to break. Wonder if there would be some way to retain that if broken down.

loujaybee avatar Jun 23 '22 15:06 loujaybee

Thanks for bringing this up. 🙏 We've discussed that in our docs-sync and decided to postpone that decision, due to other priority things, that are going on currently. I'll leave that issue open though, to not lose track of it. We'll come back to it later

Cahllagerfeld avatar Jun 29 '22 16:06 Cahllagerfeld

We have the docs.gitpod.io . No Plans for Docsy Implementation.

Siddhant-K-code avatar Oct 07 '22 15:10 Siddhant-K-code