Published Charm using rst README #313

Open
bertjwregeer opened this Issue Jul 19, 2016 · 3 comments

Comments

Projects
None yet
3 participants

I've published a Charm using an rst README and it is not being rendered correctly:

https://jujucharms.com/u/bertjwregeer/staticroutes

The documentation mentions that both markdown and rst formatted README files are acceptable.

Please see https://gitlab.com/bertjwregeer/juju_staticroutes for how it should be rendered.

Here is the documentation that states rst is acceptable: https://jujucharms.com/docs/devel/authors-charm-policy#readme.md

Thanks,
Bert JW Regeer

@bertjwregeer bertjwregeer referenced this issue in juju/charmstore Jul 19, 2016

Open

Published Charm using rst README #661

@marcoceppi - Yep, we have a mismatch in what the store accepts vs what our docs state to be true (which was at one point and time). It appears RST was dropped from the supported list. Do we need to poke the store display/API to support RST, or do we deprecate the RST support?

I much prefer rst over markdown... but to each their own :-)

Do note that just doing a quick search for README.rst with "JuJu charm" in Google shows that there are quite a lot of Charms using rst formatted README files.

@frankban frankban added the enhancement label Mar 3, 2017

@frankban frankban added this to the future milestone Mar 3, 2017

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment