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

Some links in Javadoc pages are not working #434

Open
4 of 7 tasks
seratch opened this issue Apr 17, 2020 · 3 comments
Open
4 of 7 tasks

Some links in Javadoc pages are not working #434

seratch opened this issue Apr 17, 2020 · 3 comments
Labels
docs M-T: Documentation work only
Milestone

Comments

@seratch
Copy link
Member

seratch commented Apr 17, 2020

Issue Type

  • Bug
  • Enhancement / Feature request
  • Question
  • Documentation

Description

https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/1.0.6/slack-api-client-1.0.6-javadoc.jar/!/com/slack/api/Slack.html#send-java.lang.String-com.slack.api.webhook.Payload-

When accessing the Javadoc websites hosted by Sonatype, the links to classes in other packages of this SDK are invalid. We need to revisit the way to generate Javadoc files to be compatible with the Sonatype's Javadoc hosting service.

Requirements (place an x in each of the [ ])

  • I've read and understood the Contributing guidelines and have done my best effort to follow them.
  • I've read and agree to the Code of Conduct.
  • I've searched for any related issues and avoided creating a duplicate issue.
@seratch seratch added the docs M-T: Documentation work only label Apr 17, 2020
@seratch seratch added this to the 1.2.0 milestone Jun 11, 2020
@seratch seratch modified the milestones: 1.2.0, 1.x Jul 16, 2020
@slushpupie
Copy link
Contributor

So the problem seems to be the way Maven generates links between projects- it takes the ${project.url}/apidocs as the prefix.

I'd be interested in taking a look at this one, but I can't for the life of me see how the javadocs are currently generated. I was expecting to see a attach-javadocs execution ID somewhere, but I only see the attach-source. Is there some external process that is generating the javadoc.jar? Of maybe some advanced Maven usage I'm not familiar with?

@seratch
Copy link
Member Author

seratch commented Oct 19, 2020

I haven't checked this issue in detail yet but the pom inherits org.sonatype.oss:oss-parent and the parent pom enables some plugins. mvn deploy command generates javadocs as part of the process.

@gabrielfeo
Copy link

Searching is also broken: clicking on any search result (e.g. for "snippetType") leads to HTTP 400, "Could not find request in archive file".

https://oss.sonatype.org/service/local/repositories/releases/archive/com/slack/api/slack-api-client/1.29.2/slack-api-client-1.29.2-javadoc.jar/!/undefined/com/slack/api/methods/request/files/FilesUploadV2Request.html#getSnippetType()

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs M-T: Documentation work only
Projects
None yet
Development

No branches or pull requests

3 participants