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

Publish the spec and javadoc #161

Open
FroMage opened this issue May 24, 2019 · 5 comments
Open

Publish the spec and javadoc #161

FroMage opened this issue May 24, 2019 · 5 comments

Comments

@FroMage
Copy link
Contributor

FroMage commented May 24, 2019

We should put the (rendered) spec and javadoc online somewhere because ATM it's impossible to link to them.

Is there any formal placement for those @kenfinnigan ?

@kenfinnigan
Copy link

Not sure if anything is done at the platform level.

@kwsutter?

@njr-11
Copy link
Contributor

njr-11 commented May 24, 2019

When going through the release candidate process, it had me attach the spec (which I did as pdf and html form) to the git release,
https://github.com/eclipse/microprofile-context-propagation/releases/tag/1.0-RC2

However, even the html doc here seems to function as a download rather than displaying in a browser, and this doesn't address the JavaDoc at all.

When browsing through the spec doc, I noticed several broken links from the release notes section,
http://download.eclipse.org/microprofile/microprofile-context-propagation-1.0/microprofile-context-propagation.pdf
http://download.eclipse.org/microprofile/microprofile-context-propagation-1.0/microprofile-context-propagation.html
http://download.eclipse.org/microprofile/microprofile-context-propagation-1.0/apidocs/

I suspect these links are broken because they are anticipating the location for the final released version of the spec, and we are still in release candidate.

That said, backing up from this location, I found the following for 1.0 RC 2,

https://download.eclipse.org/microprofile/microprofile-context-propagation-1.0-RC2

which has both the JavaDoc and the spec (both as html and pdf) which is directly viewable in a browser rather than as a download like the git releases.

@aguibert
Copy link
Contributor

aguibert commented May 24, 2019

@FroMage We have our javadoc automatically rendered here: https://javadoc.io/doc/org.eclipse.microprofile.context-propagation/microprofile-context-propagation-api/1.0-RC2

If you go to the top of the README for this repo, there is a green "[javadoc | 1.0-RC2]" badge at the top, next to the other badges, which you can click on to get to the javadoc.

@aguibert
Copy link
Contributor

Also, it would be nice if the microprofile.io website could have links to all the javadoc/spec docs for all of the various components, so users don't need to go fishing around in github repos or other sites.

@njr-11
Copy link
Contributor

njr-11 commented Jul 25, 2019

Also, it would be nice if the microprofile.io website could have links to all the javadoc/spec docs for all of the various components, so users don't need to go fishing around in github repos or other sites.

Given that, does this issue need to be raised against a different repository?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
4 participants