Best way to put images in a Charm's readme?

[Merlijn Sebrechts]

Thanks!


Adding that support to the Charm store also seems like the best solution to
me. Relative links are supported in the markdown syntax, and seem to work
in a lot of places. They also work in the Atom markdown preview, for
example.

I think I'll wait for support in jujucharms.com and use absolute urls in
the meantime.



Kind regards
Merlijn

2016-12-09 7:33 GMT-05:00 Marco Ceppi <marco.ceppi at canonical.com>:

> This is an interesting idea. In the past I've uploaded images and gifs to
> things like imgur for hosting. Github does a lot of extra mark-down
> processing (even beyond GFM) like munging image paths. I thinks it's
> entirely possible that our charm store also do some smart post processing
> to produce relative paths that map files/documentation/add-vpn.png to
> https://api.jujucharms.com/charmstore/v5/~tengu-bot/
> openvpn-5/archive/files/documentation/add-vpn.png
>
> I'll file a bug here: https://github.com/CanonicalLtd/jujucharms.com/
> issues to track this.
>
> On Fri, Dec 9, 2016 at 2:15 AM Junaid Ali <junaidali at plumgrid.com> wrote:
>
>> Merlijin,
>> In your readme.md, can you specify URL for the images like L17 in this
>> readme
>> <http://bazaar.launchpad.net/~ya-bo-ng/landscape-charm/readme-with-image/view/head:/README.md>
>> file? It will work in your case.
>>
>> Thanks,
>> - Junaid
>>
>> On Fri, Dec 9, 2016 at 12:01 PM, Junaid Ali <junaidali at plumgrid.com>
>> wrote:
>>
>> Merlijin,
>> It seems that readme in charm store expects images to be in
>> https://jujucharms.com/u/<user-name>/<charm-name>/files/documentation/.
>> I'm also not sure how to add that.
>>
>> Thanks,
>> - Junaid
>>
>> On Fri, Dec 9, 2016 at 8:06 AM, Merlijn Sebrechts <
>> merlijn.sebrechts at gmail.com> wrote:
>>
>> Hi all
>>
>>
>> I have this beautiful picture tutorial in the README of my openvpn charm.
>> The images are stored as part of the Charm. This looks great on github
>> <https://github.com/IBCNServices/tengu-charms/tree/openvpn/charms/builds/openvpn#connecting-to-the-vpn>,
>> where relative urls work. But this is completely broken in the charm
>> store <https://jujucharms.com/u/tengu-bot/openvpn/5>.
>>
>> What's the best way to include pictures in a Charm's readme?
>>
>>
>>
>> Kind regards
>> Merlijn
>>
>> --
>> Juju mailing list
>> Juju at lists.ubuntu.com
>> Modify settings or unsubscribe at: https://lists.ubuntu.com/
>> mailman/listinfo/juju
>>
>>
>>
>> --
>> Juju mailing list
>> Juju at lists.ubuntu.com
>> Modify settings or unsubscribe at: https://lists.ubuntu.com/
>> mailman/listinfo/juju
>>
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://lists.ubuntu.com/archives/juju/attachments/20161209/c6789da1/attachment.html>