debops
different levels of roles
As newbie user I lost orientation when refering to the roles of debobs quite often.
When you look at the left sidebar on http://docs.debops.org/en/latest/index.html you will see more than a dozen links to roles on the top level (docuwiki, dovecote, fail2ban). So I think: The sidebar holds a collection of roles that (I think) come with debops.
But wait, there are some other roles that seem to be missing? nginx? mysql? I know I had seen them before? Solution? Well, there is one page "Ansible roles provided in DebOps" http://docs.debops.org/en/latest/ansible/roles/index.html that will list a bunch of "other" roles.
Maybe this happens because "ansible-*/docs/index" is included twice on different levels? https://raw.githubusercontent.com/debops/docs/master/docs/index.rst https://raw.githubusercontent.com/debops/docs/master/docs/ansible/roles/index.rst
The pages in "Ansible roles provided by DebOps" subsection were generated once by scraping the defaults files and are basically not updated anymore. The new documentation in separate sections is done using git submodules that grab the latest version of a given role, and then yaml2rst script is used by Sphinx to scrap the current contents of defaults files and incorporate them in the documentation. That way the defaults can be kept up to date.
This will be fixed over time when more and more roles are converted to this new style of documentation. Right now I suggest that if you see the role in its own section, you can read that, but if it's not there, it's better to look at the role files directly for current defaults.
Well, I understand there is a process of migration in managing the documentation. But the source of the documentation is rather irrelevant when reading it. ;)
I know fully understand the organisation of the documentation and my summary is like this:
- The documentation of the roles ist in the process of being migrated from the docs-repo to the individual ansible-XXX roles repos
- https://raw.githubusercontent.com/debops/docs/master/docs/ansible/roles/index.rst currently contains the full list of roles. Mind the sorting!!!! As it includes documentation from different sources the roles are not sorted all the way, use
<strg+f>in case you look for a certain role. - Roles that got the documentation already migrated to the roles repo are listed also in the sidebar on the left
You can also use the search field at the top of the page to look for specific roles / variables.
things can be so simple, once you know how to use them.
<knock head on table />
Thx.
@t3dev I do you one better - if you use Chrome, after visiting the site, try to open docs.debops.org in the address bar, you should get a notification that you can search on the site. Press Tab, and you can enter a string and after you press enter you will be sent automatically to the search page. :-)
for some reason or another, works on docs.typo3.org but not on docs.debops.org I use chromium with pretty strict domain based javascript rules