[OPEN-ILS-DOCUMENTATION] Progress on managing our docs with Antora

[Blake Henderson]

All,

I've been combing over the admin module. There are 72 asciidoc 
(documents modules/admin/pages/)

It seems that there is some organization issues here.  For example, 
allowed_payments.adoc is not linked or included in Antora docs. It seems 
it used to be included in the old docs/"root_staff_client_admin.adoc"

It appears that some of this documentation has been removed? Or rather, 
those "root" adoc files might hold the key to connecting these?

complete list of un-referenced admin modules:
allowed_payments.adoc
audio_alerts.adoc
circing_uncataloged_materials.adoc
closed_dates.adoc
ebook_api.adoc
hours.adoc
patron_registration.adoc
purge_holds.adoc
purge_user_activity.adoc
qstore_service.adoc
search_settings_web_client.adoc
security.adoc
sitemap_admin.adoc
staff_from_command_line.adoc


Though, these "lost" documents are available in Antora using the search 
feature:

http://eg-docs.georgialibraries.org/prod/docs/latest/admin/audio_alerts.html

notice the lack of breadcrumbs on that page. Antora still consumes these 
documents, they are simply not listed in any navigation.


I've gone ahead and pushed the "upgraded headings" for the admin module 
to the collab branch.


-Blake-
Conducting Magic
MOBIUS

On 10/25/2019 12:12 PM, Deborah Luchenbill wrote:
> This is great!  Thanks, Blake and Remington (and anyone else who 
> helped!), for all the work getting Antora docs ready!!
>
> Debbie
>
> Debbie Luchenbill
> Evergreen Coordinator
> MOBIUS
> 111 E. Broadway, Ste. 220
> Columbia, MO  65203
> debbie at mobiusconsortium.org <mailto:deborah at mobiusconsortium.org>
> 573-234-4914
> https://mobiusconsortium.org <http://mobiusconsortium.org>
> Evergreen Help Desk: help at mobiusconsortium.org 
> <mailto:help at mobiusconsortium.org> / 877-312-3517
> Pronouns: She/Her/Hers
>
>
> On Thu, Oct 24, 2019 at 1:21 PM Remington Steed <rjs7 at calvin.edu 
> <mailto:rjs7 at calvin.edu>> wrote:
>
>     Hi all,
>
>     At the hack-a-way, several of us worked on setting up Antora to
>     manage our docs.  We have an LP bug
>     (1848524<https://bugs.launchpad.net/evergreen/+bug/1848524>) and a
>     collab branch ready for anyone who wants to check it out or help:
>
>     https://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/collab/blake/LP1848524_antora_ize_docs
>
>     To test it, you'll need to install Antora and use our branch to
>     build the HTML, but you can commit changes without testing.  See
>     Blake's README for setup instructions:
>
>     https://git.evergreen-ils.org/?p=working/Evergreen.git;a=blob;f=docs-antora/README.adoc;h=27ab8ac8d6e3676d8e9ad50ec76aad5d7a8d74d0
>
>     Galen hopes to have a new community DIG server ready in a few
>     weeks.  When that's ready, we'd love to have Antora ready to go,
>     probably just for the master and 3.4 docs.
>
>     Feel free to reply with questions.  Also, I'll add Antora to our
>     Nov 7 DIG meeting agenda.
>
>     Remington
>
>     --
>     Remington Steed
>     Electronic Resources Specialist
>     Hekman Library, Calvin University
>     http://library.calvin.edu/
>
>     _______________________________________________
>     OPEN-ILS-DOCUMENTATION mailing list
>     OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
>     <mailto:OPEN-ILS-DOCUMENTATION at list.georgialibraries.org>
>     http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
>
>
> _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://list.georgialibraries.org/pipermail/open-ils-documentation/attachments/20200512/cdd0b8fd/attachment.html>