Plugins documentation

Development
1

Hello,

documentation for all our plugins is spread all over the github. We
currently keep the documentation in separate README files for most of
our plugins.

I would like to start moving documentation to some place. Now the
question I want to discuss is where to put it. The obvious place would
be:

http://theforeman.org/manuals/1.7/index.html#6.Plugins

If there are no objections, I am going to start on new subchapter 6.3
Foreman Discovery with the following structure:

6.3 Foreman Discovery
6.3.1 About

  • possible subchapters with description
    6.3.2 Installation
    6.3.3 Configuration
    6.3.4 Upgrade
    6.3.5 Release Notes

I would like Discovery to be blueprint for other plugins.

What you think?

··· -- Later, Lukas #lzap Zapletal
1 Like
2

I'd like to see plugin docs, but they shouldn't be in the main manual,
as versioning isn't the same as Foreman.

Stephen had a go at adding separate documents here, which I think was
the right direction: https://github.com/theforeman/theforeman.org/pull/257

(We hit a technical obstacle of the dropdown submenu not working on
mobile browsers… while the website is pretty bad on mobile, it was a
step backwards.)

It'd be good to continue that work, adding per-plugin docs and probably
a documentation landing page or something instead of a submenu, which
could link to the versions of the Foreman manual, the wiki, the plugin
docs etc.

··· On 07/01/15 10:36, Lukas Zapletal wrote: > Hello, > > documentation for all our plugins is spread all over the github. We > currently keep the documentation in separate README files for most of > our plugins. > > I would like to start moving documentation to some place. Now the > question I want to discuss is where to put it. The obvious place would > be: > > http://theforeman.org/manuals/1.7/index.html#6.Plugins > > If there are no objections, I am going to start on new subchapter 6.3 > Foreman Discovery with the following structure: > > 6.3 Foreman Discovery > 6.3.1 About > - possible subchapters with description > 6.3.2 Installation > 6.3.3 Configuration > 6.3.4 Upgrade > 6.3.5 Release Notes > > I would like Discovery to be blueprint for other plugins.

–
Dominic Cleal
Red Hat Engineering