Every interface defined by a charm should be documented with examples

[Dustin Kirkland ]

As a charm author, the pre-built ecosystem of existing charms is quite appealing. I found myself in need of a reverseproxy server, and was pleased to see that I could use either haproxy or squid-reverseproxy in front of my charm.

However, I was quite disappointed (frustrated) when I realized that the website interface exposed by squid-reverseproxy was very poorly documented and lacked an good examples.

I'd recommend that any and all high quality charm store charms should clearly document with good examples any interfaces that are provided, such that downstream charm writers have a good guide to operate by. This will improve the charm developer experience.