[Evergreen-documentation] Updating terminology in the Evergreen docs

Jane Sandberg sandbergja at gmail.com
Thu Aug 1 19:36:38 EDT 2024


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
<https://wiki.evergreen-ils.org/doku.php?id=evergreen-docs:dig_style_guide#standard_terminology>
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
<https://github.com/sandbergja/Evergreen/commit/03b4aa8a8bcb0a9e8519b1a7d05e58a94682f855#diff-e9c4e0d093128e64a192cbc1e7bfe6967edda00d34daaa567dcc2d7cc86f372b>.
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
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://list.evergreen-ils.org/pipermail/evergreen-documentation/attachments/20240801/ce059944/attachment.htm>


More information about the Evergreen-documentation mailing list