Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add a page to list all spec's released javadoc/pdf/html #87

Open
Emily-Jiang opened this issue Aug 13, 2019 · 6 comments
Open

Add a page to list all spec's released javadoc/pdf/html #87

Emily-Jiang opened this issue Aug 13, 2019 · 6 comments

Comments

@Emily-Jiang
Copy link
Member

Some feedback regarding the difficulty to find spec/javadocs for each spec in MicroProfile.

Most of the relevant docs are under here

@Emily-Jiang
Copy link
Member Author

We need to have a page with a table to list all specs. For each spec, we need to list all versions. For each version, we need to list the pdf/html/javadocs.

@jclingan
Copy link
Contributor

I'd like to simplify this a bit for reader usability. The page should only have the most current version of each spec on the page, and then a link to the github releases page for each spec. So, image this is some crazy nice table format Ryan comes up with:

Metrics (PDF | HTML | Javadoc). Previous releases.
Config (PDF | HTML | Javadoc). Previous Releases.
OpenAPI (PDF | HTML | Javadoc). Previous Releases.
Fault Tolerance (PDF | HTML | Javadoc). Previous Releases.

Hopefully this can be done in an automated manner so it is always up to date. I was thinking the table may be included on the resources page, but I suspect it may become unwieldy over time as the number of specs grow.

@OndroMih
Copy link
Contributor

I would like to merge this activity with the idea of redesigning the Projects page (https://microprofile.io/projects/) we discussed in the Architecture Board meeting on August 13 (minutes here: https://docs.google.com/document/d/1uAKRymdAL5Wj1KADzrYKZzSnAFsq74lBfj8lxKQnI6I/edit#).

We could start by improving the Jenkins release job by producing some output that could be copy&pasted where needed, or to store some machine-readable info about the new release that could be picked up by a page at microprofile.io.

My original email in the forum here: https://groups.google.com/d/msg/microprofile/7PoUAsS1ebk/YbkrOFeDAwAJ

@OndroMih
Copy link
Contributor

OndroMih commented Aug 22, 2019

I propose these enhancements:

  • the current Jenkins job will generate a text file that can be copy&pasted to the new github release to add all the details for released artifacts semi-automatically
  • for each final release, the current Jenkins job will update a file stored in the Eclipse Downloads area to contain machine-readable information about the latest release (version, PDF, HTML, Javadoc, release info in Github)

Meanwhile, we can decide where and how to display the machine-readable information, which is produced by Jenkins, on the microprofile.io page.

@Emily-Jiang
Copy link
Member Author

We should minor https://jakarta.ee/specifications/
I think that is a lot better than our projects page. I plan to chair a call to discuss this with Ryan to have some design drawn. I will try to find a time and then make it public.

@Emily-Jiang
Copy link
Member Author

There is a dup of this on marketing git repo eclipse/microprofile-marketing#225. Let's use this one for further discussion.

@Emily-Jiang Emily-Jiang changed the title Add a page to list all spec's released pdf/html Add a page to list all spec's released javadoc/pdf/html Dec 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants