From 93cb9dbb1a4e623a399bf155f20c6be72e04dcbc Mon Sep 17 00:00:00 2001 From: Remington Steed Date: Wed, 23 Oct 2019 14:55:03 -0400 Subject: [PATCH] Docs: Move subnavs into appropriate modules Let's try the built-in modularized nav setup. Signed-off-by: Remington Steed --- docs-antora/antora.yml | 3 +++ docs-antora/modules/ROOT/nav.adoc | 22 ---------------------- docs-antora/modules/local_admin/_attributes.adoc | 4 ++++ .../nav_local_admin.adoc => local_admin/nav.adoc} | 2 +- docs-antora/modules/sys_admin/_attributes.adoc | 4 ++++ .../nav_sys_admin.adoc => sys_admin/nav.adoc} | 2 +- .../modules/using_staff_client/_attributes.adoc | 4 ++++ .../nav.adoc} | 2 +- 8 files changed, 18 insertions(+), 25 deletions(-) create mode 100644 docs-antora/modules/local_admin/_attributes.adoc rename docs-antora/modules/{ROOT/pages/_partials/nav_local_admin.adoc => local_admin/nav.adoc} (97%) create mode 100644 docs-antora/modules/sys_admin/_attributes.adoc rename docs-antora/modules/{ROOT/pages/_partials/nav_sys_admin.adoc => sys_admin/nav.adoc} (97%) create mode 100644 docs-antora/modules/using_staff_client/_attributes.adoc rename docs-antora/modules/{ROOT/pages/_partials/nav_using_staff_client.adoc => using_staff_client/nav.adoc} (92%) diff --git a/docs-antora/antora.yml b/docs-antora/antora.yml index 0c29537380..1d60371bdc 100644 --- a/docs-antora/antora.yml +++ b/docs-antora/antora.yml @@ -3,3 +3,6 @@ title: docs version: 'latest' nav: - modules/ROOT/nav.adoc +- modules/using_staff_client/nav.adoc +- modules/sys_admin/nav.adoc +- modules/local_admin/nav.adoc diff --git a/docs-antora/modules/ROOT/nav.adoc b/docs-antora/modules/ROOT/nav.adoc index 715e5230e7..e2d90d6cf1 100644 --- a/docs-antora/modules/ROOT/nav.adoc +++ b/docs-antora/modules/ROOT/nav.adoc @@ -1,25 +1,3 @@ * Software Installation * System Configuration and Customization -* Using the Browser Staff Client -+ -include::partial$nav_using_staff_client.adoc[] -+ -* System Administration From the Staff Client -+ -include::partial$nav_sys_admin.adoc[] -+ -* Local Administration -+ -include::partial$nav_local_admin.adoc[] -+ -* Acquisitions -* Cataloging -** xref:cataloging:batch_importing_MARC.adoc[Batch Importing MARC Records] -* Serials -* Circulation -** xref:circulation:advanced_holds.adoc[Advanced Holds] -* Reports -* Using the Public Access Catalog -* Developer Resources -* Getting Data from Evergreen diff --git a/docs-antora/modules/local_admin/_attributes.adoc b/docs-antora/modules/local_admin/_attributes.adoc new file mode 100644 index 0000000000..dec438a296 --- /dev/null +++ b/docs-antora/modules/local_admin/_attributes.adoc @@ -0,0 +1,4 @@ +:attachmentsdir: {moduledir}/assets/attachments +:examplesdir: {moduledir}/examples +:imagesdir: {moduledir}/assets/images +:partialsdir: {moduledir}/pages/_partials diff --git a/docs-antora/modules/ROOT/pages/_partials/nav_local_admin.adoc b/docs-antora/modules/local_admin/nav.adoc similarity index 97% rename from docs-antora/modules/ROOT/pages/_partials/nav_local_admin.adoc rename to docs-antora/modules/local_admin/nav.adoc index 61045292a5..99660992fa 100644 --- a/docs-antora/modules/ROOT/pages/_partials/nav_local_admin.adoc +++ b/docs-antora/modules/local_admin/nav.adoc @@ -1,4 +1,4 @@ -:page-partial: +* 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/sys_admin/_attributes.adoc b/docs-antora/modules/sys_admin/_attributes.adoc new file mode 100644 index 0000000000..dec438a296 --- /dev/null +++ b/docs-antora/modules/sys_admin/_attributes.adoc @@ -0,0 +1,4 @@ +:attachmentsdir: {moduledir}/assets/attachments +:examplesdir: {moduledir}/examples +:imagesdir: {moduledir}/assets/images +:partialsdir: {moduledir}/pages/_partials diff --git a/docs-antora/modules/ROOT/pages/_partials/nav_sys_admin.adoc b/docs-antora/modules/sys_admin/nav.adoc similarity index 97% rename from docs-antora/modules/ROOT/pages/_partials/nav_sys_admin.adoc rename to docs-antora/modules/sys_admin/nav.adoc index d85fb4c0b0..4259398ed8 100644 --- a/docs-antora/modules/ROOT/pages/_partials/nav_sys_admin.adoc +++ b/docs-antora/modules/sys_admin/nav.adoc @@ -1,4 +1,4 @@ -:page-partial: +* 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/using_staff_client/_attributes.adoc b/docs-antora/modules/using_staff_client/_attributes.adoc new file mode 100644 index 0000000000..dec438a296 --- /dev/null +++ b/docs-antora/modules/using_staff_client/_attributes.adoc @@ -0,0 +1,4 @@ +:attachmentsdir: {moduledir}/assets/attachments +:examplesdir: {moduledir}/examples +:imagesdir: {moduledir}/assets/images +:partialsdir: {moduledir}/pages/_partials diff --git a/docs-antora/modules/ROOT/pages/_partials/nav_using_staff_client.adoc b/docs-antora/modules/using_staff_client/nav.adoc similarity index 92% rename from docs-antora/modules/ROOT/pages/_partials/nav_using_staff_client.adoc rename to docs-antora/modules/using_staff_client/nav.adoc index ba71597ba0..d945ccddc3 100644 --- a/docs-antora/modules/ROOT/pages/_partials/nav_using_staff_client.adoc +++ b/docs-antora/modules/using_staff_client/nav.adoc @@ -1,4 +1,4 @@ -:page-partial: +* 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] -- 2.11.0