search

quarkusio / extensions

The source of https://quarkus.io/extensions
Apache License 2.0
6 stars 4 forks source link

javadoc.io link? #1016

Closed maxandersen closed 1 month ago

maxandersen commented 2 months ago

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 commented 2 months ago

Excellent thought!

holly-cummins commented 1 month ago

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 commented 1 month ago

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 commented 1 month ago

Why would there ever be no javadoc?

/max https://about.me/maxandersen

On Fri, 17 May 2024 at 18.48, Holly Cummins @.***> wrote:

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.png (view on web) https://github.com/quarkusio/extensions/assets/11509290/a63c16dd-1b1a-4a85-807a-d42a5daa90a8

— Reply to this email directly, view it on GitHub https://github.com/quarkusio/extensions/issues/1016#issuecomment-2117994098, or unsubscribe https://github.com/notifications/unsubscribe-auth/AAANG4IVBKMIZGLAIK2XBDTZCYYG5AVCNFSM6AAAAABHMSORNOVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMJXHE4TIMBZHA . You are receiving this because you authored the thread.Message ID: @.***>

holly-cummins commented 1 month ago

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 commented 1 month ago

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/