April 2025 - Evergreen-commits - Evergreen Mailing Lists Server

[GIT] Evergreen ILS branch rel_3_15 updated. ea8ae780dbc842f75c78ac858723427d8c03a958
by Git User 07 Apr '25

07 Apr '25

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Evergreen ILS". The branch, rel_3_15 has been updated via ea8ae780dbc842f75c78ac858723427d8c03a958 (commit) from fd59101aea24d3f2427089f0261c87319a1b647f (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit ea8ae780dbc842f75c78ac858723427d8c03a958 Author: Stephanie Leary <stephanie.leary(a)equinoxoli.org> Date: Sat Mar 15 21:54:08 2025 +0000 LP1940867 Avoid error when reimporting vandelay queue Avoids checking nonexistent combobox freetext value when reimporting Vandelay queue. Release-note: Avoid freetext error when reimporting MARC import queue Signed-off-by: Stephanie Leary <stephanie.leary(a)equinoxoli.org> Signed-off-by: Jane Sandberg <sandbergja(a)gmail.com> diff --git a/Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts b/Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts index c7b6474842..902d1e1635 100644 --- a/Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts +++ b/Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts @@ -472,7 +472,7 @@ export class ImportComponent implements OnInit, AfterViewInit, OnDestroy { // Extract selected queue ID or create a new queue when requested. resolveQueue(): Promise<number> { - if (this.selectedQueue.freetext) { + if (this.selectedQueue?.freetext) { // Free text queue selector means create a new entry. // TODO: first check for name dupes ----------------------------------------------------------------------- Summary of changes: Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) hooks/post-receive -- Evergreen ILS

1 0

[GIT] Evergreen ILS branch rel_3_14 updated. 79c5da33f60b8ee63abc7892c5b8f0a2a75fcabe
by Git User 07 Apr '25

07 Apr '25

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Evergreen ILS". The branch, rel_3_14 has been updated via 79c5da33f60b8ee63abc7892c5b8f0a2a75fcabe (commit) from 3fb6de0ee65db7cbc44819ea7f402f53e40c4cce (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 79c5da33f60b8ee63abc7892c5b8f0a2a75fcabe Author: Stephanie Leary <stephanie.leary(a)equinoxoli.org> Date: Sat Mar 15 21:54:08 2025 +0000 LP1940867 Avoid error when reimporting vandelay queue Avoids checking nonexistent combobox freetext value when reimporting Vandelay queue. Release-note: Avoid freetext error when reimporting MARC import queue Signed-off-by: Stephanie Leary <stephanie.leary(a)equinoxoli.org> Signed-off-by: Jane Sandberg <sandbergja(a)gmail.com> diff --git a/Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts b/Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts index c7b6474842..902d1e1635 100644 --- a/Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts +++ b/Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts @@ -472,7 +472,7 @@ export class ImportComponent implements OnInit, AfterViewInit, OnDestroy { // Extract selected queue ID or create a new queue when requested. resolveQueue(): Promise<number> { - if (this.selectedQueue.freetext) { + if (this.selectedQueue?.freetext) { // Free text queue selector means create a new entry. // TODO: first check for name dupes ----------------------------------------------------------------------- Summary of changes: Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) hooks/post-receive -- Evergreen ILS

1 0

[GIT] Evergreen ILS branch main updated. 750bc317aa3a20247b1e9f6b7cba701a4e94b10c
by Git User 07 Apr '25

07 Apr '25

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Evergreen ILS". The branch, main has been updated via 750bc317aa3a20247b1e9f6b7cba701a4e94b10c (commit) from d90309de2583d04f5cd3202d6b15ad0009a475a2 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 750bc317aa3a20247b1e9f6b7cba701a4e94b10c Author: Stephanie Leary <stephanie.leary(a)equinoxoli.org> Date: Sat Mar 15 21:54:08 2025 +0000 LP1940867 Avoid error when reimporting vandelay queue Avoids checking nonexistent combobox freetext value when reimporting Vandelay queue. Release-note: Avoid freetext error when reimporting MARC import queue Signed-off-by: Stephanie Leary <stephanie.leary(a)equinoxoli.org> Signed-off-by: Jane Sandberg <sandbergja(a)gmail.com> diff --git a/Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts b/Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts index c7b6474842..902d1e1635 100644 --- a/Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts +++ b/Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts @@ -472,7 +472,7 @@ export class ImportComponent implements OnInit, AfterViewInit, OnDestroy { // Extract selected queue ID or create a new queue when requested. resolveQueue(): Promise<number> { - if (this.selectedQueue.freetext) { + if (this.selectedQueue?.freetext) { // Free text queue selector means create a new entry. // TODO: first check for name dupes ----------------------------------------------------------------------- Summary of changes: Open-ILS/src/eg2/src/app/staff/cat/vandelay/import.component.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) hooks/post-receive -- Evergreen ILS

1 0

[GIT] Evergreen ILS branch rel_3_14 updated. 3fb6de0ee65db7cbc44819ea7f402f53e40c4cce
by Git User 04 Apr '25

04 Apr '25

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Evergreen ILS". The branch, rel_3_14 has been updated via 3fb6de0ee65db7cbc44819ea7f402f53e40c4cce (commit) from 35819857ef82a3f58e60546dd96475906aa65345 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 3fb6de0ee65db7cbc44819ea7f402f53e40c4cce Author: Tiffany Little <tlittle(a)georgialibraries.org> Date: Wed Feb 5 11:05:55 2025 -0500 LP2094859 Batch receive count on invoices Release-note: Fixes a regression where the count of receivable items on acq invoices was always zero. Signed-off-by: Tiffany Little <tlittle(a)georgialibraries.org> Signed-off-by: Christine Burns <christine.burns(a)bc.libraries.coop> Signed-off-by: Terran McCanna <tmccanna(a)georgialibraries.org> diff --git a/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html b/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html index 9c191fbee9..b6e89e0b9e 100644 --- a/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html +++ b/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html @@ -582,7 +582,7 @@ placeholder='#' i18n-placeholder min="0" max="{{(li.lineitem_details()||[]).length}}" [disabled]="li.state() === 'received'" - [(ngModel)]="lineitemDetailCountMap[li.id()]" + [ngModel]="countReceivableItems(li)" (ngModelChange)="adjustSelectedLids(li.id(),$event)"/> </div> </ng-container> diff --git a/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts b/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts index 936999c029..2aa6c850b2 100644 --- a/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts +++ b/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts @@ -1458,6 +1458,12 @@ export class LineitemListComponent implements OnInit, OnDestroy, OnChanges { return total; } + countReceivableItems(li: IdlObject) : Number { + const sum = li.order_summary(); + + return sum.item_count() - (sum.cancel_count() + sum.recv_count()); + } + receiveSelected() { /* lineitems*/ this.markReceived(this.selectedIds()); } ----------------------------------------------------------------------- Summary of changes: .../src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html | 2 +- .../src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) hooks/post-receive -- Evergreen ILS

1 0

[GIT] Evergreen ILS branch rel_3_15 updated. fd59101aea24d3f2427089f0261c87319a1b647f
by Git User 04 Apr '25

04 Apr '25

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Evergreen ILS". The branch, rel_3_15 has been updated via fd59101aea24d3f2427089f0261c87319a1b647f (commit) from 8d4417cb7f9a65c3b5eacfbbd6e4d1073999d906 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit fd59101aea24d3f2427089f0261c87319a1b647f Author: Tiffany Little <tlittle(a)georgialibraries.org> Date: Wed Feb 5 11:05:55 2025 -0500 LP2094859 Batch receive count on invoices Release-note: Fixes a regression where the count of receivable items on acq invoices was always zero. Signed-off-by: Tiffany Little <tlittle(a)georgialibraries.org> Signed-off-by: Christine Burns <christine.burns(a)bc.libraries.coop> Signed-off-by: Terran McCanna <tmccanna(a)georgialibraries.org> diff --git a/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html b/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html index 9c191fbee9..b6e89e0b9e 100644 --- a/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html +++ b/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html @@ -582,7 +582,7 @@ placeholder='#' i18n-placeholder min="0" max="{{(li.lineitem_details()||[]).length}}" [disabled]="li.state() === 'received'" - [(ngModel)]="lineitemDetailCountMap[li.id()]" + [ngModel]="countReceivableItems(li)" (ngModelChange)="adjustSelectedLids(li.id(),$event)"/> </div> </ng-container> diff --git a/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts b/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts index 936999c029..2aa6c850b2 100644 --- a/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts +++ b/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts @@ -1458,6 +1458,12 @@ export class LineitemListComponent implements OnInit, OnDestroy, OnChanges { return total; } + countReceivableItems(li: IdlObject) : Number { + const sum = li.order_summary(); + + return sum.item_count() - (sum.cancel_count() + sum.recv_count()); + } + receiveSelected() { /* lineitems*/ this.markReceived(this.selectedIds()); } ----------------------------------------------------------------------- Summary of changes: .../src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html | 2 +- .../src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) hooks/post-receive -- Evergreen ILS

1 0

[GIT] Evergreen ILS branch main updated. d90309de2583d04f5cd3202d6b15ad0009a475a2
by Git User 04 Apr '25

04 Apr '25

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Evergreen ILS". The branch, main has been updated via d90309de2583d04f5cd3202d6b15ad0009a475a2 (commit) from bd12167bcd1a363ddd5c80780fb5e70feaf60aeb (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit d90309de2583d04f5cd3202d6b15ad0009a475a2 Author: Tiffany Little <tlittle(a)georgialibraries.org> Date: Wed Feb 5 11:05:55 2025 -0500 LP2094859 Batch receive count on invoices Release-note: Fixes a regression where the count of receivable items on acq invoices was always zero. Signed-off-by: Tiffany Little <tlittle(a)georgialibraries.org> Signed-off-by: Terran McCanna <tmccanna(a)georgialibraries.org> diff --git a/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html b/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html index 9c191fbee9..b6e89e0b9e 100644 --- a/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html +++ b/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html @@ -582,7 +582,7 @@ placeholder='#' i18n-placeholder min="0" max="{{(li.lineitem_details()||[]).length}}" [disabled]="li.state() === 'received'" - [(ngModel)]="lineitemDetailCountMap[li.id()]" + [ngModel]="countReceivableItems(li)" (ngModelChange)="adjustSelectedLids(li.id(),$event)"/> </div> </ng-container> diff --git a/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts b/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts index 936999c029..2aa6c850b2 100644 --- a/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts +++ b/Open-ILS/src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts @@ -1458,6 +1458,12 @@ export class LineitemListComponent implements OnInit, OnDestroy, OnChanges { return total; } + countReceivableItems(li: IdlObject) : Number { + const sum = li.order_summary(); + + return sum.item_count() - (sum.cancel_count() + sum.recv_count()); + } + receiveSelected() { /* lineitems*/ this.markReceived(this.selectedIds()); } ----------------------------------------------------------------------- Summary of changes: .../src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.html | 2 +- .../src/eg2/src/app/staff/acq/lineitem/lineitem-list.component.ts | 6 ++++++ 2 files changed, 7 insertions(+), 1 deletion(-) hooks/post-receive -- Evergreen ILS

1 0

[GIT] Evergreen ILS branch rel_3_14 updated. 35819857ef82a3f58e60546dd96475906aa65345
by Git User 04 Apr '25

04 Apr '25

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Evergreen ILS". The branch, rel_3_14 has been updated via 35819857ef82a3f58e60546dd96475906aa65345 (commit) from d4626f56d8e1f0161b006ad150c1bf03f840acc8 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 35819857ef82a3f58e60546dd96475906aa65345 Author: Stephanie Leary <stephanie.leary(a)equinoxoli.org> Date: Tue Mar 11 15:29:30 2025 +0000 LP2094843 Overlay missing from Z39.50 actions menu The search results grid for Z39.50 has an Overlay button in the toolbar, but not the actions menu. This restores the action menu option, using [disabled] instead of [disableOnRows] for better conditional logic. Release-note: Add 'Overlay' to Z39.50 search results grid actions menu Signed-off-by: Stephanie Leary <stephanie.leary(a)equinoxoli.org> Signed-off-by: Carol Witt <wittc(a)cwmars.org> Signed-off-by: Terran McCanna <tmccanna(a)georgialibraries.org> diff --git a/Open-ILS/src/eg2/src/app/staff/share/z3950-search/z3950-search.component.html b/Open-ILS/src/eg2/src/app/staff/share/z3950-search/z3950-search.component.html index fbd63c271d..295500556e 100644 --- a/Open-ILS/src/eg2/src/app/staff/share/z3950-search/z3950-search.component.html +++ b/Open-ILS/src/eg2/src/app/staff/share/z3950-search/z3950-search.component.html @@ -481,13 +481,11 @@ [disableOnRows]="notOneSelectedForGrid" (onClick)="editThenImport($event)"/> - <eg-grid-toolbar-action *ngIf="searchMode === 'acq'" ----------------------------------------------------------------------- Summary of changes: .../eg2/src/app/staff/share/z3950-search/z3950-search.component.html | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) hooks/post-receive -- Evergreen ILS

1 0

[GIT] Evergreen ILS branch rel_3_15 updated. 8d4417cb7f9a65c3b5eacfbbd6e4d1073999d906
by Git User 04 Apr '25

04 Apr '25

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Evergreen ILS". The branch, rel_3_15 has been updated via 8d4417cb7f9a65c3b5eacfbbd6e4d1073999d906 (commit) from 0e25f6ea66eacba8cdfd8425e77dc89ce8b73c1f (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 8d4417cb7f9a65c3b5eacfbbd6e4d1073999d906 Author: Stephanie Leary <stephanie.leary(a)equinoxoli.org> Date: Tue Mar 11 15:29:30 2025 +0000 LP2094843 Overlay missing from Z39.50 actions menu The search results grid for Z39.50 has an Overlay button in the toolbar, but not the actions menu. This restores the action menu option, using [disabled] instead of [disableOnRows] for better conditional logic. Release-note: Add 'Overlay' to Z39.50 search results grid actions menu Signed-off-by: Stephanie Leary <stephanie.leary(a)equinoxoli.org> Signed-off-by: Carol Witt <wittc(a)cwmars.org> Signed-off-by: Terran McCanna <tmccanna(a)georgialibraries.org> diff --git a/Open-ILS/src/eg2/src/app/staff/share/z3950-search/z3950-search.component.html b/Open-ILS/src/eg2/src/app/staff/share/z3950-search/z3950-search.component.html index fbd63c271d..295500556e 100644 --- a/Open-ILS/src/eg2/src/app/staff/share/z3950-search/z3950-search.component.html +++ b/Open-ILS/src/eg2/src/app/staff/share/z3950-search/z3950-search.component.html @@ -481,13 +481,11 @@ [disableOnRows]="notOneSelectedForGrid" (onClick)="editThenImport($event)"/> - <eg-grid-toolbar-action *ngIf="searchMode === 'acq'" ----------------------------------------------------------------------- Summary of changes: .../eg2/src/app/staff/share/z3950-search/z3950-search.component.html | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) hooks/post-receive -- Evergreen ILS

1 0

[GIT] Evergreen ILS branch main updated. bd12167bcd1a363ddd5c80780fb5e70feaf60aeb
by Git User 04 Apr '25

04 Apr '25

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Evergreen ILS". The branch, main has been updated via bd12167bcd1a363ddd5c80780fb5e70feaf60aeb (commit) from 5b0cb10c8507b59a497b894f1f85a84fa9520b13 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit bd12167bcd1a363ddd5c80780fb5e70feaf60aeb Author: Stephanie Leary <stephanie.leary(a)equinoxoli.org> Date: Tue Mar 11 15:29:30 2025 +0000 LP2094843 Overlay missing from Z39.50 actions menu The search results grid for Z39.50 has an Overlay button in the toolbar, but not the actions menu. This restores the action menu option, using [disabled] instead of [disableOnRows] for better conditional logic. Release-note: Add 'Overlay' to Z39.50 search results grid actions menu Signed-off-by: Stephanie Leary <stephanie.leary(a)equinoxoli.org> Signed-off-by: Carol Witt <wittc(a)cwmars.org> Signed-off-by: Terran McCanna <tmccanna(a)georgialibraries.org> diff --git a/Open-ILS/src/eg2/src/app/staff/share/z3950-search/z3950-search.component.html b/Open-ILS/src/eg2/src/app/staff/share/z3950-search/z3950-search.component.html index fbd63c271d..295500556e 100644 --- a/Open-ILS/src/eg2/src/app/staff/share/z3950-search/z3950-search.component.html +++ b/Open-ILS/src/eg2/src/app/staff/share/z3950-search/z3950-search.component.html @@ -481,13 +481,11 @@ [disableOnRows]="notOneSelectedForGrid" (onClick)="editThenImport($event)"/> - <eg-grid-toolbar-action *ngIf="searchMode === 'acq'" ----------------------------------------------------------------------- Summary of changes: .../eg2/src/app/staff/share/z3950-search/z3950-search.component.html | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) hooks/post-receive -- Evergreen ILS

1 0

[GIT] Evergreen ILS branch main updated. 5b0cb10c8507b59a497b894f1f85a84fa9520b13
by Git User 04 Apr '25

04 Apr '25

This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Evergreen ILS". The branch, main has been updated via 5b0cb10c8507b59a497b894f1f85a84fa9520b13 (commit) via 99b0d94444108f4813132089a74fa7adc8e36e1b (commit) from 6c5adbd019f031576a4f584ea0ef6a26a6870375 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- commit 5b0cb10c8507b59a497b894f1f85a84fa9520b13 Author: Jane Sandberg <js7389(a)princeton.edu> Date: Tue Nov 26 14:21:58 2024 -0800 LP2076555: incorporate feedback from review This adds information about the vale check to the instructions for committing documentation, where it will be more visible to docs contributors. Thanks to Ruth Davis and others at the collaborative code review! Signed-off-by: Jane Sandberg <js7389(a)princeton.edu> Signed-off-by: blake <blake(a)mobiusconsortium.org> diff --git a/docs/modules/shared/assets/images/how_to_contribute_docs/checkmark_pr.png b/docs/modules/shared/assets/images/how_to_contribute_docs/checkmark_pr.png new file mode 100644 index 0000000000..873564363f Binary files /dev/null and b/docs/modules/shared/assets/images/how_to_contribute_docs/checkmark_pr.png differ diff --git a/docs/modules/shared/pages/how_to_contribute_docs.adoc b/docs/modules/shared/pages/how_to_contribute_docs.adoc index ba4389fc16..9a6d425aac 100644 --- a/docs/modules/shared/pages/how_to_contribute_docs.adoc +++ b/docs/modules/shared/pages/how_to_contribute_docs.adoc @@ -199,6 +199,16 @@ image::how_to_contribute_docs/github_web_create_pull_request.png[Github Web Crea . It's nice to see "Able to merge" . Confirm that this pull request is compared with *master* on the left and with *your branch* on the right . Click on "Create pull request" +. Github will run a few checks, to make sure that your changes match our style guide + and won't cause problems when they are published on docs.evergreen-ils.org. These checks will take a few minutes. + * If everything is good, Github will add a green + checkmark icon next to your pull request. ++ +image::how_to_contribute_docs/checkmark_pr.png[A github pull request shows a green checkmark icon immediately after the title of the pull request] ++ + * If there is an issue, Github will add a red X icon. You can click the red X + icon for more details. To address the issue, you can adjust your version of + the docs locally, commit your changes, and publish your branch again. == Follow up on Launchpad == commit 99b0d94444108f4813132089a74fa7adc8e36e1b Author: Jane Sandberg <js7389(a)princeton.edu> Date: Thu Sep 5 16:50:03 2024 -0700 LP2076555: Use vale to check our documentation for missing alt text Release-note: Add an automated accessibility check for Evergreen's documentation. Signed-off-by: Jane Sandberg <js7389(a)princeton.edu> diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml index c24fef336b..9f614c219c 100644 --- a/.github/workflows/docs.yml +++ b/.github/workflows/docs.yml @@ -22,3 +22,16 @@ jobs: name: built-docs path: docs/output retention-days: 2 + check_docs_styles: + name: Check docs styles + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + - name: Install asciidoctor + run: sudo apt-get install -y asciidoctor + - name: Install vale + run: pip install vale + - name: Download and install vale rules + run: cd docs && vale sync + - name: Check documentation against DIG style guide + run: cd docs && vale modules diff --git a/docs/.gitignore b/docs/.gitignore index 54ad0c952f..8b417cd1c6 100644 --- a/docs/.gitignore +++ b/docs/.gitignore @@ -4,3 +4,4 @@ package-lock.json build output site-working.yml +vale-styles/AsciiDoc diff --git a/docs/.vale.ini b/docs/.vale.ini new file mode 100644 index 0000000000..cf8ef225a8 --- /dev/null +++ b/docs/.vale.ini @@ -0,0 +1,8 @@ +StylesPath = vale-styles + +MinAlertLevel = suggestion + +Packages = AsciiDoc + +[*.adoc] +AsciiDoc.ImageContainsAltText = error diff --git a/docs/README.adoc b/docs/README.adoc index d25b17ab76..61afe32a84 100644 --- a/docs/README.adoc +++ b/docs/README.adoc @@ -138,3 +138,20 @@ NOTE: https://blog.anoff.io/2019-02-15-antora-first-steps/ NOTE: https://owncloud.org/news/owncloud-docs-migrating-antora-pt-1-2/ +== Checking the documentation against our style guide + +We use a tool named Vale to check our documentation +against our style guide. + +To check it locally: + +. https://asciidoctor.org/#installation[Install asciidoctor locally] +. https://vale.sh/docs/vale-cli/installation/[Install vale locally] +. Run the following commands from the Evergreen source directory: + +[source,bash] +---- +cd docs +vale sync +vale modules +---- ----------------------------------------------------------------------- Summary of changes: .github/workflows/docs.yml | 13 +++++++++++++ docs/.gitignore | 1 + docs/.vale.ini | 8 ++++++++ docs/README.adoc | 17 +++++++++++++++++ .../images/how_to_contribute_docs/checkmark_pr.png | Bin 0 -> 22737 bytes docs/modules/shared/pages/how_to_contribute_docs.adoc | 10 ++++++++++ 6 files changed, 49 insertions(+) create mode 100644 docs/.vale.ini create mode 100644 docs/modules/shared/assets/images/how_to_contribute_docs/checkmark_pr.png hooks/post-receive -- Evergreen ILS

1 0