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

javadoc.io link? #1016

Closed
maxandersen opened this issue May 8, 2024 · 6 comments · Fixed by #1037
Closed

javadoc.io link? #1016

maxandersen opened this issue May 8, 2024 · 6 comments · Fixed by #1037

Comments

@maxandersen
Copy link
Contributor

how about adding javadoc.io link ?

for neo4j it would be this to get latest version:
https://javadoc.io/doc/io.quarkiverse.neo4j/quarkus-neo4j

@holly-cummins
Copy link
Collaborator

Excellent thought!

@holly-cummins
Copy link
Collaborator

I thought this would be super-trivial, but I realised when I started writing it that javadoc.io has a page (returning 200) for everything in maven central. We don't want people excitedly clicking a "javadoc" link and then getting a page that says "there is no javadoc" so I've screened the contents before including the url. I've also cached, so that we don't hammer javadoc.io every build.

@holly-cummins
Copy link
Collaborator

The javadoc.io site does seem to be having so problems today; I don't know if those reliability issues happen often, or if I was just unlucky. They've got CloudFlare CDN, so I don't think a few builds from me could have triggered it. I hope.

image

@maxandersen
Copy link
Contributor Author

maxandersen commented May 19, 2024 via email

@holly-cummins
Copy link
Collaborator

Why would there ever be no javadoc?

It happens reasonably often for the Quarkiverse extensions - see, for example, https://javadoc.io/doc/io.quarkiverse.amazonalexa/quarkus-amazon-alexa

image

If the CI isn't publishing a javadoc jar to maven, there's no javadoc. And, in that case, we shouldn't display a link labelled 'javadoc', because anyone who clicks it will end up disappointed.

@holly-cummins
Copy link
Collaborator

That's now published.

Example of extension without javadoc (so no link): https://quarkus.io/extensions/io.quarkiverse.amazonalexa/quarkus-amazon-alexa/
Example of extension with javadoc: https://quarkus.io/extensions/io.quarkiverse.azureservices/quarkus-azure-app-configuration/

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

Successfully merging a pull request may close this issue.

2 participants