[OPEN-ILS-DOCUMENTATION] Preparing the new docs server for production

Remington Steed rjs7 at calvin.edu
Fri Jun 5 10:20:15 EDT 2020


Hi DIG!

I dove into the new docs server yesterday, to get it building both the current docs and the Antora docs (from Blake's working branch for now, until it's properly in master).  Here's where it's at:

What's Working:

  *   Building HTML, EPUB and PDF (via a new process, so it probably looks different), for 3.5 and prior, including the topic manuals
  *   A quick copy of the existing Docs home page, with links to those formats
  *   Adding Antora docs to the build script, in a messy temporary way
  *   Linking to the Antora docs from the home page

Still To Do:

  *   Building the Antora docs properly (e.g. pointing to master instead of the working branch, deciding where the "generate_docs.pl" script should live, putting the main build script in a repository)
  *   Deciding how to handle different release versions in Antora (we probably want to manage this the Antora way, rather than how the current docs build script does)
  *   Testing this new setup!  Clicking links!  Reporting problems to this list!
  *   Deciding how many versions back we want to generate (do we want docs for Evergreen 2.12? 2.0?)
  *   Turning on automatic builds (via crontab), make sure they work
  *   Pointing the official docs domain to this server (and throwing Robert Soulliere a party for all his past work hosting the docs!)

Thoughts?  Questions?  Anything I missed?  We know there's some minor tasks needed to improve the Antora docs, but that shouldn't hold back using the new server for current docs.  Let's get this thing launched!

Remington

--
Remington Steed
Electronic Resources Specialist
Hekman Library, Calvin University
http://library.calvin.edu/
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://list.georgialibraries.org/pipermail/open-ils-documentation/attachments/20200605/bb82f3e3/attachment.html>


More information about the OPEN-ILS-DOCUMENTATION mailing list