jakartaee / specification-committee

Documentation base for Specification Committee guides and process to be published at jakarta.ee via Hugo and git submodules
Eclipse Public License 2.0
8 stars 22 forks source link

Specification Statuses #27

Open dblevins opened 4 years ago

dblevins commented 4 years ago

Conceptually the idea is there is a clear "stamp" on each specification identifying its status.

At the top of the specification md file, for example enterprise-beans/4.0/_index.md, we would add a header status

---
title: "Jakarta Enterprise Beans 4.0"
date: 2020-mm-dd
summary: "Release for Jakarta EE 9"
status: "Development"
---

That metadata would be visible on the list page, like so:

image

And on the specification page itself, like so:

image

The date shown would indicate the date the specification entered that status.

On this page the status (e.g. "Development") is clickable and brings you to a page that defines each status.

Potential statuses

For reference the JCP has these statuses:

Status What it means
Active A JSR that has posted a milestone within the last twelve months.
Final A JSR that has produced a Final Release milestone more than a year ago.
Maintenance A JSR that last produced a Maintenance Review or Maintenance Release milestone more than a year ago.
Inactive A JSR that has not produced a Final Release or Maintenance Release, and which hasn't posted a milestone in the last year.
Withdrawn A JSR that was withdrawn from the JCP by the Specification Lead before Final Release.
Rejected A JSR that was not approved by the Executive Committee in one of the ballot stages for that JSR.
Dormant A JSR that was voted as "dormant" by the Executive Committee, or one that has reached the end of its natural lifespan.

Many of these are "one year since" and I don't know we're quite there yet. Seems the minimum viable number of statuses could be:

Status What it means
Development A Specification that has completed a Plan Review and in active development
Final A Specification that has completed a Release Review
Dormant A Specification that has not produced a Progress Review or Release Review within the last 12 months
Withdrawn A Specification that was withdrawn by the Specification Project before Release Review
bshannon commented 4 years ago

+1 - looks good to me!

kwsutter commented 4 years ago

I like this much better than the current "(under development)". :-) Thanks!

BTW, I like the abbreviated list of Statuses instead of the JCP list. I always found the JCP statuses to be quite confusing. Instead of Dormant, should we use Stable to be consistent with our Stable Project? I'm fine if we stick with Dormant, just a thought.

smillidge commented 4 years ago

Looks good. I assume Dormant can also apply to a spec that never reached Final and has never been withdrawn so Stable is not quite correct? An alternative is the JCP Inactive?

Emily-Jiang commented 4 years ago

Looks good! Dormant or Inactive is ok. Stalled is another option.