Skip to content

doc: fix commands on the developer tools page #376

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
octonato merged 1 commit into from
Sep 14, 2021
Merged

doc: fix commands on the developer tools page #376

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 5 additions & 4 deletions docs/src/modules/java/pages/developer-tools.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
= Developer Tools

include::ROOT:partial$include.adoc[]
include::partial$attributes.adoc[]

The Java tooling is published to https://mvnrepository.com/artifact/com.akkaserverless[Maven Central].

== Kickstart

A https://maven.apache.org/guides/introduction/introduction-to-archetypes.html[Maven archetype]; _maven-archetype-akkasls_ provides the Kickstart tooling. You supply details such as the desired artifact and group IDs, and the archetype provides a new Maven project directory with the Akka Serverless SDK and associated development support tooling set up.
A https://maven.apache.org/guides/introduction/introduction-to-archetypes.html[Maven archetype]; _akkaserverless-maven-archetype_ provides the tooling to xref:kickstart.adoc[kickstart a Maven project]. You supply details such as the desired artifact and group IDs, and the archetype provides a new Maven project directory with the Akka Serverless SDK and associated development support tooling set up.

The archetype can be used via the `mvn` CLI.
[.tabset]
Linux or MacOS::
+
[source,command line]
[source,command line,subs="attributes"]
----
mvn \
archetype:generate \
Expand All @@ -23,7 +24,7 @@ mvn \

Windows::
+
[source,command line]
[source,command line,subs="attributes"]
----
mvn ^
archetype:generate ^
Expand All @@ -34,7 +35,7 @@ mvn ^


== Ongoing development support
The development support tooling is provided via a single Maven plugin; _akkasls-maven-plugin_. This plugin provides two Maven goals to support Protobuf driven interface-first development.
The development support tooling is provided via a single Maven plugin; _akkaserverless-maven-plugin_. This plugin provides two Maven goals to support Protobuf driven interface-first development.

=== Goals
This plugin implements the following https://maven.apache.org/guides/introduction/introduction-to-the-lifecycle.html[Maven Build Lifecycle] goals:
Expand Down