Please review and merge the following PRs:
#105 – 4.0.0-RC2
-
Straight-forward merge of 4.0.0-RC2 branch into master.
-
The ECA is failing due to ejb-bot. After merging please delete the following branches:
o
4.0.0-RC1
o
4.0.0-RC2
#103 – Replace PNG images with SVG
-
All PNG images are re-created into SVG format on a best-effort basis.
-
One bug fix is included – inline image changed to block image in few places which I missed earlier.
#106 – Fix Javadoc warnings
-
Removed the doclint none option from maven-javadoc-configuration and cleaned up all the javadoc errors and warning.
-
Generic @param and @return description is added where it was missing earlier. This can be improved in a future PR.
#109 – Cleanup pom
-
Updated plugins to latest version
-
From parent project “mvn clean install” will generate a zip file with apidocs and specification documents.
A new job in Jenkins needs to be created to generate the above artifact. This can be used as source for raising PR in jakartaee/specifications
-
The parent tag is removed from both root and spec projects (these projects are not meant to be published to maven central so there is no need for ee4j-parent)
-
The groupId and artifactId of root and spec projects is made consistent with api project. There is no impact of this change since the root and spec
projects are not published.
-
Added project information such as organization, scm, issueManagement and mailingList
-
Added EFSL 1.0 license in root and spec pom
-
Change findbugs-maven-plugin to spotbugs-maven-plugin
-
Fix “mvn site” in api project. Added spotbugs and Javadoc to site.
Thanks
Hussain
From: N M, Hussain (Cognizant) <Hussain.NM@xxxxxxxxxxxxx>
Sent: Saturday, May 9, 2020 10:14 AM
To: ejb developer discussions <ejb-dev@xxxxxxxxxxx>
Subject: Re: [ejb-dev] Format Specification PR
Thanks Tracy for reviewing and merging the PRs.
I have created a new pull request
#103 which replaces the PNG images with SVG.
Edwin has started work on removal of sections as per the Release Plan.
I will start working on reviewing and updating the Related documents.
I created a PR
#96 for converting the Optional Features document to Jakarta EE.
Please review and merge the following PRs:
#93 - Convert to Jakarta EE
#96 - Format and convert Optional Features document for Jakarta
EE
I have the SVG images ready for Core document.
I am optimizing the SVG images for Optional document.
Once the above PRs are merged, I will create a PR to update the images.
Next items:
-
Create an issue with each line item in 4.0 Release Plan
-
Update the following sections:
-
Introduction
-
What's New in 4.0
-
Acknowledgement
-
Revision History
-
Related Documents
Thanks Tracy and Ed for reviewing and merging the PRs.
I have moved the PR
#93 out of draft status. Summarizing the changes below:
-
Java EE to Jakarta EE
-
EJB, Enterprise JavaBeans to Enterprise Beans
-
EJB references to enterprise bean references
-
EJB Container Provider to Container Provider
-
Java Persistence API to Jakarta Persistence
-
JTA to Jakarta Transactions
-
JMS to Jakarta Messaging
-
JAX-WS to Jakarta XML Web Services
-
JAX-RS to Jakarta RESTful Web Services
-
JAX-RPC to Jakarta XML RPC
-
JCA to Jakarta Connectors
-
Interceptor to Jakarta Interceptor
-
Java Mail to Jakarta Mail
-
Web Services for Java EE to Jakarta Enterprise Web Services
-
Namespace changes
-
javax.ejb -> jakarta.ejb
-
javax.xml.ws -> jakarta.xml.ws
-
javax.jms -> jakarta.jms
-
javax.mail -> jakarta.mail
-
javax.transaction -> jakarta.transaction
-
javax.enterprise -> jakarta.enterprise
-
javax.ws.rs -> jakarta.ws.rs
-
Replaced Deployment Descriptor schema with ejb-jar_4_0.xsd in Chapter 14
Question: I have the images ready, should I add it to #93 or create a separate PR for it?
I will work on formatting the Optional specification document.
I would like to bring your attention to following open Pull Requests:
#92 - Fix broken footnote and missing note label in table
#90 - Format Chapters 13-15
#91 - Format Chapter 16-19
Once the above pull request are reviewed and merged, I will push the changes for remaining chapters in
#93 - Conversion to Jakarta EE
The last PR to complete the conversion will be fixing the related documents
#75 - Create bibliography for Related Documents
I have raised a PR in jakartaee-schemas to update the deployment descriptor for next release. Also I need the contents of ejb-jar.xsd to be imported in Chapter 14. Deployment Descriptor
#3 - Prepare Enterprise Beans Deployment
Descriptor for 4.0
Currently I am working on re-creating the images in SVG format. I will create that pull request after #93 is merged to master.
Even if you are not a committer, please review the PR and leave a comment or drop a note here. Based on reviews by contributors, the committers can approve and merge the PRs.
The changes you describe all look good to me. I haven't looked at the preview yet...
I have created a draft pull request
#93 with changes from Java EE to Jakarta EE for Chapters 1-10.
Changes I have made:
·
As per the
Jakarta Brand guidelines, I have added the registered symbol after Jakarta in the first place a particular Jakarta project is mentioned.
·
For Enterprise JavaBeans and EJB I have replaced it with Enterprise Beans, in some places I have omitted Enterprise Beans. For e.g., in section 2.2.4, "the EJB Server Provider
and the EJB Container Provider" is changed to "the Server Provider and the Container Provider".
·
For references to older versions like EJB 1.x, 2.x, 3.x I have changed it to Enterprise Beans 1.x, 2.x, 3.x. My assumption is since we are continuing the same work with a new
name the older versions should also be referred with the new name.
·
I have not made any changes to Java SE references.
·
Chapter 10 has references to J2SE 1.2, J2SE 1.3, J2EE 1.2, J2EE 1.3. Except these I have changed other references to Jakarta. As per the release plan this chapter will be removed.
Preview is available in my fork:
https://hussainnm.github.io/ejb-api/
Please review and let me know your suggestions and comments.
Thanks
Hussain
Thanks Bill, I will keep these points in mind when making the changes.
This is very close, thanks for doing this!
We sometimes drop "Jakarta" from the beginning of the name after first use, if the resulting name is clear in context and the shorter name makes it easier to read.
"Specification" is rarely part of the official name, but "specification" is often used in context when needed. I don't have a precise rule but usually I use "specification" when it's necessary to refer to the document itself, e.g., to refer to a chapter or
page or table.
It's often better to rewrite the spec to avoid the need to refer to previous non-Jakarta versions of the spec, but I know that sometimes that's difficult.
Anyway, I think this is more than close enough to go with. Some of the tweaks suggested above can be applied later if needed.
I have created the PRs for remaining chapters(#86 to #91).
I have collected the following words that needs to change from Java EE to Jakarta EE. Please review and let me know if my understanding is correct to proceed.
|
Existing
|
New
|
|
Enterprise JavaBeans
|
Jakarta Enterprise Beans
|
|
Enterprise JavaBeans™
|
|
EJB 3.2
|
Jakarta Enterprise Beans 3.2
|
|
EJB Container
|
Jakarta Enterprise Beans Container
|
|
EJB Server
|
Jakarta Enterprise Beans Server
|
|
EJB Lite
|
Jakarta Enterprise Beans Lite
|
|
EJB API
|
Jakarta Enterprise Beans API
|
|
EJB specification
|
Jakarta Enterprise Beans specification
|
|
EJB 1.x, 2.x, 3.x
|
Enterprise JavaBeans™ 1.x, 2.x, 3.x
|
|
Java Platform, Enterprise Edition
|
Jakarta EE
|
|
Java EE
|
|
Java EE Platform
|
Jakarta EE Platform
|
|
Web Profile
|
Jakarta EE Web Profile
|
|
JAX-RPC
|
Jakarta XML RPC
|
|
JAX-WS
|
Jakarta XML Web Services Specification
|
|
Web Services for Java EE
|
Jakarta Enterprise Web Services
|
|
JAX-RS
|
Jakarta RESTful Web Services
|
|
JTA
|
Jakarta Transactions
|
|
JMS
|
Jakarta Messaging
|
|
Java Persistence API
|
Jakarta Persistence
|
|
Connector architecture
|
Jakarta Connectors
|
|
Java programming language
|
Java™ programming language
|
|
Java SE platform
|
Java™ SE platform
|
|
Java 2 Platform
|
|
J2SE
|
|
Java RMI
|
Java™ RMI
|
|
JNDI
|
JNDI™
|
|
JDBC
|
JDBC™
|
Sample taken from Chapter 6
|
Before
|
After
|
|
The model for persistence and
object/relational mapping was considerably revised and enhanced in the
Enterprise JavaBeans 3.0 release. The contracts and requirements for
persistent entities are defined by the "_Java Persistence API_"
specification <<a9851>>, which also contains
the full specification of the Java Persistence query language and the
metadata for object/relational mapping.
The client view of entity beans under the
earlier EJB 2.1 programming model, the contracts for EJB 2.1 Entity
Beans with Container-Managed Persistence, the contracts for the EJB QL
query language, the contracts for EJB 2.1 Entity Beans with Bean-Managed
Persistence, and the contracts for EJB 1.1 Entity Beans with
Container-Managed Persistence are described in the EJB Optional Features
document
|
The model for persistence and
object/relational mapping was considerably revised and enhanced in the
Enterprise JavaBeans™ 3.0 release. The contracts and requirements for
persistent entities are defined by the "_Jakarta Persistence_"
specification <<a9851>>, which also contains
the full specification of the Jakarta Persistence query language and the
metadata for object/relational mapping.
The client view of entity beans under the
earlier Enterprise JavaBeans™ 2.1 programming model,
the contracts for Enterprise JavaBeans™ 2.1 Entity
Beans with Container-Managed Persistence,
the contracts for the Enterprise JavaBeans™ QL
query language,
the contracts for Enterprise JavaBeans™ 2.1 Entity Beans with Bean-Managed
Persistence, and
the contracts for Enterprise JavaBeans™ 1.1 Entity Beans with
Container-Managed Persistence are described in the
Jakarta Enterprise Beans Optional Features
document
|
Thanks
Hussain
Thanks Tracy for reviewing and merging.
I fixed the merge conflicts on PR# 84 and 85. I reviewed both PRs and pushed some more changes:
·
Replaced empty description list to indent paragraph with sidebar block
·
Changed footnotes inside table to table end notes (notes are placed immediately after the table)
I completed formatting of all chapters. Just need to rebase them on top of current master and create Pull Requests.
Next, I am going to work on changing Java EE references to Jakarta EE.
Thanks
Hussain
Approved and merged PR #76. Will try to complete my review for 84 and 85 tomorrow.
-- Tracy Burroughs (tkb@xxxxxxxxxx)
-- WebSphere Application Server Development
-- IBM Rochester, Dept WG8A H315/050-2
-- 2800 37th Street NW, Rochester MN 55901-4441
From: <Hussain.NM@xxxxxxxxxxxxx>
To: <ejb-dev@xxxxxxxxxxx>
Date: 03/11/2020 11:46 AM
Subject: [EXTERNAL] Re: [ejb-dev] Format Specification PR
Sent by: ejb-dev-bounces@xxxxxxxxxxx
I have created two PRs #84and
#85for
Chapters 1-4.
Thanks
Hussain
From:
ejb-dev-bounces@xxxxxxxxxxx <ejb-dev-bounces@xxxxxxxxxxx> on behalf of Tracy Burroughs <tkb@xxxxxxxxxx>
Sent: Wednesday, March 11, 2020 08:39 PM
To: ejb developer discussions <ejb-dev@xxxxxxxxxxx>
Subject: Re: [ejb-dev] Format Specification PR
My preference is that smaller PRs are easier to review; however I don't think these formatting changes would need to be done with a PR per chapter. I'm fine with grouping a few chapters together
per PR.
Thanks for all your effort on this.
-- Tracy Burroughs (tkb@xxxxxxxxxx)
-- WebSphere Application Server Development
-- IBM Rochester, Dept WG8A H315/050-2
-- 2800 37th Street NW, Rochester MN 55901-4441
From: <Hussain.NM@xxxxxxxxxxxxx>
To: <ejb-dev@xxxxxxxxxxx>
Date: 03/11/2020 09:02 AM
Subject: [EXTERNAL] [ejb-dev] Format Specification PR
Sent by: ejb-dev-bounces@xxxxxxxxxxx
I am currently working on formatting the specification to match the original specification.
Do I raise a single PR with all changes or should I raise a separate PR for each chapter?
Current Status:
Pending:
Chapters 8-10
Chapter 12
Completed:
Table of Contents: (merged)
Chapter 11 (merged)
Related Documents (pending review)
Footnotes (pending review)
Chapters 1-7
Chapters 13-19
My current development version of specification is available in the below link
https://hussainnm.github.io/ejb-api/
Thanks
Hussain
_______________________________________________
ejb-dev mailing list
ejb-dev@xxxxxxxxxxx
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/ejb-dev
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. 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.
_______________________________________________
ejb-dev mailing list
ejb-dev@xxxxxxxxxxx
To unsubscribe from this list, visit https://urldefense.com/v3/__https://www.eclipse.org/mailman/listinfo/ejb-dev__;!!GqivPVa7Brio!J7zwq1Fm7zQLi4N5HrA184qvk_p9xwyrtL2uYV6WoNIr07yYBj0DC016WCyCt8itWw$
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. 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.
|
