Skip to content
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

Add Docker to local dev prerequisites #119

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Docker to local dev prerequisites #119

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
3 changes: 2 additions & 1 deletion docs/src/modules/ROOT/partials/local-dev-prerequisites.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
* Java {java-version}, we recommend https://adoptium.net/marketplace/[Eclipse Adoptium, window="new"]
* https://maven.apache.org/install.html[Apache Maven, window="new"] version {minimum_maven_version} or later
* https://curl.se/download.html[`curl` command-line tool, window="new"]
* https://curl.se/download.html[`curl` command-line tool, window="new"]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think we want this in the partial that is included from several places. For local development it is only needed for the local console. In author-your-first-service.adoc we want to start with as few prerequisites as possible, and the local console is at the end of that page. Better to add Docker to that section of the page, where it anyway describes installation of akka cli.

We should review other places where it might be relevant to install Docker.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In author-your-first-service.adoc we want to start with as few prerequisites as possible, and the local console is at the end of that page. Better to add Docker to that section of the page, where it anyway describes installation of akka cli.

I agree, and we already mention the Docker requirement in the local console section at the end https://github.com/akka/akka-sdk/blob/main/docs/src/modules/java/pages/author-your-first-service.adoc?plain=1#L202

* Docker installed and running
Loading