java-slack-sdk icon indicating copy to clipboard operation
java-slack-sdk copied to clipboard

Some links in Javadoc pages are not working

Open seratch opened this issue 5 years ago • 3 comments

Issue Type

  • [x] 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 [ ])

  • [x] I've read and understood the Contributing guidelines and have done my best effort to follow them.
  • [x] I've read and agree to the Code of Conduct.
  • [x] I've searched for any related issues and avoided creating a duplicate issue.

seratch avatar Apr 17 '20 06:04 seratch

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?

slushpupie avatar Oct 05 '20 13:10 slushpupie

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.

seratch avatar Oct 19 '20 04:10 seratch

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()

gabrielfeo avatar May 16 '23 16:05 gabrielfeo