> On Jul 14, 2020, at 7:34 PM, David Blevins <david.blev...@gmail.com> wrote:
> 
> I think there are two gaps we need to understand to have a better 
> conversation about using Antora
> 
> - Eliminating the Apache CMS from our lives.  This is the biggest blocker to 
> any true progress.  The only reason our site doesn't automatically update now 
> is because we're using the Apache CMS which has a manual publish step that 
> takes about an hour of machine time and periodic manual checking/poking 
> during that time.
> 
> - Understanding `tomee-site-generator` isn't an enemy to Antora and doesn't 
> need to die or be eliminated.  Among other things, we use it to generate 
> asciidoc content when and where we can.  It will most likely need to run just 
> before Antora.  Antora would be building some mix of manually created docs 
> and some generated docs.  If Antora is not capable of committing generated 
> files to git, then `tomee-site-generator` is where we would do that work.
> 
> I recommend we first eliminate the Apache CMS so we have a hands-free setup.  
> Then I recommend we make it so the `tomee-site-generator` maven project is 
> the thing that kicks off and runs Antora.

I've been doing some research and have some revised thoughts on how we could 
potentially proceed with this.

Being terse as possible so we can try to get this out of discussion/debate mode 
and into action mode.

Many Antora users, including Antora.org itself, seem to use this pattern and I 
think it's probably the one we want.

 - https://antora.org/       -> Built with a general purpose tool 
(Middleman+Asciidoc)
 - https://docs.antora.org/  -> Built with Antora

 - https://getfedora.org/           -> Built with a general purpose tool 
 - https://docs.fedoraproject.org/  -> Built with Antora

 - http://pinot.apache.org/         -> Built with a general purpose tool 
 - https://docs.pinot.apache.org/   -> Built with GitBook

 - https://www.mulesoft.com/        -> Built with a general purpose tool
 - https://docs.mulesoft.com/       -> Built with Antora

If we did this pattern we could probably get it done by end of week:

 - https://tomee.apache.org/        -> Built with tomee-site-generator as is now
 - https://docs.tomee.apache.org/   -> Built with Antora

We would request a new repo not connected to the CMS for docs.tomee.apache.org 
and have David push directly to it right now.  David can lead that effort and 
just inform us on how it goes.

We would then make the "Documentation" navigation item of tomee.apache.org 
point to docs.tomee.apache.org.  We'd still move it off the CMS, but I'm happy 
to do the lifting on that.

I greatly prefer this approach to either 1) endlessly debating tools or 2) 
holding up David's work any longer.

There would still be room for debate, but that debate could happen using the 
staging capabilities of the git-based solution.  I think we'd be in an overall 
better position to introduce more changes with everyone on equal footing.


Thoughts?


-David


Attachment: smime.p7s
Description: S/MIME cryptographic signature

Reply via email to