writing a charm documentation page references README file without example or enough info to write one
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
pyjuju |
Triaged
|
Low
|
Unassigned |
Bug Description
The writing a charm documentation page references a README file, but provides no example or information on what the content should be. In addition, the examples folder in the trunk doesn't contain a README file for any of the example charms. I've read this section several times and I have no idea what should go in this README file.
Here's the text:
First create a README file with your text editor. This file must be plain text, the Charm Store will parse Markdown or RST format and display it on the Charm Store's web interface, so it will be the public facing page for your charm. We recommend you leave basic usage instructions on how to use your charm in the README. Now let's make the metadata:
Changed in juju: | |
status: | In Progress → Triaged |
importance: | Undecided → Low |
assignee: | Matthew Fischer (mfisch) → nobody |
I should note that there is a README in precise/examples, but there's nothing in that file that a charm writer should have to write, it's a general README.