Skip to content

Commit

Permalink
docs: even more links (#1267)
Browse files Browse the repository at this point in the history
  • Loading branch information
ennru authored Nov 22, 2024
1 parent fb384b6 commit 1751e82
Show file tree
Hide file tree
Showing 5 changed files with 81 additions and 2 deletions.
6 changes: 6 additions & 0 deletions .github/workflows/link-validator.yml
Original file line number Diff line number Diff line change
Expand Up @@ -44,3 +44,9 @@ jobs:

- name: Run Link Validator
run: cs launch net.runne::site-link-validator:0.2.5 -- scripts/link-validator.conf

- name: Run Link Validator (Distributed cluster)
run: cs launch net.runne::site-link-validator:0.2.5 -- scripts/link-validator-distributed-cluster.conf

- name: Run Link Validator (Edge)
run: cs launch net.runne::site-link-validator:0.2.5 -- scripts/link-validator-edge.conf
2 changes: 1 addition & 1 deletion project/Common.scala
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ object Common extends AutoPlugin {
Seq(
organization := "com.lightbend.akka",
organizationName := "Lightbend Inc.",
organizationHomepage := Some(url("https://www.lightbend.com/")),
organizationHomepage := Some(url("https://akka.io/")),
startYear := Some(2020),
homepage := Some(url("https://akka.io")),
// apiURL defined in projectSettings because version.value is not correct here
Expand Down
2 changes: 1 addition & 1 deletion project/plugins.sbt
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ addSbtPlugin("com.github.sbt" % "sbt-ci-release" % "1.9.0")
addSbtPlugin("com.lightbend.akka.grpc" % "sbt-akka-grpc" % "2.5.0")

// Documentation
addSbtPlugin("io.akka" % "sbt-paradox-akka" % "24.10.5")
addSbtPlugin("io.akka" % "sbt-paradox-akka" % "24.10.6")
addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-dependencies" % "0.2.4")
addSbtPlugin("com.lightbend.sbt" % "sbt-publish-rsync" % "0.3")
addSbtPlugin("com.github.sbt" % "sbt-unidoc" % "0.5.0")
Expand Down
36 changes: 36 additions & 0 deletions scripts/link-validator-distributed-cluster.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
// config for https://github.com/ennru/site-link-validator/
site-link-validator {
root-dir = "./akka-distributed-cluster-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://doc.akka.io/libraries/akka-distributed-cluster/snapshot/"
replace = "/docs/akka-distributed-cluster/snapshot/"
}
{
prefix = "https://doc.akka.io/api/akka-distributed-cluster/snapshot/"
replace = "/api/akka-distributed-cluster/snapshot/"
}
]

ignore-missing-local-files-regex = ""

ignore-files = []

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/"
# MVN repository forbids access after a few requests
"https://mvnrepository.com/artifact/"
# link checker is using HEAD requests, which isn't supported by the repo index
"https://repo.akka.io/"
]

non-https-whitelist = [
]
}
37 changes: 37 additions & 0 deletions scripts/link-validator-edge.conf
Original file line number Diff line number Diff line change
@@ -0,0 +1,37 @@
// config for https://github.com/ennru/site-link-validator/
site-link-validator {
root-dir = "./akka-edge-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://doc.akka.io/libraries/akka-edge/snapshot/"
replace = "/docs/akka-edge/snapshot/"
}
{
prefix = "https://doc.akka.io/api/akka-edge/snapshot/"
replace = "/api/akka-edge/snapshot/"
}
]

ignore-missing-local-files-regex = ""

ignore-files = []

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/"
# MVN repository forbids access after a few requests
"https://mvnrepository.com/artifact/"
# link checker is using HEAD requests, which isn't supported by the repo index
"https://repo.akka.io/",
"http://localhost:8081/"
]

non-https-whitelist = [
]
}

0 comments on commit 1751e82

Please sign in to comment.