[OPEN-ILS-DOCUMENTATION] Changing docs filenames to end in .adoc

[Jane Sandberg]

This sounds fantastic.  Thanks you, Robert and Remington, for your work on this!

On Tue, Apr 25, 2017 at 5:57 AM, Remington Steed <rjs7 at calvin.edu> wrote:
> Hi All,
>
> I'm coordinating with Robert, and we plan to make this change today.  I will push the branch to master, 2.12 and 2.11, and Robert is changing the scripts.  When the docs build at 1pm today (EST, I think), the change should be visible on GitHub, with all the docs filenames ending in ".adoc" and being auto-rendered to HTML.
>
> It seems best to follow the developers' schedule of stopping support for older versions, so I don't plan to make this change to 2.10 (which now receives security fixes only).
>
> Feel free to reply with any questions.
>
> Remington
>
> --
> Remington Steed
> Electronic Resources Specialist
> Hekman Library, Calvin College
> http://library.calvin.edu/
>
>
> -----Original Message-----
> From: OPEN-ILS-DOCUMENTATION [mailto:open-ils-documentation-bounces at list.georgialibraries.org] On Behalf Of Jane Sandberg
> Sent: Monday, April 24, 2017 11:10 PM
> To: Documentation discussion for Evergreen software <open-ils-documentation at list.georgialibraries.org>
> Subject: Re: [OPEN-ILS-DOCUMENTATION] Changing docs filenames to end in .adoc
>
> To follow up on this, when should we implement this change?  It would
> be nice to get the .adoc extension changed before our hackfest, so
> that we don't have to deal with a mix of both extensions.
>
> Robert (or anybody else with access to the production docs server),
> how time-consuming would this be on the server side?
>
> Thanks!
>
> On Thu, Apr 13, 2017 at 8:14 AM, Lynn Floyd <lfloyd at andersonlibrary.org> wrote:
>> Thanks Remington,
>>
>>
>>
>> This will be really helpful.
>>
>>
>>
>> Lynn Floyd
>>
>> Lfloyd at andersonlibrary.org
>>
>> Anderson County Library
>>
>> Anderson, SC
>>
>>
>>
>>
>>
>> From: OPEN-ILS-DOCUMENTATION
>> [mailto:open-ils-documentation-bounces at list.georgialibraries.org] On Behalf
>> Of Remington Steed
>> Sent: Thursday, April 13, 2017 10:26 AM
>> To: open-ils-documentation at list.georgialibraries.org
>> Subject: [OPEN-ILS-DOCUMENTATION] Changing docs filenames to end in .adoc
>>
>>
>>
>> Hi Docs People,
>>
>>
>>
>> At the conference, several people revived the idea of using the AsciiDoc
>> filename extension “.adoc” for all of our docs files, especially since
>> GitHub provides an HTML preview of these files.  Here is a working branch
>> that makes the change.  Note: The diff is ugly because every filename is
>> changed.  However, the only file that has changed is root.adoc (formerly
>> root.txt), where all the filename references have changed to “.adoc” as
>> well.
>>
>>
>>
>> http://git.evergreen-ils.org/?p=working/Evergreen.git;a=shortlog;h=refs/heads/user/rsteed/docs_rename_files_to_adoc
>>
>>
>>
>> NOTE: Whenever this is pushed into the main repository, we also need to
>> update the docs build script to point to “root.adoc” instead of “root.txt”.
>>
>>
>>
>> I’ve created a Launchpad bug about it:
>> https://bugs.launchpad.net/evergreen/+bug/1682447
>>
>>
>>
>> Remington
>>
>>
>>
>> --
>>
>> Remington Steed
>>
>> Electronic Resources Specialist
>>
>> Hekman Library, Calvin College
>>
>> http://library.calvin.edu/
>>
>>
>>
>>
>> Lynn Floyd
>> Head of Information Technology
>> Anderson County Library
>> Anderson, SC
>> lfloyd at andersonlibrary.org
>>
>> _______________________________________________
>> OPEN-ILS-DOCUMENTATION mailing list
>> OPEN-ILS-DOCUMENTATION at list.georgialibraries.org
>> http://list.georgialibraries.org/mailman/listinfo/open-ils-documentation
>>
>
>
>
> --
> Jane Sandberg
> Electronic Resources Librarian
> Linn-Benton Community College
> sandbej at linnbenton.edu / 541-917-4655
> Pronouns: she/her/hers or they/them/theirs
> _______________________________________________
> OPEN-ILS-DOCUMENTATION mailing list
> 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



-- 
Jane Sandberg
Electronic Resources Librarian
Linn-Benton Community College
sandbej at linnbenton.edu / 541-917-4655
Pronouns: she/her/hers or they/them/theirs