← Back to team overview

yahoo-eng-team team mailing list archive

[Bug 1876333] [NEW] Documentation: Add boot stage of execution to each module documentation

 

Public bug reported:

As a newcomer to cloud-init, the module documentation has been extremely
helpful in laying out the options I can utilize. However, I often have
to ask myself if i need to do something as a runcmd script rather than
utilize a module, since the documentation doesn't clarify what boot
stage (or stages as I've come to find out) a particular module is
executed in.

Proposal:

Right after the summary of each module in the documentation, add a "Boot
stages:" section.

I think this will also help reinforce the concept of the 5 boot stages
of cloud-init to newcomers, and that will indirectly make it easier to
entice new contributors.

** Affects: cloud-init
     Importance: Undecided
         Status: New


** Tags: docs

-- 
You received this bug notification because you are a member of Yahoo!
Engineering Team, which is subscribed to cloud-init.
https://bugs.launchpad.net/bugs/1876333

Title:
  Documentation: Add boot stage of execution to each module
  documentation

Status in cloud-init:
  New

Bug description:
  As a newcomer to cloud-init, the module documentation has been
  extremely helpful in laying out the options I can utilize. However, I
  often have to ask myself if i need to do something as a runcmd script
  rather than utilize a module, since the documentation doesn't clarify
  what boot stage (or stages as I've come to find out) a particular
  module is executed in.

  Proposal:

  Right after the summary of each module in the documentation, add a
  "Boot stages:" section.

  I think this will also help reinforce the concept of the 5 boot stages
  of cloud-init to newcomers, and that will indirectly make it easier to
  entice new contributors.

To manage notifications about this bug go to:
https://bugs.launchpad.net/cloud-init/+bug/1876333/+subscriptions


Follow ups