From 629383545fa6a982bc1674aa447902c14962fdd1 Mon Sep 17 00:00:00 2001 From: Arnout Engelen Date: Thu, 2 May 2019 18:23:33 +0200 Subject: [PATCH] Clean up paradox output (#26759) Fix some validation problems --- akka-docs/src/main/paradox/actors.md | 2 +- akka-docs/src/main/paradox/guide/actors-intro.md | 2 +- .../src/main/paradox/project/migration-guide-2.4.x-2.5.x.md | 1 - .../src/main/paradox/security/2017-02-10-java-serialization.md | 2 +- akka-docs/src/main/paradox/typed/guide/actors-intro.md | 2 +- build.sbt | 2 +- project/plugins.sbt | 1 + 7 files changed, 6 insertions(+), 6 deletions(-) diff --git a/akka-docs/src/main/paradox/actors.md b/akka-docs/src/main/paradox/actors.md index fe86592d6e..c2f5642240 100644 --- a/akka-docs/src/main/paradox/actors.md +++ b/akka-docs/src/main/paradox/actors.md @@ -89,7 +89,7 @@ construction. #### Here is another example that you can edit and run in the browser: -@@fiddle [ActorDocSpec.scala](/akka-docs/src/test/scala/docs/actor/ActorDocSpec.scala) { #fiddle_code template=Akka layout=v75 minheight=400px } +@@fiddle [ActorDocSpec.scala](/akka-docs/src/test/scala/docs/actor/ActorDocSpec.scala) { #fiddle_code template="Akka" layout="v75" minheight="400px" } @@@ diff --git a/akka-docs/src/main/paradox/guide/actors-intro.md b/akka-docs/src/main/paradox/guide/actors-intro.md index 4271327531..8f9edf7ee6 100644 --- a/akka-docs/src/main/paradox/guide/actors-intro.md +++ b/akka-docs/src/main/paradox/guide/actors-intro.md @@ -41,7 +41,7 @@ different actors work concurrently with each other so that an actor system can p Since there is always at most one message being processed per actor, the invariants of an actor can be kept without synchronization. This happens automatically without using locks: -![messages don't invalidate invariants as they are processed sequentially](diagrams/serialized_timeline_invariants.png) +![messages do not invalidate invariants as they are processed sequentially](diagrams/serialized_timeline_invariants.png) In summary, this is what happens when an actor receives a message: diff --git a/akka-docs/src/main/paradox/project/migration-guide-2.4.x-2.5.x.md b/akka-docs/src/main/paradox/project/migration-guide-2.4.x-2.5.x.md index 96a9ee5159..2399f9f09b 100644 --- a/akka-docs/src/main/paradox/project/migration-guide-2.4.x-2.5.x.md +++ b/akka-docs/src/main/paradox/project/migration-guide-2.4.x-2.5.x.md @@ -2,4 +2,3 @@ Migration from 2.4.x to 2.5.x is described in the [documentation of 2.5](https://doc.akka.io/docs/akka/2.5/project/migration-guide-2.4.x-2.5.x.html). - diff --git a/akka-docs/src/main/paradox/security/2017-02-10-java-serialization.md b/akka-docs/src/main/paradox/security/2017-02-10-java-serialization.md index 04fe4238ff..3e75090627 100644 --- a/akka-docs/src/main/paradox/security/2017-02-10-java-serialization.md +++ b/akka-docs/src/main/paradox/security/2017-02-10-java-serialization.md @@ -27,7 +27,7 @@ Please subscribe to the [akka-security](https://groups.google.com/forum/#!forum/ ### Severity -The [CVSS](https://en.wikipedia.org/wiki/CVSS) score of this vulnerability is 6.8 (Medium), based on vector [AV:A/AC:M/Au:N/C:C/I:C/A:C/E:F/RL:TF/RC:C](https://nvd.nist.gov/cvss.cfm?calculator&version=2&vector=\(AV:A/AC:M/Au:N/C:C/I:C/A:C/E:F/RL:TF/RC:C\)). +The [CVSS](https://en.wikipedia.org/wiki/CVSS) score of this vulnerability is 6.8 (Medium), based on vector [AV:A/AC:M/Au:N/C:C/I:C/A:C/E:F/RL:TF/RC:C](https://nvd.nist.gov/cvss.cfm?calculator&version=2&vector=\(AV:A/AC:M/Au:N/C:C/I:C/A:C/E:F/RL:TF/RC:C\)). Rationale for the score: diff --git a/akka-docs/src/main/paradox/typed/guide/actors-intro.md b/akka-docs/src/main/paradox/typed/guide/actors-intro.md index ee8ec783f0..24f85952c8 100644 --- a/akka-docs/src/main/paradox/typed/guide/actors-intro.md +++ b/akka-docs/src/main/paradox/typed/guide/actors-intro.md @@ -49,7 +49,7 @@ different actors work concurrently with each other so that an actor system can p Since there is always at most one message being processed per actor, the invariants of an actor can be kept without synchronization. This happens automatically without using locks: -![messages don't invalidate invariants as they are processed sequentially](../../guide/diagrams/serialized_timeline_invariants.png) +![messages do not invalidate invariants as they are processed sequentially](../../guide/diagrams/serialized_timeline_invariants.png) In summary, this is what happens when an actor receives a message: diff --git a/build.sbt b/build.sbt index 3f6a403624..c1ba77c501 100644 --- a/build.sbt +++ b/build.sbt @@ -203,7 +203,7 @@ lazy val docs = akkaModule("akka-docs") "extref.akka.http.base_url" -> "https://doc.akka.io/docs/akka-http/current/%s", "extref.wikipedia.base_url" -> "https://en.wikipedia.org/wiki/%s", "extref.github.base_url" -> (GitHub.url(version.value) + "/%s"), // for links to our sources - "extref.samples.base_url" -> "https://developer.lightbend.com/start/?group=akka&project=%s", + "extref.samples.base_url" -> "https://developer.lightbend.com/start/?group=akka&project=%s", "extref.ecs.base_url" -> "https://example.lightbend.com/v1/download/%s", "scaladoc.akka.base_url" -> "https://doc.akka.io/api/akka/2.5", "scaladoc.akka.http.base_url" -> "https://doc.akka.io/api/akka-http/current", diff --git a/project/plugins.sbt b/project/plugins.sbt index 399c9145b3..3d0294f540 100644 --- a/project/plugins.sbt +++ b/project/plugins.sbt @@ -17,6 +17,7 @@ addSbtPlugin("io.spray" % "sbt-boilerplate" % "0.6.1") addSbtPlugin("com.timushev.sbt" % "sbt-updates" % "0.3.4") addSbtPlugin("com.lightbend.akka" % "sbt-paradox-akka" % "0.18") addSbtPlugin("com.lightbend.paradox" % "sbt-paradox-apidoc" % "0.1+9-d846d815") +addSbtPlugin("com.lightbend.paradox" % "sbt-paradox" % "0.5.4") addSbtPlugin("com.lightbend" % "sbt-whitesource" % "0.1.13") addSbtPlugin("com.typesafe.sbt" % "sbt-git" % "1.0.0") addSbtPlugin("de.heikoseeberger" % "sbt-header" % "5.0.0") // for maintenance of copyright file header