Metadata in README files

Jorge O. Castro jorge at ubuntu.com
Mon Jan 5 17:43:35 UTC 2015


Hi everyone, I hope everyone had a relaxing break!

Someone pinged me about a broken author email address in a charm. The email
address in the charm itself is correct, however there was also an out of
date email address in the README:

https://jujucharms.com/cinder/trusty/

After looking around there's actually a bunch of vestigial metadata in
README files from back when the web UI didn't show any metadata so people
just crammed it into a README.

The web pages now also incorporate the config options as part of the
generated page, along with a file listing, etc. making some sections in
some READMEs redundant.

So the basic message is "the web pages are now showing a bunch of stuff
automatically, next time you're revising a charm just give the metadata a
quick scrub for sanity."

Thanks, let's have a great 2k15!
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/juju/attachments/20150105/d846abb8/attachment.html>


More information about the Juju mailing list