Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
Re: [jakarta.ee-spec.committee] Jakarta EE specification template

Bill, this looks quite useful. I think these, along with some minimum descriptive content from the particular Spec, will comprise the minimum-bar/starting point for all specification documents that will make up Jakarta EE 8. That content will start with the approved project name and the scope statements.

I think the rest of this is for the committee and our Mentor (Wayne, I think):

Is there a process for approving this? If so, what is that process? I don't think this is a new project proposal, since it is just proposed as a new repository in the Eclipse Jakarta EE Platform project. Maybe this is purely a Platform Specification Project question?

Presuming this template gets approved, should we use this to kick-start all projects? Just for those which we don't have Spec. content available immediately following the conversion / restructuring review? OR should we create a later deadline, after which, we generate a boilerplate (using this template, for the express purpose of having a Spec. document to put on ballot.)?

For those projects that start with this, does anyone have thoughts about how we might then integrate or weave in the contributed specifications? (Wholesale replacement? Or, would we want to suggest something else?)

I can't assess how many projects might wind up relying on a boilerplate initial Spec.

Thanks,

-- Ed

On 5/31/2019 3:48 PM, Bill Shannon wrote:
I've delivered all the Oracle Java EE specifications to the Eclipse Foundation.
Eclipse is now in the process of acquiring the copyright rights necessary to
allow use of those specifications for Jakarta EE.  When the rights have been
acquired for each specification, Eclipse will deliver the specification to
the corresponding specification project.

While we hope that Eclipse will be able to acquire all of the required
copyright rights, it seems likely that all specs may not be complete for
Jakarta EE.  Without the ability to use some of the existing specification
documents, we're expecting to create "boilerplate" specifications that
contain a scope statement for the specification and little more, while
referencing the javadocs.

I've created a "specification template" project, using the same structure
as the specification documents I delivered to Eclipse.  I'd love to get
feedback on this project, especially from AsciiDoc and Maven experts.  I'm
sure there's lot of room for improvement.  We can use this template for
any boilerplate specifications that we will need to create, and we can
apply any improvements you suggest to the original Oracle specification
projects that Eclipse will deliver to us.

The project is here:
https://github.com/bshannon/spec-template

I can move this to an eclipse-ee4j repo under the platform project if it
seems useful long term.

Thanks.
_______________________________________________
jakarta.ee-spec.committee mailing list
jakarta.ee-spec.committee@xxxxxxxxxxx
To change your delivery options, retrieve your password, or unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/jakarta.ee-spec.committee


Back to the top