Re: [Evergreen-documentation] [Evergreen-general] Documentation Question - Library visibility on the web and SKOS

[Jane Sandberg via Evergreen-documentation]

Ahhh, thanks for finding that, Chris.  It looks like I copied it from the 2.9
release notes
.
Here is the relevant launchpad ticket
.

El vie, 6 sept 2024 a la(s) 9:11 a.m., Chris Sharp via
Evergreen-documentation (evergreen-documentation@list.evergreen-ils.org)
escribió:

> looks like this was authored by Jane Sandberg in 2017.  Git commit
> 9ee6e6ced0fc5e39ce6c7c925ffc269c6bae3522.  Attached the git diff for
> reference.
>
> On Fri, Sep 6, 2024 at 11:00 AM Jennifer Pringle via Evergreen-general <
> evergreen-gene...@list.evergreen-ils.org> wrote:
>
>> Hello everyone,
>>
>>
>>
>> At our meeting yesterday DIG found an orphaned page (can only be found
>> through search), the content of which none of us at the meeting know much
>> about.
>>
>>
>>
>> https://docs.evergreen-ils.org/docs/latest/opac/visibility_on_the_web.html
>>
>>
>>
>> We’re looking for someone who can review this page and let us know if the
>> page is valid and if so if there are any changes that need to be made to it.
>>
>>
>>
>> The SKOS Support section of the page says “This is an experimental,
>> "under-the-hood" feature that will be built upon in subsequent releases.”
>> but we couldn’t tell from git what release this feature was originally
>> added in.  We’re not sure if this is still an experimental feature or not.
>>
>>
>>
>> Thank you to anyone who can shed some light on this,
>>
>>
>>
>> Jennifer
>>
>>
>>
>> --
>>
>> Jennifer Pringle (she/her)
>>
>> Co-op Support - Training Lead
>>
>> BC Libraries Cooperative
>>
>> Toll-free: 1-888-848-9250
>>
>> Email:jennifer.prin...@bc.libraries.coop
>>
>> Website: http://bc.libraries.coop
>>
>>
>>
>> Gratefully acknowledging that I live and work in the unceded Traditional
>> Territory of the St'at'yemc Nations.
>>
>>
>> ___
>> Evergreen-general mailing list
>> evergreen-gene...@list.evergreen-ils.org
>> http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-general
>>
>
>
> --
>
> [image: logo with link to Georgia Public Library Service website]
> 
>
> Chris Sharp, PINES System Administrator
>
> --
>
> ​Georgia Public Library Service
>
> ​2872 Woodcock Blvd, Suite 250 | ​Atlanta, GA 30341
>
> (404) 235-7147 | csh...@georgialibraries.org
>
> [image: logo with link to Georgia Public Library Service Facebook page]
> [image: logo with link to
> Georgia Public Library Service Instagram page]
> [image: logo with link to
> Georgia Public Library Service LinkedIn page]
> [image:
> logo with link to Georgia Public Library Service Threads page]
> 
>
> Join our email list  for
> stories of Georgia libraries making an impact in our communities.
> ___
> Evergreen-documentation mailing list
> Evergreen-documentation@list.evergreen-ils.org
>
> http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation
>
___
Evergreen-documentation mailing list
Evergreen-documentation@list.evergreen-ils.org
http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation

Re: [Evergreen-documentation] Adding alt text to images -- here's the spreadsheet!

[Jane Sandberg via Evergreen-documentation]

Hi Susan,

It looks like the error was:
fatal: unable to connect to git.evergreen-ils.org:
git.evergreen-ils.org[0: 168.25.130.14]: errno=Connection timed out

I think git.evergreen-ils.org must have had some downtime today!  I pressed
the "Rerun jobs" button on the second PR, and it is happy now.

It looks like your first pull request is within your own spmorrison fork.
I think that if you go to Missing screenshots for
circulating_items_web_client by spmorrison · Pull Request #11 ·
spmorrison/Evergreen · GitHub
<https://github.com/spmorrison/Evergreen/pull/11/checks>, you should also
have a "Rerun jobs" or "Rerun all jobs" button -- hopefully that does the
trick?

Thanks for reporting this, and for the pull requests!

Have a good weekend,

 -Jane

El vie, 9 ago 2024 a la(s) 9:02 a.m., Susan Morrison (
smorri...@georgialibraries.org) escribió:

> Good Morning,
>
> I submitted pull requests for the screenshots and alt text for
> docs/modules/circulation/pages/circulating_items_web_client.adoc and
> received error messages for both that the checks failed. I followed the
> same process I normally do, so I'm not quite sure what happened there. Has
> anyone seen this before and know how I can fix it?
>
>- *screenshots:* https://github.com/spmorrison/Evergreen/pull/11
>- *text edits: *
>https://github.com/evergreen-library-system/Evergreen/pull/279
>
> Thanks all,
>
> Susan
>
> On Sun, Jul 14, 2024 at 9:31 AM Jane Sandberg 
> wrote:
>
>> Thanks, Susan and Debbie!  And thanks to Ian, who just knocked out a HUGE
>> number of these in his first Evergreen docs contribution.
>>
>> El vie, 12 jul 2024 a la(s) 8:42 a.m., Susan Morrison via
>> Evergreen-documentation (evergreen-documentation@list.evergreen-ils.org)
>> escribió:
>>
>>> Thank you, Jane! I'll try to knock some of these out next week.
>>>
>>> On Fri, Jul 12, 2024 at 10:45 AM Deborah Luchenbill via
>>> Evergreen-documentation 
>>> wrote:
>>>
>>>> Yay! Thanks so much, Jane!
>>>>
>>>>
>>>> Debbie Luchenbill
>>>> Associate Director, Open Source Initiatives
>>>> MOBIUS
>>>> 2511 Broadway Bluffs, Ste. 101
>>>> Columbia, MO  65201
>>>> deb...@mobiusconsortium.org 
>>>> 573-234-4914
>>>> https://mobiusconsortium.org <http://mobiusconsortium.org>
>>>> MOSS Help Desk: h...@mobiusconsortium.org / 877-312-3517
>>>> Pronouns: She/Her or She/They (see https://pronouns.org/ to learn more)
>>>> Input | Maximizer | Intellection | Relator | Adaptability
>>>>
>>>>
>>>> On Fri, Jul 12, 2024 at 9:15 AM Jane Sandberg via
>>>> Evergreen-documentation 
>>>> wrote:
>>>>
>>>>> Hi all,
>>>>>
>>>>> In yesterday's DIG meeting, we talked about adding alt text to images
>>>>> in the manual that don't yet have them.  We decided that the easiest way 
>>>>> to
>>>>> collaborate would be to take the list generated by Vale
>>>>> <https://vale.sh/> and add it to a spreadsheet.
>>>>>
>>>>> Here is that spreadsheet!
>>>>> https://docs.google.com/spreadsheets/d/1POFT33nmeCGoR57LfEY-FSqPHdXKgMx1wUtzzp6ejjU/edit
>>>>>
>>>>> Please grab as many or as few of these as you can!  Every bit helps!
>>>>> There are links to instructions in the spreadsheet, as well as a link to 
>>>>> an
>>>>> example Github Pull Request.  And please ask any questions that come up to
>>>>> this list or to me directly.
>>>>>
>>>>>   -Jane
>>>>> ___
>>>>> Evergreen-documentation mailing list
>>>>> Evergreen-documentation@list.evergreen-ils.org
>>>>>
>>>>> http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation
>>>>>
>>>> ___
>>>> Evergreen-documentation mailing list
>>>> Evergreen-documentation@list.evergreen-ils.org
>>>>
>>>> http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation
>>>>
>>>
>>>
>>> --
>>>
>>> [image: logo with link to Georgia Public Library Service website]
>>> <https://georgialibraries.org/>
>>>
>>> Susan Morrison, PINES Operations Analyst
>>>
>>> --
>>&g

[Evergreen-documentation] Updating terminology in the Evergreen docs

[Jane Sandberg via Evergreen-documentation]

Hi DIG,

In today's meeting, we talked about adding an automated check that the
terminology in the docs matches the style guide.  We decided to go for the two
final bullet points in this list

to
start with:

   - Library Setting (instead of "org unit setting" or "yaous")
   - Library or Organizational Unit (instead of "org unit")

I created a new vale rule to check for this
.
Here's a spreadsheet of areas that it thinks need some correction:
https://docs.google.com/spreadsheets/d/1IjfX9pEIkL3nzlomznNYCS-_fKZftBnFDXzBbwCX8fw/edit
-- if you have capacity to fix some, it would be fantastic!  Also, if the
list contains some false positives, definitely let me know, and I can try
to tune the new rule.

Thanks for your help with this!

  -Jane
___
Evergreen-documentation mailing list
Evergreen-documentation@list.evergreen-ils.org
http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation

Re: [Evergreen-documentation] Adding alt text to images -- here's the spreadsheet!

[Jane Sandberg via Evergreen-documentation]

Thanks, Susan and Debbie!  And thanks to Ian, who just knocked out a HUGE
number of these in his first Evergreen docs contribution.

El vie, 12 jul 2024 a la(s) 8:42 a.m., Susan Morrison via
Evergreen-documentation (evergreen-documentation@list.evergreen-ils.org)
escribió:

> Thank you, Jane! I'll try to knock some of these out next week.
>
> On Fri, Jul 12, 2024 at 10:45 AM Deborah Luchenbill via
> Evergreen-documentation 
> wrote:
>
>> Yay! Thanks so much, Jane!
>>
>>
>> Debbie Luchenbill
>> Associate Director, Open Source Initiatives
>> MOBIUS
>> 2511 Broadway Bluffs, Ste. 101
>> Columbia, MO  65201
>> deb...@mobiusconsortium.org 
>> 573-234-4914
>> https://mobiusconsortium.org <http://mobiusconsortium.org>
>> MOSS Help Desk: h...@mobiusconsortium.org / 877-312-3517
>> Pronouns: She/Her or She/They (see https://pronouns.org/ to learn more)
>> Input | Maximizer | Intellection | Relator | Adaptability
>>
>>
>> On Fri, Jul 12, 2024 at 9:15 AM Jane Sandberg via Evergreen-documentation
>>  wrote:
>>
>>> Hi all,
>>>
>>> In yesterday's DIG meeting, we talked about adding alt text to images in
>>> the manual that don't yet have them.  We decided that the easiest way to
>>> collaborate would be to take the list generated by Vale
>>> <https://vale.sh/> and add it to a spreadsheet.
>>>
>>> Here is that spreadsheet!
>>> https://docs.google.com/spreadsheets/d/1POFT33nmeCGoR57LfEY-FSqPHdXKgMx1wUtzzp6ejjU/edit
>>>
>>> Please grab as many or as few of these as you can!  Every bit helps!
>>> There are links to instructions in the spreadsheet, as well as a link to an
>>> example Github Pull Request.  And please ask any questions that come up to
>>> this list or to me directly.
>>>
>>>   -Jane
>>> ___
>>> Evergreen-documentation mailing list
>>> Evergreen-documentation@list.evergreen-ils.org
>>>
>>> http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation
>>>
>> ___
>> Evergreen-documentation mailing list
>> Evergreen-documentation@list.evergreen-ils.org
>>
>> http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation
>>
>
>
> --
>
> [image: logo with link to Georgia Public Library Service website]
> <https://georgialibraries.org/>
>
> Susan Morrison, PINES Operations Analyst
>
> --
>
> ​Georgia Public Library Service
>
> ​2872 Woodcock Blvd, Suite 250 | ​Atlanta, GA 30341
>
> (404) 235-7142 | smorri...@georgialibraries.org
>
> https://help.georgialibraries.org | h...@georgialibraries.org
>
> [image: logo with link to Georgia Public Library Service Facebook page]
> <https://www.facebook.com/georgialibraries>[image: logo with link to
> Georgia Public Library Service Instagram page]
> <https://www.instagram.com/georgialibraries/>[image: logo with link to
> Georgia Public Library Service LinkedIn page]
> <https://www.linkedin.com/company/georgia-public-library-service/>[image:
> logo with link to Georgia Public Library Service Threads page]
> <https://www.threads.net/@georgialibraries>
>
> Join our email list <http://georgialibraries.org/subscription> for
> stories of Georgia libraries making an impact in our communities.
> ___
> Evergreen-documentation mailing list
> Evergreen-documentation@list.evergreen-ils.org
>
> http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation
>
___
Evergreen-documentation mailing list
Evergreen-documentation@list.evergreen-ils.org
http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation

[Evergreen-documentation] Adding alt text to images -- here's the spreadsheet!

[Jane Sandberg via Evergreen-documentation]

Hi all,

In yesterday's DIG meeting, we talked about adding alt text to images in
the manual that don't yet have them.  We decided that the easiest way to
collaborate would be to take the list generated by Vale 
and add it to a spreadsheet.

Here is that spreadsheet!
https://docs.google.com/spreadsheets/d/1POFT33nmeCGoR57LfEY-FSqPHdXKgMx1wUtzzp6ejjU/edit

Please grab as many or as few of these as you can!  Every bit helps!  There
are links to instructions in the spreadsheet, as well as a link to an
example Github Pull Request.  And please ask any questions that come up to
this list or to me directly.

  -Jane
___
Evergreen-documentation mailing list
Evergreen-documentation@list.evergreen-ils.org
http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation

[Evergreen-documentation] Vale styleguide checking for Evergreen documentation

[Jane Sandberg via Evergreen-documentation]

Hi DIG,

In today's DIG meeting, we looked at a tool called Vale
 for automatically checking if our documentation is
following best practices and the DIG style guide
.
The tool looked potentially quite useful, and so we discussed implementing
it with an incremental approach of:

   - Configure vale in Github Actions with a single rule.
   - Use the list of problem areas provided by Github Actions to fix those
   areas
   - Confirm that Github Actions turns green when all those areas are fixed
   - Add another rule to Github Actions and repeat.

That way, we don't have to learn all about how to write vale rules at once,
nor do we face an overwhelming list of things to fix.

I did step one in the process (added a rule to make sure images in the docs
have alt text).  If you are logged into github, you can see the results
here:
https://github.com/sandbergja/Evergreen/actions/runs/8839819500/job/24273972123

So... next step is to add alt text to those images!  Please feel free to
make edits to my branch in the Github interface
.
Let me know if you have any questions about how to do this, I'm happy to
hop onto a quick zoom.  I won't be able to make it to the next DIG meeting,
but feel free to work on this/discuss this without me :-)

  -Jane
___
Evergreen-documentation mailing list
Evergreen-documentation@list.evergreen-ils.org
http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation

Re: [Evergreen-documentation] [External] Re: Staff Catalog - Updated Images

[Jane Sandberg via Evergreen-documentation]

Third time's the charm!  I'm seeing images at
https://github.com/evergreen-library-system/Evergreen/actions/runs/8211421385/artifacts/1311152381

Thanks for getting this all working, Spencer!

El vie, 8 mar 2024 a la(s) 6:11 p.m., Pennington, Spencer (
spenning...@una.edu) escribió:

> Thanks, Jane!
>
> Images still weren't working – I think I did the references wrong.
>
> I had image::staff_catalog/page_folder/image.png[]
>
> I changed all of them to image::page_folder/image.png[]
>
> Committed to the same pull request
> .
>
> Fingers crossed – they should at least work now...
>
> Best,
> Spencer
> --
> *From:* Jane Sandberg 
> *Sent:* Friday, March 8, 2024 12:23 AM
> *To:* Documentation discussion for Evergreen software <
> evergreen-documentation@list.evergreen-ils.org>
> *Cc:* Pennington, Spencer 
> *Subject:* [External] Re: [Evergreen-documentation] Staff Catalog -
> Updated Images
>
>
> **CAUTION** External E-Mail. Do not click links or open attachments unless
> you know the content is safe.
>
> Hi Spencer,
>
> Thanks for fixing it so fast!  The updated built_docs.zip finished at
> https://github.com/evergreen-library-system/Evergreen/actions/runs/8198174707/artifacts/1308353363
> 
>
> El jue, 7 mar 2024 a la(s) 7:21 p.m., Pennington, Spencer via
> Evergreen-documentation (evergreen-documentation@list.evergreen-ils.org)
> escribió:
>
> Hey all-
>
> I committed changes to address the image issues on the same pull request
> 
> .
>
> I added the images folder in staff_catalog/assets, organized the images by
> page within the images folder, and updated the image references in the
> adocs.
>
> If someone would let me know when the built_docs.zip is available, I would
> love to see how it looks... Thanks!
>
> Best,
> Spencer
>
>
> *Spencer Pennington*
> *University of North Alabama*
> *Technical Writing (MA)*
> ___
> Evergreen-documentation mailing list
> Evergreen-documentation@list.evergreen-ils.org
>
> http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation
> 
>
>
___
Evergreen-documentation mailing list
Evergreen-documentation@list.evergreen-ils.org
http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation

Re: [Evergreen-documentation] Staff Catalog - Updated Images

[Jane Sandberg via Evergreen-documentation]

Hi Spencer,

Thanks for fixing it so fast!  The updated built_docs.zip finished at
https://github.com/evergreen-library-system/Evergreen/actions/runs/8198174707/artifacts/1308353363

El jue, 7 mar 2024 a la(s) 7:21 p.m., Pennington, Spencer via
Evergreen-documentation (evergreen-documentation@list.evergreen-ils.org)
escribió:

> Hey all-
>
> I committed changes to address the image issues on the same pull request
> .
>
> I added the images folder in staff_catalog/assets, organized the images by
> page within the images folder, and updated the image references in the
> adocs.
>
> If someone would let me know when the built_docs.zip is available, I would
> love to see how it looks... Thanks!
>
> Best,
> Spencer
>
>
> *Spencer Pennington*
> *University of North Alabama*
> *Technical Writing (MA)*
> ___
> Evergreen-documentation mailing list
> Evergreen-documentation@list.evergreen-ils.org
>
> http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation
>
___
Evergreen-documentation mailing list
Evergreen-documentation@list.evergreen-ils.org
http://list.evergreen-ils.org/cgi-bin/mailman/listinfo/evergreen-documentation

Re: [Evergreen-documentation] [Evergreen-general] Automating Antora documentation builds on GitLab

[Jane Sandberg via Evergreen-documentation]

For what it is worth, I have a pull request to do something similar for
Github, using the existing generate_docs script:
https://bugs.launchpad.net/evergreen/+bug/1903476

Whether on Github or Gitlab, I am very supportive of using these CI tools
to simplify our workflows.

On Thu, Dec 30, 2021 at 10:06 AM Floyd, Angelia Lynn via
Evergreen-documentation 
wrote:

> As I like this concept and the lowering of the bar for edits, my main
> concern is that we currently have people adding docs two different ways.
>
>1. Straight to the working Git Repo
>2. Via GitHub
>
>
>
> Will the use of GitLab incorporate both of these methods for adding docs?
>
>
>
> I think definitely a further discussion on this process and how to best
> use it at the next DIG meeting is a must.
>
>
>
> -
> Lynn Floyd
> MIS Supervisor
>
> Indiana State Library
> 317-232-3290
> lflo...@library.in.gov
>
>
>
> *From:* Evergreen-general <
> evergreen-general-boun...@list.evergreen-ils.org> *On Behalf Of *Dan
> Scott via Evergreen-general
> *Sent:* Thursday, December 30, 2021 11:45 AM
> *To:* evergreen-gene...@list.evergreen-ils.org
> *Subject:* Re: [Evergreen-general] Automating Antora documentation builds
> on GitLab
>
>
>
>  This is an EXTERNAL email. Exercise caution. DO NOT open attachments
> or click links from unknown senders or unexpected email. 
> --
>
> I took things a little further today.
>
>
>
> The GitLab docs build now includes the Evergreen CSS, header, and footer.
> The UI bundle is currently sourced from a pinned job from an automated
> build of the "evergreen" branch of the Antora default UI (
> https://gitlab.com/denials/antora-ui-default/-/tree/evergreen [1]) I set
> up.
>
>
>
> The UI bundle is currently in my GitLab namespace for testing purposes but
> it would be easy to move the repository to GitLab's
> evergreen-library-system group. I suggest mirroring the
> Antora/antora-ui-default main branch (GitLab makes mirroring trivial) and
> keeping our customizations in an "evergreen" branch to avoid merge hassles,
> etc.
>
>
>
> If we were willing to rely on GitLab's automated builds, we could remove
> docs/generate_docs.pl
> 
> and replace docs/site.yml. We wouldn't need to maintain a special server to
> build and serve the Evergreen documentation. We could even have GitLab
> serve up the docs.evergreen-ils.org
> 
> domain, given that Evergreen 3.6 marks the first Antora-based documentation
> and is currently in "only security fix mode". Or we could continue to serve
> up docs.evergreen-ils.org
> 
> on our own server along with the legacy docs by automating the downloading
> & unzipping of the artifacts bundle (all the HTML/CSS/JS/media) GitLab
> creates with each build.
>
>
>
> Depending on how far we wanted to go with GitLab integration, we could
> also unhide the "Edit this page" link on every page of the Evergreen
> documentation that leads to the corresponding file in the GitLab repository
> and the web IDE. That might be a lower bar for basic documentation
> contributions (e.g. fixing typos or adding a clarification) than our
> current footer's suggestion to email the DIG list (which, based on the list
> archives, doesn't seem to be attracting many contributions). Edits made via
> the Web IDE create a merge request (& potentially a branch) per
> https://docs.gitlab.com/ee/user/project/web_ide/#commit-changes so
> contributors wouldn't have to learn git mechanics to edit existing files.
>
>
>
> On Wed, 29 Dec 2021 at 14:30, Dan Scott  wrote:
>
> I was exploring GitLab's CI/CD (continuous integration / delivery)
> functionality last night/this morning and decided to try building our
> Antora-based documentation this way with the output hosted on GitLab Pages.
>
>
>
> It works quite nicely. I've posted a rough implementation branch at
> https://gitlab.com/evergreen-library-system/evergreen-library-system/-/commits/gitlab-antora-build
>
>
>
> As you can see, it's just a couple of YAML files; .gitlab-cy.yml defines
> the "pages" step, and .gitlab-antora.yml defines a custom Antora playbook
> for the Docker environment. The CI/CD piece means that a new build would be
> triggered by every commit.
>
>
>
> The output is visible at
> https://evergreen-library-system.gitlab.io/evergreen-library-system/docs/latest/index.html
>