Documentation improvements needed

Bug #1383510 reported by Johannes Ernst
This bug affects 6 people
Affects Status Importance Assigned to Milestone
Fix Released

Bug Description

1. Modules section is entirely empty.

2. There's no "how to invoke" documentation. From the Arch Linux package, I can see that the following all appear to be valid invocations:

    cloud-init modules --mode=config
    cloud-init modules --mode=final
    cloud-init init --local
    cloud-init init

But what might they all do?

Tags: docs

Related branches

Revision history for this message
Matej Susta (matej-susta) wrote :

This is probably the biggest PITA of whole cloud-init. I'm amazed that nobody cared enough to put at least a bit of a documentation out in the world. No wonder people are angry about this project, geez. Not everybody wants to read the code to understand how it's working...
I'll try to do some basic documentation for most of the modules. Once it gets there it should automatically pop up in RTD by the include (automodule) in doc/rtd/topics/modules.rst.

tags: added: documentation
Changed in cloud-init:
assignee: nobody → Matej Susta (matej-susta)
status: New → Confirmed
Revision history for this message
Joshua Powers (powersj) wrote :

The read-the-docs has been up and updated after each merge to master. I will continue to track the lack of a man page.

Changed in cloud-init:
assignee: Matej Susta (matej-susta) → Joshua Powers (powersj)
importance: Undecided → Medium
Joshua Powers (powersj)
Changed in cloud-init:
status: Confirmed → In Progress
do3meli (d-info-e)
tags: added: docs
removed: documentation
Revision history for this message
Joshua Powers (powersj) wrote :
Revision history for this message
Joshua Powers (powersj) wrote :

Merged, changing to fix committed.

Thanks again for calling out the lack of documentation. If you have additional concerns please feel free to file additional bugs.

Changed in cloud-init:
status: In Progress → Fix Committed
assignee: Joshua Powers (powersj) → nobody
Brett Holman (holmanb)
Changed in cloud-init:
status: Fix Committed → Fix Released
Revision history for this message
James Falcon (falcojr) wrote :
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.

Duplicates of this bug

Other bug subscribers

Remote bug watches

Bug watches keep track of this bug in other bug trackers.