Juju Charm Tools

Provide `juju bundle readme`

Bug #1267611 reported by Jorge Castro
6
This bug affects 1 person
Affects Status Importance Assigned to Milestone
Juju Charm Tools
Triaged
Wishlist
Unassigned
Juju Charm Tools 1.4.0

Bug Description

Similar to proof, it'd be nice to have a way to generate a README.ex with `juju bundle readme` so we have a nice structure for bundles.

Just make a generic template, I'll submit proper text when you're done.

Add generator for bundles

See original description
Revision history for this message
Marco Ceppi (marcoceppi) wrote :

We don't want to add much more overheard to the bundle subcommand since we'll be relinquishing that namespace soon. Would `juju charm readme bundle:<bundle-id>` work instead?

Revision history for this message
Marco Ceppi (marcoceppi) wrote :

Oh, you want to add a generate command, juju charm create readme in other words. We could add this with a -b|--bundle flag

Revision history for this message
Jorge Castro (jorge) wrote :

Whichever format you think works is fine for me. It would be nice to get this before March though so I can start documenting the cool bundles with a README.

When you do this make an empty template, ping me, and I'll provide a readme skeleton.

Marco Ceppi (marcoceppi)
description: updated
Changed in charm-tools:
milestone: none → 1.4.0
status: New → Confirmed
status: Confirmed → Triaged
importance: Undecided → Wishlist
To post a comment you must log in.
This report contains Public information  
Everyone can see this information.
Subscribing...

Other bug subscribers

Remote bug watches

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