This is an automated email from the ASF dual-hosted git repository. fanningpj pushed a commit to branch paradox in repository https://gitbox.apache.org/repos/asf/incubator-pekko-quickstart-scala.g8.git
commit 0663c02460a80f651ba172bb7f32b4de3038e50a Author: PJ Fanning <[email protected]> AuthorDate: Sat May 6 22:02:22 2023 +0100 paradox plugin --- build.sbt | 12 ++++++++++-- docs/src/main/paradox/index.md | 6 ++++-- project/build.properties | 2 +- project/paradox.sbt | 14 +++++++++++++- 4 files changed, 28 insertions(+), 6 deletions(-) diff --git a/build.sbt b/build.sbt index 4fae653..efc1091 100644 --- a/build.sbt +++ b/build.sbt @@ -11,9 +11,17 @@ lazy val root = (project in file(".")) resolvers += Resolver.url("typesafe", url("https://repo.typesafe.com/typesafe/ivy-releases/";))(Resolver.ivyStylePatterns) ) +import org.apache.pekko.PekkoParadoxPlugin.autoImport._ + +def themeSettings = Seq( + // allow access to snapshots for pekko-sbt-paradox + resolvers += Resolver.ApacheMavenSnapshotsRepo, + pekkoParadoxGithub := Some("https://github.com/apache/incubator-pekko-quickstart-scala.g8";)) + // Documentation for this project: -// sbt "project docs" "~ paradox" +// sbt "docs/paradox" // open docs/target/paradox/site/main/index.html lazy val docs = (project in file("docs")) - .enablePlugins(ParadoxPlugin) + .enablePlugins(ParadoxPlugin, PekkoParadoxPlugin) .disablePlugins(Giter8Plugin) + .settings(themeSettings) diff --git a/docs/src/main/paradox/index.md b/docs/src/main/paradox/index.md index f2b2ef7..7e280e0 100644 --- a/docs/src/main/paradox/index.md +++ b/docs/src/main/paradox/index.md @@ -5,17 +5,19 @@ This guide introduces Pekko Actors by describing the Scala version of the Hello Actors are the unit of execution in Pekko. The Actor model is an abstraction that makes it easier to write correct concurrent, parallel and distributed systems. The Hello World example illustrates Pekko basics. Within 30 minutes, you should be able to download and run the example and use this guide to understand how the example is constructed. -This will get your feet wet, and hopefully inspire you to dive deeper into the wonderful sea of Pekko! +This will get your feet wet, and hopefully inspire you to dive deeper into the wonderful world of Pekko! After trying this example the comprehensive [Getting Started Guide](https://pekko.apache.org/docs/pekko/current/scala/guide/introduction.html) is a good next step to continue learning more about Pekko. ## Running the example +Create a new project using `sbt new apache/incubator-pekko-quickstart-scala.g8`. + To run Hello World: 1. In a console, change directories to the top level of the unzipped project. - For example, if you used the default project name, akka-quickstart-scala, and extracted the project to your root directory, + For example, if you used the default project name, pekko-quickstart-scala, and extracted the project to your root directory, from the root directory, enter: `cd pekko-quickstart-scala` 1. Enter `./sbt` on OSX/Linux or `sbt.bat` on Windows to start sbt. diff --git a/project/build.properties b/project/build.properties index 46e43a9..d6de1a0 100644 --- a/project/build.properties +++ b/project/build.properties @@ -1 +1 @@ -sbt.version=1.8.2 +sbt.version=1.9.0-RC1 diff --git a/project/paradox.sbt b/project/paradox.sbt index 9ea2ab4..2ce8f25 100644 --- a/project/paradox.sbt +++ b/project/paradox.sbt @@ -1,2 +1,14 @@ // sbt-paradox, used for documentation -addSbtPlugin("com.lightbend.paradox" % "sbt-paradox" % "0.6.8") + +// allow access to snapshots for pekko-sbt-paradox +resolvers += Resolver.ApacheMavenSnapshotsRepo + +// We have to deliberately use older versions of sbt-paradox because current Pekko sbt build +// only loads on JDK 1.8 so we need to bring in older versions of parboiled which support JDK 1.8 +addSbtPlugin(("org.apache.pekko" % "pekko-sbt-paradox" % "0.0.0+38-68da3106-SNAPSHOT").excludeAll( + "com.lightbend.paradox", "sbt-paradox", + "com.lightbend.paradox" % "sbt-paradox-apidoc", + "com.lightbend.paradox" % "sbt-paradox-project-info")) +addSbtPlugin(("com.lightbend.paradox" % "sbt-paradox" % "0.9.2").force()) +addSbtPlugin(("com.lightbend.paradox" % "sbt-paradox-apidoc" % "0.10.1").force()) +addSbtPlugin(("com.lightbend.paradox" % "sbt-paradox-project-info" % "2.0.0").force()) --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
