Re: Making Antora actionable

2020-08-10 Thread David Jencks 
The reason Antora has a separate front page is that Dan didn’t write 
asciidoctor-openblock . Since 
I did, it’s easy to have a front page generated by Antora. He’s known about 
this possibility for at least  5 years, but never found the time or motivation 
to do it.

If you have specific complaints about the front page I wrote, please air them 
rather than ignoring my request for feedback.

Could you be extremely specific about what you want generated by Antora and 
what by tomee-site-generator and what by some other unnamed tool?  Are there 
parts of the current antora preview site that you think should not be generated 
by Antora? (I expect to add examples to the preview shortly, but we can discuss 
that separately).

thanks
David Jencks

> On Aug 10, 2020, at 1:09 PM, David Blevins  wrote:
> 
>> On Jul 14, 2020, at 7:34 PM, David Blevins  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
> 
>

Re: Making Antora actionable

2020-08-10 Thread David Blevins 
> On Jul 14, 2020, at 7:34 PM, David Blevins  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




smime.p7s
Description: S/MIME cryptographic signature

Re: TOMEE-2341 - TomEE Site Generator

2020-08-10 Thread David Blevins 
> On Jun 28, 2020, at 11:08 PM, David Blevins  wrote:
> 
> When we used the Apache CMS we had an extension that would basically grep the 
> source for the example and automatically append this list of links, see "APIs 
> Used" at the bottom:
> 
> - http://tomee.apache.org/examples-trunk/cdi-request-scope/README.html
> 
> The improvement part is since we are aggregating and publishing all the 
> Jakarta EE and MicroProfile javadocs on the TomEE website, let's link to 
> those Javadocs and while we're at it make them link back to the example.

I gave this another push to get it over the finish line and it feels really 
great.  I've been taking baby steps towards this for a long time.

= APIs Used

At the bottom of every example page there is an "APIs Used" section that links 
to any javadoc we have in our site that could apply to the example.  For 
example the Simple Singleton example:

 - http://tomee.staging.apache.org/tomee-9.0/examples/simple-singleton.html

Has a link to this Javadoc page:

 - http://tomee.staging.apache.org/jakartaee-9.0/javadoc/jakarta/ejb/Lock.html


= @examples Javadoc tag

On the page above we see there are now three new sections "Examples (en):", 
"Examples (es):" and "Examples (en):"  We're getting these by putting a custom 
javadoc tag (@example.en, @example.es, @example.pt) in the applicable java 
files before we generate the Javadoc.

There's logic to pick only the most recent version of the example.  There's 
also logic to sort the examples list so that the examples with the largest 
README.adoc are first.

With these two features you can bounce back and forth between examples and 
javadocs at will.


= Covers all APIs

As mentioned it works for any javadoc we publish.  Currently we publish javadoc 
for TomEE, Jakarta EE 8, Jakarta EE 9 and MicroProfile 2.

Some Jakarta EE 9 APIs we have examples for:

 - 
http://tomee.staging.apache.org/jakartaee-9.0/javadoc/jakarta/json/bind/Jsonb.html
 - 
http://tomee.staging.apache.org/jakartaee-9.0/javadoc/jakarta/ws/rs/PathParam.html
 - 
http://tomee.staging.apache.org/jakartaee-9.0/javadoc/jakarta/ejb/Startup.html

Some Jakarta EE 9 APIs we have examples for:

 - 
http://tomee.staging.apache.org/jakartaee-8.0/javadoc/javax/jms/MessageListener.html
 - 
http://tomee.staging.apache.org/jakartaee-8.0/javadoc/javax/persistence/EntityManager.html
 - 
http://tomee.staging.apache.org/jakartaee-8.0/javadoc/javax/ejb/ActivationConfigProperty.html

Some MicroProfile 2 APIs we have examples for:

 - 
http://tomee.staging.apache.org/microprofile-2.0/javadoc/org/eclipse/microprofile/health/HealthCheck.html
 - 
http://tomee.staging.apache.org/microprofile-2.0/javadoc/org/eclipse/microprofile/config/inject/ConfigProperty.html
 - 
http://tomee.staging.apache.org/microprofile-2.0/javadoc/org/eclipse/microprofile/metrics/annotation/Gauge.html

And of course we are using various TomEE APIs in our examples and those are 
marked up too:

 - 
http://tomee.staging.apache.org/tomee-9.0/javadoc/org/apache/openejb/junit/ApplicationComposer.html
 - 
http://tomee.staging.apache.org/tomee-9.0/javadoc/org/apache/openejb/testing/Module.html
 - 
http://tomee.staging.apache.org/tomee-9.0/javadoc/org/apache/openejb/jee/EjbJar.html


= Fancy icon for each Javadoc

And because I like these kinds of details, notice each Javadoc has a favicon 
with the appropriate logo.  The Jakarta stuff uses the sailboat, the 
MicroProfile javadocs use the 'M' logo, and of course the TomEE stuff uses the 
feather.


-David



smime.p7s
Description: S/MIME cryptographic signature

Re: Issue of the JIRA TOMEE-2897 - Translate to Portuguese: examples/singleton-startup-ordering

2020-08-10 Thread Daniel Dias Dos Santos 
Hello Evaldo,

already assign the ticket to you.

thanks.
--

*Daniel Dias dos Santos*
Java Developer
SouJava & JCP Member
GitHub: https://github.com/Daniel-Dos
Linkedin: www.linkedin.com/in/danieldiasjava
Twitter: http://twitter.com/danieldiasjava


Em seg., 10 de ago. de 2020 às 01:03, Evaldo Junior <
evaldoapjun...@gmail.com> escreveu:

> I created the issue on the JIRA [1] to translate to portugueses of the
> document examples/singleton-startup-ordering/.
> Can some of the JIRA admins please assign the ticket to my
> username:evaldoapjunior
>
> [1]https://issues.apache.org/jira/browse/TOMEE-2897
>
>
> Regards,
>
>
> Evaldo Junior
>
> >
>

AW: TomEE 8.0.4 - Webprofile - Download Link broken?

2020-08-10 Thread Zowalla, Richard 


It seems to be available via Maven: 

https://repo1.maven.org/maven2/org/apache/tomee/apache-tomee/8.0.4/

and

https://repo1.maven.org/maven2/org/apache/tomee/apache-tomee/8.0.4/apache-tomee-8.0.4-webprofile.zip

https://repo1.maven.org/maven2/org/apache/tomee/apache-tomee/8.0.4/apache-tomee-8.0.4-webprofile.tar.gz

But not via our download page.

Richard


Von: Jonathan Gallimore [jonathan.gallim...@gmail.com]
Gesendet: Montag, 10. August 2020 17:45
An: dev@tomee.apache.org
Betreff: Re: TomEE 8.0.4 - Webprofile - Download Link broken?

It looks like it was missed from the VOTE directory. We might need a vote
to get that extra binary up. Do any other committers know what we might
need to do here?

Jon

On Mon, Aug 10, 2020 at 10:22 AM Zowalla, Richard <
richard.zowa...@hs-heilbronn.de> wrote:

> Hi,
>
> did we miss the "webprofile" TomEE 8.0.4 package in the latest release?
>
> The links on https://tomee.apache.org/download-ng.html target
>
>
> https://www.apache.org/dyn/closer.cgi/tomee/tomee-8.0.4/apache-tomee-8.0.4-webprofile.zip
>
>
> https://www.apache.org/dyn/closer.cgi/tomee/tomee-8.0.4/apache-tomee-8.0.4-webprofile.tar.gz
>
> which are "dead" links.
>
> Any ideas?
>
> Best,
> Richard
>

Re: TomEE 8.0.4 - Webprofile - Download Link broken?

2020-08-10 Thread Jonathan Gallimore 
It looks like it was missed from the VOTE directory. We might need a vote
to get that extra binary up. Do any other committers know what we might
need to do here?

Jon

On Mon, Aug 10, 2020 at 10:22 AM Zowalla, Richard <
richard.zowa...@hs-heilbronn.de> wrote:

> Hi,
>
> did we miss the "webprofile" TomEE 8.0.4 package in the latest release?
>
> The links on https://tomee.apache.org/download-ng.html target
>
>
> https://www.apache.org/dyn/closer.cgi/tomee/tomee-8.0.4/apache-tomee-8.0.4-webprofile.zip
>
>
> https://www.apache.org/dyn/closer.cgi/tomee/tomee-8.0.4/apache-tomee-8.0.4-webprofile.tar.gz
>
> which are "dead" links.
>
> Any ideas?
>
> Best,
> Richard
>

TomEE 8.0.4 - Webprofile - Download Link broken?

2020-08-10 Thread Zowalla, Richard 
Hi,

did we miss the "webprofile" TomEE 8.0.4 package in the latest release?

The links on https://tomee.apache.org/download-ng.html target

https://www.apache.org/dyn/closer.cgi/tomee/tomee-8.0.4/apache-tomee-8.0.4-webprofile.zip

https://www.apache.org/dyn/closer.cgi/tomee/tomee-8.0.4/apache-tomee-8.0.4-webprofile.tar.gz

which are "dead" links.

Any ideas?

Best,
Richard


smime.p7s
Description: S/MIME cryptographic signature