Skip to main content
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [ejb-dev] Format Specification PR
The changes you describe all look good to me.  I haven't looked at the preview yet...

Hussain.NM@xxxxxxxxxxxxx wrote on 3/17/20 6:20 AM:

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

 

From: N M, Hussain (Cognizant) <Hussain.NM@xxxxxxxxxxxxx>
Sent: Tuesday, March 17, 2020 7:59 AM
To: Bill Shannon <bill.shannon@xxxxxxxxxx>; ejb developer discussions <ejb-dev@xxxxxxxxxxx>
Subject: Re: [ejb-dev] Format Specification PR

 

Thanks Bill, I will keep these points in mind when making the changes.

 

 

From: Bill Shannon <bill.shannon@xxxxxxxxxx>
Sent: Tuesday, March 17, 2020 07:44 AM
To: ejb developer discussions <ejb-dev@xxxxxxxxxxx>; N M, Hussain (Cognizant) <Hussain.NM@xxxxxxxxxxxxx>
Subject: Re: [ejb-dev] Format Specification PR

 

 

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.

Hussain.NM@xxxxxxxxxxxxx wrote on 3/16/20 6:11 AM:

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

 

From: N M, Hussain (Cognizant) <Hussain.NM@xxxxxxxxxxxxx>
Sent: Friday, March 13, 2020 7:17 PM
To: ejb developer discussions <ejb-dev@xxxxxxxxxxx>
Subject: RE: [ejb-dev] Format Specification PR

 

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

 

From: ejb-dev-bounces@xxxxxxxxxxx <ejb-dev-bounces@xxxxxxxxxxx> On Behalf Of Tracy Burroughs
Sent: Friday, March 13, 2020 9:53 AM
To: ejb developer discussions <ejb-dev@xxxxxxxxxxx>
Subject: Re: [ejb-dev] Format Specification PR

 

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$

Back to the top