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-java.g8.git
commit 8633c626c045cbdfd3b62fb4e5221e0a02a3c571 Author: PJ Fanning <[email protected]> AuthorDate: Sat May 6 22:23:01 2023 +0100 paradox plugin --- build.sbt | 12 ++++++++++-- docs/build.sbt | 5 +---- docs/src/main/paradox/index.md | 4 +++- project/build.properties | 2 +- project/paradox.sbt | 14 +++++++++++++- 5 files changed, 28 insertions(+), 9 deletions(-) diff --git a/build.sbt b/build.sbt index a1b859d..692dc61 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) \ No newline at end of file diff --git a/docs/build.sbt b/docs/build.sbt index 2c08be3..e878e3c 100644 --- a/docs/build.sbt +++ b/docs/build.sbt @@ -1,7 +1,4 @@ -// Uses the out of the box generic theme. -paradoxTheme := Some(builtinParadoxTheme("generic")) - -scalaVersion := "2.12.6" +scalaVersion := "2.13.10" Compile / paradoxProperties ++= Map( "snip.g8root.base_dir" -> "../../../../src/main/g8", diff --git a/docs/src/main/paradox/index.md b/docs/src/main/paradox/index.md index 5203202..5ff5c2b 100644 --- a/docs/src/main/paradox/index.md +++ b/docs/src/main/paradox/index.md @@ -3,12 +3,14 @@ Apache Pekko is a toolkit and runtime for building highly concurrent, distributed, and fault-tolerant event-driven applications on the JVM. Pekko can be used with both Java and Scala. This guide introduces Pekko Actors by describing the Java version of the Hello World example. If you prefer to use Pekko with Scala, switch to the Pekko Quickstart with Scala guide. -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! +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 world of Pekko! After trying this example the comprehensive [Getting Started Guide](https://pekko.apache.org/docs/pekko/current/java/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-java.g8`. + Make sure that you have installed the build tool of your choice and thereafter open a Terminal window and, from inside the project directory, type the following to run Hello World: Maven 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]
