teamforus / docs

Main knowledge base of Forus
https://docs.forus.io
4 stars 6 forks source link

technical vs organisation docs on the new website #22

Closed danrminds closed 5 years ago

danrminds commented 6 years ago

Problem

We have currently 3 types of documentation that we want to feature on the new website

Proposed solution

I propose to separate these a little. First of all would separate the technical documentation (API) in a different URL - develop.forus.io / dev.forus.io instead of the same docs.forus.io. This documentation is meant for developers only or organisations that want to use our public and open source development to implement it separately. This has nothing to do with the organisational documentation we feature now on the docs.forus.io (vision, etc).

Possible additions

About internal and public organisational documentation - I want to see if github can show the private repositories if you are logged in on github in the same browser. More research here needed.

maxvisser commented 6 years ago

I was also thinking about this. I thought docs.forus.io should be the technical website. and foundation.forus.io the organisational website.

We can start just putting all the documentation, technical and organisational, in docs and after that show them seperately on different websites. I personally really like it that all of the documentation is in one place here on github.

jamalv commented 6 years ago

Agreed, and indeed, lets first not worry about this separation too much and create the content first.

For the urls, I would propose something like about.forus.io and docs.forus.io

About the internal docs, we now have https://docs-internal.forus.io which is linked to a private repo on our GitHub.

maxvisser commented 5 years ago

I think until we have content for the technical docs we can close this one and iterate on docs.forus.io first.