Is there a plan for documenting features, how might one help with this?

[bassistcz]

Hi,
Is there work planned for developing the documentation for molecule further, I think this is a great tool, but it's not always easy to find out information on what you need. Recently I was trying to get docker containers networked and set their IP address, and only figured it out my stumbling on a issue ticket that linked to merge request that pointed me in the right direction, and then some thankfully very useful error messages that got me there in the end.
But I can't find any documentation how to do this or covering all the options available for the modules required.
Would love to help out in this and add what I learn as I go through things, so that others can make fuller use of the tool and to have source that I can reference myself. How might I and others who are interested help out with documentation for molecule?

[bassistcz]

Or are we meant to be reliant on the ansible documentation?

[tadeboro]

The documentation situation is relatively poor at the moment. The main reason for this is the separation of drivers from the core engine. When we migrated individual drivers to their packages, the embedded documentation moved with the code but was no longer rendered.

So the first step towards a better set of documents would be to get the individual driver documentation back online. I am not sure how exactly the publishing process would look like, but I would assume that if we host the docs on the readthedocs site, the publishing process should not be too complicated.

In parallel with this, we can also start adding scenario documentation. This is where things you just described would go. I will try to contact some people on IRC next week and try to start moving things.

[bassistcz]

Thanks for the reply, it's good to know that documentation exist, and hopefully you can get this moving forward.

[MLNW]

I recently started a new project and stumbled upon Antora which allows rendering documentation from different branches and repositories within a single instance.
It sounds like something you could use when the documentation already exists but is distributed in multiple repositories.