Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [jakartaee-platform-dev] Is there a way to fix already released documentation for various SPECs?

Hussain,

On 12/13/20 11:38 PM, Hussain.NM@xxxxxxxxxxxxx wrote:

Scott,

 

Can you elaborate on what you mean by “undetected build failures”?

I was wrong about the "undetected build failures" causing the EE 8 Specs to not be correct.  Near the end of the EE 9 Platform TCK development, we had noticed that the Platform TCK documentation had been incorrect for some time but there were no build failures during the TCK build.  Alwin Joseph was able to fix the documentation errors on the weekend of when we wanted to freeze TCK changes, which was good but still leaves unresolved that there can be syntax errors in the asciidoc sources that cause the html/pdf output to be incomplete.

 

Except for the platform spec, all other EE 8 Specs had placeholder documents published at that point in time.

 

Last time I checked about changing existing specification documents it requires to go through a full release review ballot.

Thanks for explaining this! 

Scott

 

Thanks

Hussain

 

From: jakartaee-platform-dev-bounces@xxxxxxxxxxx <jakartaee-platform-dev-bounces@xxxxxxxxxxx> On Behalf Of Scott Marlow
Sent: Saturday, December 12, 2020 8:52 PM
To: jakartaee-platform developer discussions <jakartaee-platform-dev@xxxxxxxxxxx>
Subject: Re: [jakartaee-platform-dev] Is there a way to fix already released documentation for various SPECs?

 

On Sat, Dec 12, 2020, 9:16 AM Scott Marlow <smarlow@xxxxxxxxxx> wrote:

Hi,

 

If someone was to step up to fix the various broken SPEC documents for various projects for EE9, would we be able to update the various https://jakarta.ee/specifications pages?

 

I am more interested in an answer for correcting EE 8 SPEC docs but would be good to have an answer for EE 9 also.

 

 

For example, https://jakarta.ee/specifications/enterprise-beans/3.2/enterprise-beans-spec-3.2.html looks like there were undetected build failures generating the html from asciidoc source. 

 

If we would accept changes via a topic branch, we could probably fix this with the community.

 

Thoughts?

 

Scott

This e-mail and any files transmitted with it are for the sole use of the intended recipient(s) and may contain confidential and privileged information. If you are not the intended recipient(s), please reply to the sender and destroy all copies of the original message. Any unauthorized review, use, disclosure, dissemination, forwarding, printing or copying of this email, and/or any action taken in reliance on the contents of this e-mail is strictly prohibited and may be unlawful. Where permitted by applicable law, this e-mail and other e-mail communications sent to and from Cognizant e-mail addresses may be monitored.
_______________________________________________
jakartaee-platform-dev mailing list
jakartaee-platform-dev@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/jakartaee-platform-dev

Back to the top