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

[Website] Standarise the way to publish releases #225

Closed
Emily-Jiang opened this issue Nov 18, 2019 · 18 comments
Closed

[Website] Standarise the way to publish releases #225

Emily-Jiang opened this issue Nov 18, 2019 · 18 comments
Labels
Enhancement adjustment to old item Help Wanted tasks requires extra hands Website

Comments

@Emily-Jiang
Copy link
Member

@Emily-Jiang commented on Tue Aug 13 2019

Since spec html and pdf are not in maven central. In the past, the pdfs and htmls are attached to the releases. However, it is not convenient as they have to be downloaded for viewing.

In the recent release architecture changes, all of the docs and javadocs are uploaded to here. When releasing MicroProfile reactive messaging, I used the following format, which is much more user friendly.

I updated MicroProfile config to use this format. All other specs should adopt this format for improvement.

We also need to update microprofile.io to list all spec/pdf. I've filed this issue on microprofile-site repo.


@OndroMih commented on Tue Aug 13 2019

Ideally, the Jenkins release job would use GitHub API to generate the description for the release, including links to Javadocs and spec documents and info about the maven artifact.

@Emily-Jiang
Copy link
Member Author

@rstjames can we meet up to discuss the layout?

@rstjames
Copy link

@Emily-Jiang When would you all like to meet?

@rstjames
Copy link

@Emily-Jiang Emily and I met,
She is looking for a page that would be on MP site that would list all specs with content bellow. (big spec overview)
Example: (content filler)
Screen Shot 2019-11-19 at 11 37 25 AM

We will continue this conversation on the next marketing call and community call. Then we can get others thoughts on this topic and decide what the next steps could be.

@Emily-Jiang
Copy link
Member Author

I am thinking to have two layers:
First layer contains all MP Spec, basically the building blocks(Config, Fault Tolerance, Rest Client, etc). On clicking each individual spec, it lists all versions with the links to javadocs, html, pdf.

@Emily-Jiang
Copy link
Member Author

I will like to make some progress with this. @rstjames what is the next step?

@Emily-Jiang
Copy link
Member Author

@rstjames what's the next stage?

@rstjames
Copy link

@Emily-Jiang that is a good question. I am not sure... I can not give away resources (if we have any to spare) without discussing things with @aeiras . This may take a couple weeks because of holidays.

@aeiras
Copy link
Contributor

aeiras commented Feb 28, 2020

Hey you two @Emily-Jiang and @rstjames ,

I recommend a deep discussion on next MP Marketing hangout to see exactly what it will take to proceed on this task. Without knowing specifics, we cannot provide Ryan's time to work on a blind task.

Recommendation is always to write up the plan via drive website document, take on priorities and drop anything shiny or "not vital". Once that document is ready, bring it to the Community call for consumption and that will trigger action.

Cheers,

@aeiras
Copy link
Contributor

aeiras commented Feb 28, 2020

I added Cesar and myself to this ticket :) for reference!

@aeiras
Copy link
Contributor

aeiras commented Apr 1, 2020

new ticket takes into account this feedback with reference to 3.3 written retrospective! #251

The project page under the website needs to be 100% automatic and link to all the active repos.
https://microprofile.io/projects/

Can someone in this ticket find out whats needed? :)

@aeiras
Copy link
Contributor

aeiras commented Apr 1, 2020

@rstjames,

Can you please make a call to action bottom on the Project's page that brings the viwer to the MP main Repo: https://github.com/eclipse?utf8=✓&q=microprofile

Thanks

@rstjames
Copy link

rstjames commented Apr 6, 2020

@aeiras button added to the https://microprofile.io/projects/.

@aeiras
Copy link
Contributor

aeiras commented Apr 6, 2020

thanks Ryan. Small improvement for the time being.

@aeiras
Copy link
Contributor

aeiras commented Jun 8, 2020

We tackled this today during Mktg hangout. Tackled with new ticket.
The mktg side has its wiki & the technical side is being updated to know how to communicate with branding! #277

@aeiras aeiras closed this as completed Jun 8, 2020
@aeiras aeiras reopened this Jun 9, 2020
@Emily-Jiang
Copy link
Member Author

Emily-Jiang commented Jun 22, 2020

@rstjames can you create a draft for this web page? Please let me know what info you need from me. Can we set up a deadline? How long do you think this will take @rstjames ?

@aeiras
Copy link
Contributor

aeiras commented Dec 10, 2020

Hey @Emily-Jiang,

We have made improvements on this area. Do you believe we still need this ticket or can we close it and iterate via new issues to tackle improvements on the work done?

@aeiras
Copy link
Contributor

aeiras commented Jan 15, 2021

@Emily-Jiang,

Now that your formally took a part of the pushing on release MP. 4.0 which includes marketing templates, do we still need this ticket or can we focus the work on a new ticket and go by layers?

I recommend we choose layers and allow for smaller releases to become the norm as well.

@aeiras aeiras changed the title Standarise the way to publish releases [Website] Standarise the way to publish releases May 27, 2021
@aeiras
Copy link
Contributor

aeiras commented Aug 2, 2021

Emily,

we have evolved this and the latest work deals with this ticket under the MPWG.
I will close it.

@aeiras aeiras closed this as completed Aug 2, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Enhancement adjustment to old item Help Wanted tasks requires extra hands Website
Projects
None yet
Development

No branches or pull requests

4 participants