[Website Improvements] Individual component specification pages (see Jakarta specification pages for reference) MPWG repo #145

[aeiras]

Features and background on task:

• MPWG repo issue Individual component specification pages (see Jakarta specification pages for reference) #145
• David's specific comments and description on requirements: Individual component specification pages (see Jakarta specification pages for reference) microprofile/microprofile-wg#145 (comment)
• related to git ticket [draft mock-ups of separate specification pages
  draft mock-ups of separate specification pages #795](draft mock-ups of separate specification pages #795)
  and closed tickets draft mock-ups of separate specification pages #795 (comment)

[aeiras]

@rstjames,

As discussed, previews work on this task is dropped and refocused. David has been added to the ticket. Should you have any questions, he is your task support. :)

[rstjames]

@dblevins is this what you were thinking?

[dblevins]

Items to add:

• TCK Link
• Status of the spec (under development, final)
• Maven coordinates
• Compatible Implementations

For the demo the Maven coordinates for JWT 2.1 are:

<dependency>
    <groupId>org.eclipse.microprofile.jwt</groupId>
    <artifactId>microprofile-jwt-auth-api</artifactId>
    <version>2.1</version>
</dependency>

[dblevins]

Note that specs under development may not yet have a links such as spec pdf, spec html, tck or compatible implementations

[dblevins]

Here is a compatible implementation to add to the JWT 2.1 page:

• Open Liberty 22.0.0.13-beta

[dblevins]

Basic elements of a spec release page:

• Spec name and title and status
• Description from the Plan Review or Release Review ballot
• Compatible implementations (this section will have links to approved Certification Requests)
• Links (this will have the spec pdf, spec html, tck and maven coordinates)

These sections can have any heading or be arranged on the page in any way that looks visually appealing.

[rstjames]

@dblevins
here is the latested version. I used Metrics 5.1 because I could find most of the content we discussed should be there.
Thoughts?

• not sure what info should be on the Compatible Implementations so I just put a filler for now.
• light code section or dark
• Think it could be "designed up" bit more but need to have all content we feel should be there.

[Emily-Jiang]

@rstjames TCK Results should be TCKs to point to the download location for TCK jars.

[rstjames]

Updated layout and content:

[rstjames]

@Emily-Jiang, how do I move this forward? For me to do this, I will need the template content for each spec. After that, I can make each individual page.

I think each spec page should have its own ticket. That way, we can have content for each in one spot and review each before putting them live.

[jclingan]

I like having a ticket per spec page

[rstjames]

@Emily-Jiang I created git tickets for each specification; please check if I didn't miss something. Also, I created a doc that can be used for organizing each spec content.

https://docs.google.com/document/d/1i2I8zwvoVYx3Dx_d2hXqHwmqv-cVCFxNobWOOhpVhAo/edit?usp=sharing

Can you please read over this and let me know what you think?
@aeiras @jclingan you too :)

[aeiras]

@rstjames,

Great work on drafting a how to template the Spec. I provided my feedback and recommend you lead the show and tell and finalize its review before documentation becomes a wiki under the MPWG repo. Really good draft.