writing a charm documentation page references README file without example or enough info to write one

Bug #1075763 reported by Matt Fischer
6
This bug affects 1 person
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:

Revision history for this message
Matt Fischer (mfisch) wrote :

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.

summary: writing a charm documentation page references README file without
- example
+ example or enough info to write one
Revision history for this message
Jorge Castro (jorge) wrote :

I think it's probably just best to reference an excellent README, like this one: http://jujucharms.com/charms/precise/wordpress

Revision history for this message
Matt Fischer (mfisch) wrote :

It might be nice to get that README into the examples/precise area in trunk. Is that feasible or should we just link to that URL?

Changed in juju:
status: New → In Progress
assignee: nobody → Matt Fischer (mfisch)
Curtis Hovey (sinzui)
Changed in juju:
status: In Progress → Triaged
importance: Undecided → Low
assignee: Matthew Fischer (mfisch) → nobody
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.