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

RFC: link to Sonatype-hosted Scaladocs instead of javadoc.io? #647

Open
armanbilge opened this issue Oct 5, 2023 · 0 comments
Open

RFC: link to Sonatype-hosted Scaladocs instead of javadoc.io? #647

armanbilge opened this issue Oct 5, 2023 · 0 comments
Labels

Comments

@armanbilge
Copy link
Member

We are in the midst of a 2-day+ javadoc.io outage, see maxcellent/javadoc.io#180. This is not the first time unfortunately 😕

We currently use javadoc.io URLs by default both for inter-API linking and also on documentation websites.

However, because we are publishing our docs to Sonatype/Maven, they are also available at a Sonatype-hosted URL. For example:

https://s01.oss.sonatype.org/service/local/repositories/releases/archive/org/typelevel/cats-docs_2.13/2.10.0/cats-docs_2.13-2.10.0-javadoc.jar/!/index.html

We might consider switching to using the Sonatype URLs in all the places.

Pros:

  • these URLs should be as permanent and live as Sonatype itself i.e. so long as our code artifacts are accessible there, the docs should be as well.

Cons:

  • no fancy version picker
  • it seems a bit slower (not to say javadoc.io can't be slow sometimes too).
@armanbilge armanbilge added the site label Oct 5, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

1 participant