On 22 févr. 2014, at 16:40, Pieter Marres <[email protected]> wrote:

> Django documentation is an excellent resource but it is mostly text based.
> In some occasions, a picture tells more than a 1000 words.
> What's your opinion on including some images in the Django documentation?

There's already a few images and I can't see any reason against adding more
where appropriate.

There's just one small hurdle. Last time I checked, the intersection of "editors
producing good-looking diagrams" and "open-source diagram editors" was
empty. And we don't want ASCII diagrams.

For a few years we had some diagrams created with OmniGraffle and rendered
as PNG. When I switched images to vector formats, no one had the source. I
recreated all diagrams and committed the source files. They'll only be useful to
people who own an OmniGraffle license, but that's better than nothing.

I would recommend to use a tool that produces good looking results and
commit:
- the source file (in your tool's default format)
- a SVG export (for the HTML version of the docs)
- a PDF export (for the PDF version of the docs)

I hope this helps.

-- 
Aymeric.

-- 
You received this message because you are subscribed to the Google Groups 
"Django developers" group.
To unsubscribe from this group and stop receiving emails from it, send an email 
to [email protected].
To post to this group, send email to [email protected].
Visit this group at http://groups.google.com/group/django-developers.
To view this discussion on the web visit 
https://groups.google.com/d/msgid/django-developers/588372D0-3CF7-4771-B0BF-A7F92A7136CF%40polytechnique.org.
For more options, visit https://groups.google.com/groups/opt_out.

Reply via email to