[OPEN-ILS-DOCUMENTATION] FW: [Bug 1374903] [NEW] Docs - Image error in 2.7 reports enhancment docs

Remington Steed rjs7 at calvin.edu
Wed Oct 1 16:35:15 EDT 2014


Robert (and others),

Josh provides a useful bash command in the bug report below, and I wonder if it could be incorporated into the nightly docs build (outputting to anywhere you would notice, even emailing the DIG list).  It gets us one step closer to the kind of process used to test Evergreen code after every commit, which I think would be a great goal.  What do you think?

From Josh:
Here is a one line bash command that checks to make sure all the image
links are correct.  This could be added to the documentation Q/A
procedure.

for i in `egrep -roh "media/.*\.(JPG|jpg|png|PNG)" | sort | uniq `; do [
-f $i ] || echo "File $i not found" ; done

--
Remington Steed
Electronic Resources Specialist
Hekman Library, Calvin College
http://library.calvin.edu/

> -----Original Message-----
> From: bounces at canonical.com [mailto:bounces at canonical.com] On Behalf
> Of Josh Stompro
> Sent: Saturday, September 27, 2014 11:53 PM
> To: Remington Steed
> Subject: [Bug 1374903] [NEW] Docs - Image error in 2.7 reports enhancment
> docs
> 
> Public bug reported:
> 
> Just noticed that one of the "2.7_Enhancements_to_Reports" images under
> docs/media is a .png, while all the rest are .jpg.
> 
> docs/media/2.7_Enhancements_to_Reports5.png
> 
> In docs/reports/reporter_generating_reports.txt it is referenced as a
> .jpg, so it doesn't show up.
> 
> The line is:
> :image::media/2.7_Enhancements_to_Reports5.jpg[Reports5]
> 
> Here is a one line bash command that checks to make sure all the image
> links are correct.  This could be added to the documentation Q/A
> procedure.
> 
> for i in `egrep -roh "media/.*\.(JPG|jpg|png|PNG)" | sort | uniq `; do [
> -f $i ] || echo "File $i not found" ; done
> 
> I'm not sure if the fix for this should be changing the image to a jpg
> or just fixing the link in the asciidoc file.
> 
> Josh
> 
> ** Affects: evergreen
>      Importance: Undecided
>          Status: New
> 
> 
> ** Tags: bitesize-doc documentation
> 
> --
> You received this bug notification because you are a member of Evergreen
> Bug Wranglers, which is subscribed to Evergreen.
> https://bugs.launchpad.net/bugs/1374903
> 
> Title:
>   Docs - Image error in 2.7 reports enhancment docs
> 
> Status in Evergreen - Open ILS:
>   New
> 
> Bug description:
>   Just noticed that one of the "2.7_Enhancements_to_Reports" images
>   under docs/media is a .png, while all the rest are .jpg.
> 
>   docs/media/2.7_Enhancements_to_Reports5.png
> 
>   In docs/reports/reporter_generating_reports.txt it is referenced as a
>   .jpg, so it doesn't show up.
> 
>   The line is:
>   :image::media/2.7_Enhancements_to_Reports5.jpg[Reports5]
> 
>   Here is a one line bash command that checks to make sure all the image
>   links are correct.  This could be added to the documentation Q/A
>   procedure.
> 
>   for i in `egrep -roh "media/.*\.(JPG|jpg|png|PNG)" | sort | uniq `; do
>   [ -f $i ] || echo "File $i not found" ; done
> 
>   I'm not sure if the fix for this should be changing the image to a jpg
>   or just fixing the link in the asciidoc file.
> 
>   Josh
> 
> To manage notifications about this bug go to:
> https://bugs.launchpad.net/evergreen/+bug/1374903/+subscriptions


More information about the OPEN-ILS-DOCUMENTATION mailing list