Skip to content

Commit

Permalink
Revert old link-validator.conf accidentally deleted in #241
Browse files Browse the repository at this point in the history
  • Loading branch information
jrudolph committed Jul 24, 2023
1 parent c9aa267 commit 2f0d9a8
Showing 1 changed file with 99 additions and 0 deletions.
99 changes: 99 additions & 0 deletions scripts/link-validator.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
# SPDX-License-Identifier: Apache-2.0

// config for https://github.com/ennru/site-link-validator/
site-link-validator {
root-dir = "docs/target/paradox/site/main/"
# relative to `root-dir`
start-file = "index.html"

# Resolves URLs with the given prefix as local files instead
link-mappings = [
{
prefix = "https://pekko.apache.org/docs/pekko-http/1.0.0/"
replace = ""
}
{
prefix = "https://pekko.apache.org/docs/pekko-http/current/"
replace = ""
}
# ScalaDoc from unidoc
{
prefix = "https://pekko.apache.org/api/pekko-http/1.0.0/"
replace = "/../../../../../target/scala-2.13/unidoc/"
}
{
prefix = "https://pekko.apache.org/api/pekko-http/current/"
replace = "/../../../../../target/scala-2.13/unidoc/"
}
{
prefix = "https://pekko.apache.org/api/pekko-http/snapshot/"
replace = "/../../../../../target/scala-2.13/unidoc/"
}
# Java APIs from genjavadoc
{
prefix = "https://pekko.apache.org/japi/pekko-http/1.0.0/"
replace = "/../../../../../target/javaunidoc/"
}
{
prefix = "https://pekko.apache.org/japi/pekko-http/current/"
replace = "/../../../../../target/javaunidoc/"
}
{
prefix = "https://pekko.apache.org/japi/pekko-http/snapshot/"
replace = "/../../../../../target/javaunidoc/"
}
]

ignore-missing-local-files-regex = ""
// e.g. "^api/alpakka/snapshot/pekko/stream/alpakka/googlecloud/storage/impl/Formats.*"

ignore-prefixes = [
# Fails after a number of requests with "403 Forbidden"
"https://javadoc.io/static/"
# GitHub will block with "429 Too Many Requests"
"https://github.com/"
# Problematic link generated by scaladoc
"https://www.scala-lang.org/api/2.13.11/scala/runtime/AbstractFunction1.html"
# Bug, see https://github.com/scala/bug/issues/12807 and https://github.com/lampepfl/dotty/issues/17973
"https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/nio/file/StandardOpenOption$.html"
# Occasionally returns a 500 Internal Server Error
"http://code.google.com/"
# sample endpoint
"http://localhost:8080"
# broken URL in license report
"http://pholser.github.com/"
]

non-https-whitelist = [
# sample in docs
"http://example.com"
# license report
"http://asm.ow2.io/"
"http://commons.apache.org/"
"http://www.apache.org/licenses/LICENSE-2.0"
"http://findbugs.sourceforge.net/"
"https://github.com/FasterXML/"
"https://github.com/ronmamo/"
"https://github.com/sbt/junit-interface/"
"http://junit.org"
"http://netty.io/"
"http://openjdk.java.net/legal/gplv2+ce.html"
"http://opensource.org/licenses/MIT"
"http://parboiled.org"
"http://specs2.org/"
"http://www.eclipse.org/legal/epl-v10.html"
"http://www.javassist.org/"
"http://www.mozilla.org/MPL/MPL-1.1.html"
"http://www.opensource.org/licenses/"
"http://www.reactive-streams.org/"
"http://www.scala-lang.org/"
"http://www.scala-sbt.org"
"http://www.scalacheck.org"
"http://www.scalatest.org"
"http://www.slf4j.org"
# no https support
"http://spray.io/blog/"
# javadoc
"http://tools.ietf.org/html/rfc7541"
]
}

0 comments on commit 2f0d9a8

Please sign in to comment.