Open Stack

On Fri, Jan 9, 2015 at 12:55 AM, Tom Fifield <tom at openstack.org> wrote:

> Hi Christian,
>
> Thanks for the response and highlighting some areas where the repository
> layout could be improved.
>
> I think we can start work on improving that layout without creating a
> new repository.
>
> For example, we can:
> * define 'images' as the name of the directory where images within a
> particular guide
> * ensuring source and used images both exist
> * ensuring source and used images are named the same and differ only in
> their file extension
>
> Do they sound like reasonable first steps?
>
>
These sound reasonable to me.

Once we get agreement here, I'll update the Documentation/HowTo wiki page
with this guidance. It's not a style guide for images, yet, but for the
file management itself.

There's still a lingering couple of related questions:
Do we as a team require only standard formats (such as svg) for source
files?
Do we as a team need to track down source files for all current images and
convert them to svg?

Anne


> Once we've got all that in order, maybe then we can revisit the need to
> create a whole new repository and the complexity it entails.
>
>
> Screenshots seem to be a parallel issue for another thread - but I have
> to say, yes, I too would love to see automated screenshots :) I'd see it
> working in the same way as the Translations proposal bot.
>
> Regards,
>
>
> Tom
>
> On 08/01/15 17:43, Christian Berendt wrote:
> > On 01/08/2015 09:26 AM, Tom Fifield wrote:
> >> * Is the additional complexity of differing 'source' and 'use' locations
> >> worthwhile?
> >
> > I think so because at the moment all graphics (source and rendered) life
> > inside documentation repositories without any specific convention.
> >
> > For example the graphics of image-guide are located in a directory
> > figures, the graphics of arch-design are located in a directory images.
> >
> > Also there are a lot of screenshots out of date. This should be
> > discussed, too. There are tools like http://phantomjs.org/ to automate
> > screen capturing. This way we could keep screenshots up to date.
> >
> >> * Is increasing the number of places needing to be changed for a fix
> >> justified?
> >
> > We have a lot of documentation repostiories and at the moment it is hard
> > to find the source of a specific graphic or a specific graphic itself.
> > For example there is only one Graffle file in arch-design but a lot of
> > PNG files.
> >
> >> * How will the changes be communicated? What HowToContribute guides
> >> needs to be updated?
> >
> > This mailinglist and https://wiki.openstack.org/wiki/Documentation/HowTo
> .
> >
> > Christian.
> >
>
>
> _______________________________________________
> OpenStack-docs mailing list
> OpenStack-docs at lists.openstack.org
> http://lists.openstack.org/cgi-bin/mailman/listinfo/openstack-docs
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.openstack.org/pipermail/openstack-docs/attachments/20150109/41fec8d7/attachment.html>