Please add informations in /doc/README,

Bug #1088101 reported by Charles Plessy
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
cloud-init
Fix Released
Low
Unassigned

Bug Description

Hello,

there was a discussion about cloud-init on the « debian-cloud » mailing list, and one of the outcome was to suggest to add more documentation on how to use cloud-init in /doc/README, which is installed as « /usr/share/doc/cloud-init/README » on Debian systems and is therefore one of the first files one will read to better learn how to use cloud-init.

https://lists.debian.org/debian-cloud/2012/12/msg00049.html

In particular, the following information was suggested :

> The way to use it without EC2 or OpenStack is documented in
> doc/sources/nocloud/README
>
> Basically, you put meta-data into
> /var/lib/cloud/seed/nocloud/meta-data. This is described in
> doc/examples/seed/. This file is where you set things like hostname and
> install authorized_keys.
>
> Then to do further system configuration a cloud-config stanza goes in
> /var/lib/cloud/seed/nocloud/user-data
>
> The capabilities of cloud-config are best discovered in
> doc/examples/cloud-config.txt

Have a nice Sunday,

--
Charles Plessy
Tsurumi, Kanagawa, Japan

Tags: docs
Revision history for this message
Joshua Harlow (harlowja) wrote :

I've been working on http://cloud-init.readthedocs.org/, hopefully this can be the code-driven site that I want it to be (derived from docs in the cloud-init docs folder...)

Scott Moser (smoser)
Changed in cloud-init:
status: New → Triaged
importance: Undecided → Low
Revision history for this message
Joshua Harlow (harlowja) wrote :

Sorry, that moved to http://cloudinit.readthedocs.org/en/latest/ after I broke the other url :-P

do3meli (d-info-e)
tags: added: docs
Revision history for this message
Joshua Powers (powersj) wrote :

As Josh points out above we have online documentation available at: http://cloudinit.readthedocs.org/en/latest/

And we now have a manpage that is in tree and ready to be picked up by packagers.

I am going to mark this as fix-commited and you can re-open if those options are not sufficient.

Changed in cloud-init:
status: Triaged → Fix Committed
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.

Other bug subscribers

Remote bug watches

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