debops / docs

DebOps documentation
MIT License
28 stars 21 forks source link

Links in docs.debops.org often point to github instead of docs.debops.org #280

Open AnBuKu opened 7 years ago

AnBuKu commented 7 years ago

In DebOps documentation links are very often linked to a DebOps page in GitHub. This due to the fact, that they are done via .rst references.

For readers of the docs, this circumstance is rather inconvenient, as then reading the docs and clicking a link to get further information, you are all of a sudden in github, but there is information in the docs.

Example: In https://docs.debops.org/en/latest/ansible/roles/ansible-mosquitto/docs/defaults.html#public-key-infrastructure, debops.pki links to https://github.com/debops/ansible-pki but imho should link to https://docs.debops.org/en/latest/ansible/roles/ansible-pki/docs/index.html

ypid commented 7 years ago

Currently done because when you are in the docs, there is no way back :)

Depends on: https://github.com/debops/docs/issues/212