docs icon indicating copy to clipboard operation
docs copied to clipboard

Where to put contrib docu?

Open htgoebel opened this issue 9 years ago • 3 comments

E.g. the Readme of debops-contrib/ansible-lam says, "http://docs.debops.org/en/latest/ansible/roles/ansible-lam/docs/", which does not exists. Where as foodsoft points to http://docs.debops.org/en/latest/ansible/roles/ansible-contrib-foodsoft/docs, which does not exist either.

What about setting up a doc repo for debops-contrib? Or provide an example resp. template for generating pre-contrib-project docs?

htgoebel avatar Feb 20 '16 10:02 htgoebel

Good question. I would suggest that we set up a second https://github.com/debops-contrib/docs which can work the same way as https://github.com/debops/docs does.

ypid avatar Feb 20 '16 10:02 ypid

Contrib roles can be added to https://github.com/debops-contrib/docs in the usual way as known from https://github.com/debops/docs.

Todo:

  • [x] Read the docs: https://debops-contrib.readthedocs.io/en/latest/
  • [x] Travis CI: https://debops-contrib.readthedocs.io/en/latest/
  • [ ] Setup canonical URL: https://docs.contrib.debops.org/, needs @drybjed
  • [ ] Setup the debops-bot to update the docs as in #125, needs @drybjed
  • [ ] After everything is ready, add a hint in https://docs.debops.org/en/latest/ by merging #236

@htgoebel The stage is yours :wink:

ypid avatar Nov 04 '16 21:11 ypid

@ypid: thanks for all that work. looking forward to add the docs of my roles :smile:

ganto avatar Nov 04 '16 22:11 ganto