Skip to content

Commit

Permalink
fix some doc issues (#678)
Browse files Browse the repository at this point in the history
* http links in license report

* try to fix some of the link issues in the docs

* Update build.sbt
  • Loading branch information
pjfanning authored Jun 3, 2024
1 parent 0050c14 commit fd20f64
Show file tree
Hide file tree
Showing 4 changed files with 47 additions and 9 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/link-validator.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,11 +15,11 @@ jobs:
fetch-tags: true
fetch-depth: 0

- name: Setup Java 11
- name: Setup Java 8
uses: actions/setup-java@v4
with:
distribution: temurin
java-version: 11
java-version: 8

- name: Cache Coursier cache
uses: coursier/cache-action@v6
Expand Down
11 changes: 6 additions & 5 deletions build.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -370,15 +370,16 @@ lazy val docs = project
"extref.github.base_url" -> s"https://github.com/apache/pekko-connectors/tree/${if (isSnapshot.value) "main"
else "v" + version.value}/%s",
"extref.pekko.base_url" -> s"https://pekko.apache.org/docs/pekko/current/%s",
"scaladoc.pekko.base_url" -> s"https://pekko.apache.org/api/pekko/${Dependencies.PekkoBinaryVersion}",
"javadoc.pekko.base_url" -> s"https://pekko.apache.org/japi/pekko/${Dependencies.PekkoBinaryVersion}/",
"javadoc.pekko.link_style" -> "direct",
"scaladoc.org.apache.pekko.base_url" -> s"https://pekko.apache.org/api/pekko/${Dependencies.PekkoBinaryVersion}",
"javadoc.org.apache.pekko.base_url" -> s"https://pekko.apache.org/japi/pekko/${Dependencies.PekkoBinaryVersion}/",
"javadoc.org.apache.pekko.link_style" -> "direct",
"extref.pekko-http.base_url" -> s"https://pekko.apache.org/docs/pekko-http/${Dependencies.PekkoHttpBinaryVersion}/%s",
"scaladoc.pekko.http.base_url" -> s"https://pekko.apache.org/api/pekko-http/${Dependencies.PekkoHttpBinaryVersion}/",
"javadoc.pekko.http.base_url" -> s"https://pekko.apache.org/japi/pekko-http/${Dependencies.PekkoHttpBinaryVersion}/",
"scaladoc.org.apache.pekko.http.base_url" -> s"https://pekko.apache.org/api/pekko-http/${Dependencies.PekkoHttpBinaryVersion}/",
"javadoc.org.apache.pekko.http.base_url" -> s"https://pekko.apache.org/japi/pekko-http/${Dependencies.PekkoHttpBinaryVersion}/",
// Pekko gRPC
"pekko-grpc.version" -> Dependencies.PekkoGrpcBinaryVersion,
"extref.pekko-grpc.base_url" -> s"https://pekko.apache.org/docs/pekko-grpc/${Dependencies.PekkoGrpcBinaryVersion}/%s",
"scaladoc.org.apache.pekko.gprc.base_url" -> s"https://pekko.apache.org/api/pekko-grpc/${Dependencies.PekkoGrpcBinaryVersion}/",
// Couchbase
"couchbase.version" -> Dependencies.CouchbaseVersion,
"extref.couchbase.base_url" -> s"https://docs.couchbase.com/java-sdk/${Dependencies.CouchbaseVersionForDocs}/%s",
Expand Down
2 changes: 1 addition & 1 deletion project/Dependencies.scala
Original file line number Diff line number Diff line change
Expand Up @@ -403,7 +403,7 @@ object Dependencies {
"com.orientechnologies" % "orientdb-object" % "3.2.30"))

val PravegaVersion = "0.13.0"
val PravegaVersionForDocs = s"v$PravegaVersion"
val PravegaVersionForDocs = "latest"

val Pravega = {
Seq(
Expand Down
39 changes: 38 additions & 1 deletion scripts/link-validator.conf
Original file line number Diff line number Diff line change
Expand Up @@ -32,14 +32,51 @@ site-link-validator {
"https://mvnrepository.com/artifact/"
# Errors in Scaladoc from Google Common header `X-Upload-Content-Type`
"https://doc.akka.io/api/akka-http/10.2.9/akka/http/impl/util/"
# Broken license report links
"http://glassfish.java.net/public/CDDL+GPL_1_1.html"
"https://glassfish.java.net/public/CDDL+GPL_1_1.html"
"http://jackson.codehaus.org"
"http://java.net/projects/jms-spec/pages/Home"
"http://jaxb.java.net/"
"http://jetty.mortbay.org"
"http://jta-spec.java.net"
"http://propensive.com/"
"http://servlet-spec.java.net"
"http://websocket-spec.java.net"
"https://jaxb.dev.java.net/"
"https://jsr311.dev.java.net"
"http://lmax-exchange.github.com/disruptor"
]

non-https-whitelist = [
# license report
"http://logback.qos.ch/"
"http://www.slf4j.org/"
"http://reactivemongo.org"
"http://www.thedevpiece.com/"
# genereated by @apidoc
"http://aopalliance.sourceforge.net"
"http://asm.ow2.io/"
"http://avro.apache.org"
"http://beanvalidation.org"
"http://checkerframework.org"
"http://code.google.com/p/"
"http://commons.apache.org/"
"http://geode.apache.org"
"http://couchbase.com"
"http://creativecommons.org/publicdomain/zero/1.0/"
"http://ehcache.org"
"http://fastutil.di.unimi.it/"
"http://findbugs.sourceforge.net/"
"http://github.com/FasterXML/"
"http://github.com/airlift/aircompressor"
"http://github.com/google/"
"http://github.com/jnr/"
"http://github.com/julianhyde/eigenbase-properties"
"http://github.com/sbt/junit-interface/"
"http://github.com/square/javapoet/"
"http://glassfish.java.net/public/CDDL+GPL_1_1.html"
"http://hamcrest.org/JavaHamcrest/"
# generated by @apidoc
"http://pravega.io/"
"http://www.scala-lang.org/api/2.13.13/scala/concurrent/Future.html"
"http://www.scala-lang.org/api/2.13.13/scala/util/Try.html"
Expand Down

0 comments on commit fd20f64

Please sign in to comment.