[OPEN-ILS-DOCUMENTATION] Antora update

[Blake Henderson]

Remington,

Thanks for the confirmation. Are we talking about needing to introduce 
the root.adoc? There is a mandatory module called "ROOT" - seems 
appropriate. Though, looking at one example "allowed_payments.adoc" - it 
seems to be a child of "Chapter 35. Working with money" which is under 
"Part IX. Circulation administration"

So maybe we just integrate it into the nav?

This brings up the question of reusable docs. Places where the same doc 
is used multiple times. Antora, of course, has a mechanism for this but 
I don't think we are setting it up with this in mind yet. It seems that 
these missing docs might* be a member of this group?

-Blake-
Conducting Magic
MOBIUS
573-234-4513
877-312-3517

On 6/4/2020 10:33 AM, Remington Steed wrote:
> Blake (and everyone),
>
> Thanks for digging into this.  I think you're guess is right about the 
> other root files being the key to those lost chunks. I've seen a few 
> cases where new docs were added in a new adoc file, but then that file 
> was only included in a "root_*.adoc" file, not the main "root.adoc".  
> And I'm sure I've only been working from the main root file whenever 
> I've reviewed the Antora docs.
>
> I think those files should be added to an appropriate place in the 
> "root.adoc" file.  Then, I think we should decide that Antora will be 
> the real docs site for Evergreen 3.6 (in the fall).  (And we should 
> broadly share the link as the new, soon to be released docs site.)  
> That will hopefully give everyone the incentive to test and fix any 
> major problems that remain.
>
> Remington
>
> --
> Remington Steed
> Electronic Resources Specialist
> Hekman Library, Calvin University
> http://library.calvin.edu/
> ------------------------------------------------------------------------
> *From:* OPEN-ILS-DOCUMENTATION 
> <open-ils-documentation-bounces at list.georgialibraries.org> on behalf 
> of Blake Henderson <blake at mobiusconsortium.org>
> *Sent:* Monday, May 18, 2020 3:01 PM
> *To:* open-ils-documentation at list.georgialibraries.org 
> <open-ils-documentation at list.georgialibraries.org>
> *Subject:* [OPEN-ILS-DOCUMENTATION] Antora update
> All,
>
> (sending this again but this time as a new thread, in case replying to 
> an eight-month-old message got filtered in your inbox)
>
> 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 
> <https://urldefense.proofpoint.com/v2/url?u=http-3A__eg-2Ddocs.georgialibraries.org_prod_docs_latest_admin_audio-5Falerts.html&d=DwMDaQ&c=4rZ6NPIETe-LE5i2KBR4rw&r=XMUuJ_zlJ9I1qg9tP7WLhw&m=5nGc7mOln81CyvXASYdtbpNJmLtMu5i7IG8BGoh6dPA&s=H8rubWJRcuRcH0I2NHaqlThcyLMPpRKPC0s9-mpLZ_M&e=>
>
> 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
>
>
> _______________________________________________
> 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/20200604/3f9dc3a1/attachment.html>