From: Remington Steed Date: Thu, 5 Dec 2019 20:40:23 +0000 (-0500) Subject: Docs: Improve antora navs, add missing attrib files X-Git-Url: https://old-git.evergreen-ils.org/?a=commitdiff_plain;h=9a635f7b8722e6444e3d137746a3f2f69d427f62;p=working%2FEvergreen.git Docs: Improve antora navs, add missing attrib files - Remove numbering from install docs headers - Link top-level nav items to each section's intro file - Add a few missing _attributes.adoc files in pages/ subdirs Signed-off-by: Remington Steed --- diff --git a/docs-antora/modules/ROOT/nav.adoc b/docs-antora/modules/ROOT/nav.adoc index 5f0d52eac5..48447d9e3b 100644 --- a/docs-antora/modules/ROOT/nav.adoc +++ b/docs-antora/modules/ROOT/nav.adoc @@ -1,3 +1,2 @@ -* Introduction -** xref:shared:about_evergreen.adoc[] -** xref:shared:about_this_documentation.adoc[] +* xref:shared:about_this_documentation.adoc[Introduction] +** xref:shared:about_evergreen.adoc[About Evergreen] diff --git a/docs-antora/modules/acquisitions/nav.adoc b/docs-antora/modules/acquisitions/nav.adoc index 180c6f675c..75af6ced2c 100644 --- a/docs-antora/modules/acquisitions/nav.adoc +++ b/docs-antora/modules/acquisitions/nav.adoc @@ -1,5 +1,4 @@ -* Acquisitions -** xref:acquisitions:introduction.adoc[Introduction] +* xref:acquisitions:introduction.adoc[Acquisitions] ** xref:acquisitions:selection_lists_po.adoc[] ** xref:acquisitions:invoices.adoc[] ** xref:acquisitions:receive_items_from_invoice.adoc[] diff --git a/docs-antora/modules/admin_initial_setup/nav.adoc b/docs-antora/modules/admin_initial_setup/nav.adoc index 18de550cc4..c83b89a382 100644 --- a/docs-antora/modules/admin_initial_setup/nav.adoc +++ b/docs-antora/modules/admin_initial_setup/nav.adoc @@ -1,5 +1,5 @@ -* System Configuration and Customization -** xref:admin_initial_setup:introduction.adoc[Introduction] +* xref:admin_initial_setup:introduction.adoc[System Configuration and +* Customization] ** xref:admin_initial_setup:describing_your_organization.adoc[] ** xref:admin_initial_setup:describing_your_people.adoc[] ** xref:admin_initial_setup:migrating_patron_data.adoc[] diff --git a/docs-antora/modules/api/nav.adoc b/docs-antora/modules/api/nav.adoc index e26cc93715..a13dad7058 100644 --- a/docs-antora/modules/api/nav.adoc +++ b/docs-antora/modules/api/nav.adoc @@ -1,5 +1,4 @@ -* Getting Data from Evergreen -** xref:development:introduction.adoc[Introduction] +* xref:development:introduction.adoc[Getting Data from Evergreen] ** xref:development:data_supercat.adoc[] ** xref:development:data_unapi.adoc[] ** xref:development:data_opensearch.adoc[] diff --git a/docs-antora/modules/api/pages/_attributes.adoc b/docs-antora/modules/api/pages/_attributes.adoc new file mode 100644 index 0000000000..fb982443d7 --- /dev/null +++ b/docs-antora/modules/api/pages/_attributes.adoc @@ -0,0 +1,2 @@ +:moduledir: .. +include::{moduledir}/_attributes.adoc[] diff --git a/docs-antora/modules/appendix/nav.adoc b/docs-antora/modules/appendix/nav.adoc index ab3c74ff22..5f82c6e5d4 100644 --- a/docs-antora/modules/appendix/nav.adoc +++ b/docs-antora/modules/appendix/nav.adoc @@ -1,4 +1,3 @@ -* Appendix -** xref:shared:attributions.adoc[Attributions] -** xref:shared:licensing.adoc[Licensing] -** xref:shared:index.adoc[Index] +* xref:shared:attributions.adoc[Appendix A. Attributions] +* xref:shared:licensing.adoc[Appendix B. Licensing] +* xref:shared:index.adoc[Index] diff --git a/docs-antora/modules/appendix/pages/_attributes.adoc b/docs-antora/modules/appendix/pages/_attributes.adoc new file mode 100644 index 0000000000..fb982443d7 --- /dev/null +++ b/docs-antora/modules/appendix/pages/_attributes.adoc @@ -0,0 +1,2 @@ +:moduledir: .. +include::{moduledir}/_attributes.adoc[] diff --git a/docs-antora/modules/cataloging/nav.adoc b/docs-antora/modules/cataloging/nav.adoc index 5729251ced..0151393884 100644 --- a/docs-antora/modules/cataloging/nav.adoc +++ b/docs-antora/modules/cataloging/nav.adoc @@ -1,5 +1,4 @@ -* Cataloging -** xref:cataloging:introduction.adoc[Introduction] +* xref:cataloging:introduction.adoc[Cataloging] ** xref:cataloging:marc_tag_table.adoc[] ** xref:cataloging:copy-buckets_web_client.adoc[] ** xref:cataloging:item_tags_cataloging.adoc[] diff --git a/docs-antora/modules/circulation/nav.adoc b/docs-antora/modules/circulation/nav.adoc index 939ba4d06c..d0b4eaa4aa 100644 --- a/docs-antora/modules/circulation/nav.adoc +++ b/docs-antora/modules/circulation/nav.adoc @@ -1,5 +1,4 @@ -* Circulation -** xref:circulation:introduction.adoc[Introduction] +* xref:circulation:introduction.adoc[Circulation] ** xref:circulation:circulating_items_web_client.adoc[] ** xref:circulation:basic_holds.adoc[] ** xref:circulation:advanced_holds.adoc[] diff --git a/docs-antora/modules/development/nav.adoc b/docs-antora/modules/development/nav.adoc index dd4ea38f9d..dd0c451b42 100644 --- a/docs-antora/modules/development/nav.adoc +++ b/docs-antora/modules/development/nav.adoc @@ -1,5 +1,4 @@ -* Developer Resources -** xref:development:introduction.adoc[Introduction] +* xref:development:introduction.adoc[Developer Resources] ** xref:development:support_scripts.adoc[] ** xref:development:pgtap.adoc[] ** xref:development:intro_opensrf.adoc[] diff --git a/docs-antora/modules/installation/nav.adoc b/docs-antora/modules/installation/nav.adoc index 02a4222e40..ec0db099ec 100644 --- a/docs-antora/modules/installation/nav.adoc +++ b/docs-antora/modules/installation/nav.adoc @@ -1,5 +1,4 @@ -* Software Installation -** xref:installation:introduction.adoc[Introduction] +* xref:installation:introduction.adoc[Software Installation] ** xref:installation:system_requirements.adoc[System Requirements] ** xref:installation:server_installation.adoc[Installing the Evergreen server] ** xref:installation:server_upgrade.adoc[Upgrading the Evergreen Server] diff --git a/docs-antora/modules/installation/pages/server_installation.adoc b/docs-antora/modules/installation/pages/server_installation.adoc index 85f5920a2d..3f08ea18a0 100644 --- a/docs-antora/modules/installation/pages/server_installation.adoc +++ b/docs-antora/modules/installation/pages/server_installation.adoc @@ -1,6 +1,5 @@ == Installing the Evergreen server == :toc: -:numbered: === Preamble: referenced user accounts === diff --git a/docs-antora/modules/local_admin/nav.adoc b/docs-antora/modules/local_admin/nav.adoc index 05e0d39c24..30fcf92cfc 100644 --- a/docs-antora/modules/local_admin/nav.adoc +++ b/docs-antora/modules/local_admin/nav.adoc @@ -1,5 +1,4 @@ -* Local Administration -** xref:local_admin:introduction.adoc[Introduction] +* xref:local_admin:introduction.adoc[Local Administration] ** xref:admin:librarysettings.adoc[Library Settings Editor] ** xref:admin:lsa-address_alert.adoc[Address Alert] ** xref:admin:lsa-barcode_completion.adoc[Barcode Completion] diff --git a/docs-antora/modules/local_admin/pages/_attributes.adoc b/docs-antora/modules/local_admin/pages/_attributes.adoc new file mode 100644 index 0000000000..fb982443d7 --- /dev/null +++ b/docs-antora/modules/local_admin/pages/_attributes.adoc @@ -0,0 +1,2 @@ +:moduledir: .. +include::{moduledir}/_attributes.adoc[] diff --git a/docs-antora/modules/opac/nav.adoc b/docs-antora/modules/opac/nav.adoc index da2aa6f066..4790f38a2a 100644 --- a/docs-antora/modules/opac/nav.adoc +++ b/docs-antora/modules/opac/nav.adoc @@ -1,5 +1,4 @@ -* Using the Public Access Catalog -** xref:opac:introduction.adoc[Introduction] +* xref:opac:introduction.adoc[Using the Public Access Catalog] ** xref:opac:using_the_public_access_catalog.adoc[] ** xref:opac:my_lists.adoc[] ** xref:opac:batch_actions_from_search.adoc[] diff --git a/docs-antora/modules/reports/nav.adoc b/docs-antora/modules/reports/nav.adoc index fbd54d78b6..61fa241001 100644 --- a/docs-antora/modules/reports/nav.adoc +++ b/docs-antora/modules/reports/nav.adoc @@ -1,5 +1,4 @@ -* Reports -** xref:reports:introduction.adoc[Introduction] +* xref:reports:introduction.adoc[Reports] ** xref:reports:reporter_daemon.adoc[] ** xref:reports:reporter_folder.adoc[] ** xref:reports:reporter_create_templates.adoc[] diff --git a/docs-antora/modules/serials/nav.adoc b/docs-antora/modules/serials/nav.adoc index 1f418c8fe4..11d33ff81e 100644 --- a/docs-antora/modules/serials/nav.adoc +++ b/docs-antora/modules/serials/nav.adoc @@ -1,5 +1,4 @@ -* Serials -** xref:serials:A-intro.adoc[] +* xref:serials:A-intro.adoc[Serials] ** xref:serials:B-serials_admin.adoc[] ** xref:serials:C-serials_workflow.adoc[] ** xref:serials:D-Receiving.adoc[] diff --git a/docs-antora/modules/sys_admin/nav.adoc b/docs-antora/modules/sys_admin/nav.adoc index 18557f38be..661e5af9dd 100644 --- a/docs-antora/modules/sys_admin/nav.adoc +++ b/docs-antora/modules/sys_admin/nav.adoc @@ -1,5 +1,4 @@ -* System Administration From the Staff Client -** xref:sys_admin:introduction.adoc[Introduction] +* xref:sys_admin:introduction.adoc[System Administration From the Staff Client] ** xref:admin:acquisitions_admin.adoc[Acquisitions Administration] ** xref:admin:age_hold_protection.adoc[Age hold protection] ** xref:admin:authorities.adoc[Authorities] diff --git a/docs-antora/modules/sys_admin/pages/_attributes.adoc b/docs-antora/modules/sys_admin/pages/_attributes.adoc new file mode 100644 index 0000000000..fb982443d7 --- /dev/null +++ b/docs-antora/modules/sys_admin/pages/_attributes.adoc @@ -0,0 +1,2 @@ +:moduledir: .. +include::{moduledir}/_attributes.adoc[] diff --git a/docs-antora/modules/using_staff_client/nav.adoc b/docs-antora/modules/using_staff_client/nav.adoc index a5eccb5900..b47b91c63a 100644 --- a/docs-antora/modules/using_staff_client/nav.adoc +++ b/docs-antora/modules/using_staff_client/nav.adoc @@ -1,5 +1,4 @@ -* Using the Browser Staff Client -** xref:using_staff_client:introduction.adoc[Introduction] +* xref:using_staff_client:introduction.adoc[Using the Browser Staff Client] ** xref:admin:web_client-login.adoc[Logging into Evergreen] ** xref:admin:web-client-browser-best-practices.adoc[Best Practices for Using the Browser] ** xref:admin:staff_client-column_picker.adoc[Column Picker] diff --git a/docs-antora/modules/using_staff_client/pages/_attributes.adoc b/docs-antora/modules/using_staff_client/pages/_attributes.adoc new file mode 100644 index 0000000000..fb982443d7 --- /dev/null +++ b/docs-antora/modules/using_staff_client/pages/_attributes.adoc @@ -0,0 +1,2 @@ +:moduledir: .. +include::{moduledir}/_attributes.adoc[]