Re: Antora for Docs: making sure our contributors are on board

["Brian (bex) Exelbierd" <bexelbie@xxxxxxxxxx>]

On Wed, Aug 15, 2018 at 7:48 AM, Leslie S Satenstein <lsatenstein@xxxxxxxxx> wrote:

I ran into some issues while editing the *.adocs on my own system.

My method had several steps.

clone a specific git repository

use the script below to create the local html output via firefox.

copy the firefox output to libreoffice.

Edit the libreoffice file for grammar, using standard review  tools.

After edit, transfer the LibreOffice review tool changes to the

corresponding *.adoc file.

For what it is worth, here is the script that I wrote and used.

#!/bin/bash
# adoc.sh   April 2018
#
if [ $# = 0 ];
then
   echo "command is  $0 AnAdocFile.adoc "
   echo "output to /tmp/asciidoc.html "
   echo "Also creates a /tmp/x.sh pointing vim to the AnAdocFile.adoc"
   exit 0
fi
bn=$(basename $1 .adoc)
dn=$(pwd)
inadoc=${bn}.adoc
asciidoctor -o /tmp/${bn}.html ${bn}.adoc 2>/tmp/${bn}.errs
firefox /tmp/${bn}.html
echo "vim ${dn}/$inadoc " >/tmp/x.sh
chmod 755 /tmp/x.sh
clear
ls -l
#

The adoc file that I needed to match to the LO output was available via /tmp/x.sh

What is the advantage of proofing with LO writer?   Ans.Markups are visible  and available for review by multiple other parties. (collaboration)

Difficulties encountered.    The adoc files were unraveled. That is, from the git repository, a single text line represents represents a paragraph.  Matching LO markup to the adoc files necessitated the above approach

In the .adoc files we are working to changing to single line == single sentence structure.  This makes diffs much cleaner.

 

Other comments.

I would like the *.adoc tools (asciidoctor) to be entirely available within rpmfusion. 

You'll need to take this up with the folks at rpmfusion.

I encourage you to use the asciidoctor that is packaged in Fedora instead.  Antora is not yet packaged, but will be soon, however, if you use the suggested docker containers you won't need it.

regards,

bex

 

Regards

 Leslie

Leslie Satenstein

Montréal Québec, Canada

On Tuesday, July 17, 2018, 2:54:46 a.m. EDT, Adam Samalik <asamalik@xxxxxxxxxx> wrote:

I've made a template repo here: (note the antora branch)

https://pagure.io/fedora-docs/template/branch/antora

On Tue, Jul 17, 2018 at 2:32 AM Justin W. Flory <jflory7@xxxxxxxxx> wrote:

On 07/03/2018 03:19 AM, Adam Samalik wrote:
> Hey Justin,
>
> There will be some slight changed to the source repo, too. But don't
> worry, no format changes (it's still asciidoc), just the structure and
> the definition of the menu on the left will be a bit different. I'll
> prepare materials with all the info needed for you to switch. Also happy
> to assist.
>

Sounds good to me. Just so I make sure I actually learn and understand
what I'm doing, I want to get a grip for what's going on and what the
best practices are. Once there are resources in place for this, please
let us know on the list. :-)

--
Cheers,
Justin W. Flory
jflory7@xxxxxxxxx

_______________________________________________
docs mailing list -- docs@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to docs-leave@lists.fedoraproject.org
Fedora Code of Conduct: https://getfedora.org/code-of-conduct.html
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/docs@lists.fedoraproject.org/message/EJ7RNTIIB4J46Z4SW4PJPINBENSOHP4K/

--

Adam Šamalík
---------------------------

Software Engineer
Red Hat

_______________________________________________
docs mailing list -- docs@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to docs-leave@lists.fedoraproject.org
Fedora Code of Conduct: https://getfedora.org/code-of-conduct.html
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines

List Archives: https://lists.fedoraproject.org/archives/list/docs@lists.fedoraproject.org/message/N3XZGIXJCRVTYQ6KG6TKXM6DH5QZIV3O/

--

Brian (bex) Exelbierd | bexelbie@xxxxxxxxxx | bex@xxxxxxxxx
Fedora Community Action & Impact Coordinator
@bexelbie | http://www.winglemeyer.org

_______________________________________________
docs mailing list -- docs@xxxxxxxxxxxxxxxxxxxxxxx
To unsubscribe send an email to docs-leave@xxxxxxxxxxxxxxxxxxxxxxx
Fedora Code of Conduct: https://getfedora.org/code-of-conduct.html
List Guidelines: https://fedoraproject.org/wiki/Mailing_list_guidelines
List Archives: https://lists.fedoraproject.org/archives/list/docs@xxxxxxxxxxxxxxxxxxxxxxx/message/QGZAWMDTEZ6GP3AFLPOPJRA4WT2VYU76/