My feeling is we should update all of them, especially if the change you're
talking about isn't made until 8 - a major version feels like a good time
to refresh all the screenshots as there have been enough smaller CSS
changes in 7.x that make them obsolete in many other ways.

IMO, all of them should have also been updated when the Suggestions menu
tab was also added and I've done some as I have time since that was added.

I'm not saying YOU should do all of them, though. I think it would be
enough to do whatever you have time to do  now, and file an issue to update
all the screenshots before the 8.0 Guide is done. Maybe some volunteers
will help make it short work, but I'll probably just end up doing all of
them when the time comes.

Selenium might be fine - I've used it only in a proof of concept like 8
years ago for screenshots, so I don't have a great sense for what it's like
to use longer term. If you want to try that, some automated UI testing
would be great.

The Asciidoctor project also has a plugin to automate getting screenshots (
https://github.com/asciidoctor/asciidoctorj-screenshot), but I only know
about it from hearing of it, I've never tried to use it. It seems geared
toward public websites, whereas Selenium probably has more fine-grained
control.

On Thu, Aug 2, 2018 at 5:37 AM Jan Høydahl <[email protected]> wrote:

> In SOLR-12613 we'll rename the "Cloud" menu in Admin UI to "Cluster". This
> affects pretty much
> all admin UI screenshots in the Reference Guide, so the next question then
> is "How do we
> keep all those screenshots up to date?". I counted a total of 42 screen
> shots of the UI, many
> which require creating collections, adding data, typing things into the UI
> etc up front.
>
> Due to the work involved, we often tend to update only a few shots and
> leave others as-is even
> if they are inaccurate. Example is the new "Suggestions" menu tab - there
> are 27 screen
> shots in the ref guide which are not updated with that menu option.
>
> For SOLR-12613 I'm tempted to only update the four images in
> "cloud-screens" folder for now.
>
> Perhaps for the future an automated approach can be taken using Selenium,
> as outlined in
> this post:
> https://blog.codeship.com/automating-screenshots-in-documentation/ This
> could
> in first phase be a standalone tool to generate screenshots but could also
> be extended with
> other tests to get some validation of the UI itself, which is completely
> lacking today. WDYT?
>
> --
> Jan Høydahl, search solution architect
> Cominvent AS - www.cominvent.com
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: [email protected]
> For additional commands, e-mail: [email protected]
>
>

Reply via email to