From 3289e6ef7db71f139400afa0fb101f2037ba4916 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20G=C3=B3mez=20G?= Date: Tue, 12 Mar 2024 13:13:03 +0100 Subject: [PATCH 1/3] Configured external links to open in a new window --- .../modules/ROOT/pages/run-app-with-docker-compose.adoc | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/tutorial/modules/ROOT/pages/run-app-with-docker-compose.adoc b/docs/tutorial/modules/ROOT/pages/run-app-with-docker-compose.adoc index 3f085c1..79a0ad4 100644 --- a/docs/tutorial/modules/ROOT/pages/run-app-with-docker-compose.adoc +++ b/docs/tutorial/modules/ROOT/pages/run-app-with-docker-compose.adoc @@ -1,6 +1,7 @@ :navtitle: Running Your Application Locally With Docker Compose :reftext: Running your application in your local environment with Docker Compose + = Running the Application Locally With Docker Compose In this step, we will see how to run your application in your local environment with everything you need. @@ -13,12 +14,12 @@ To avoid having to installing and starting the Axon Server manually, we rely on To run everything we need easily and with just one click (or shortcut key combination) from your IDE we will use Docker Compose and docker images to start the Axon Server. -Make sure you have installed the link:https://docs.docker.com/engine/[Docker Engine,type=external,target=_blank] in your system, or https://docs.docker.com/engine/install/[Install Docker Engine] otherwise. +Make sure you have installed the link:https://docs.docker.com/engine/[Docker Engine,role=external,window=_blank] in your system, or https://docs.docker.com/engine/install/[Install Docker Engine,role=external,window=_blank] otherwise. == Configuring Docker Compose === Docker Compose descriptor -https://docs.docker.com/compose/[Docker Compose,type=external,target=_blank] is a tool that allows you to define all the docker containers, networks, volumes and any other characteristics that we need from the infrastructure to run our application. +https://docs.docker.com/compose/[Docker Compose,role=external,window=_blank] is a tool that allows you to define all the docker containers, networks, volumes and any other characteristics that we need from the infrastructure to run our application. Even if we are going to run only one docker image (Axon Server), Docker Compose is convenient because allows to start everything in one comand. @@ -71,7 +72,7 @@ Once that we have added this dependency, we can run our application right from o Run your application from your IDE. You should see in the logs how SpringBoot dowloads the AxonServer docker image, and starts running AxonServer automatically for you before starting your application: -[,bash] +[,console] ---- . ____ _ __ _ _ @@ -93,7 +94,7 @@ Run your application from your IDE. You should see in the logs how SpringBoot do INFO --- [Rental Monolith] verDockerComposeConnectionDetailsFactory : Detected Axon Server container. To access the dashboard, visit http://127.0.0.1:8024 ---- -After the application starts, you can open your browser and go to `http://localhost:8024`. You will access the Axon Server dashboard. +After the application starts, you can open your browser and go to `http://localhost:8024[,role=external,window=_blank]`. You will access the Axon Server dashboard. If you click on the "Overview" button from the right panel, you will see the Axon Server instance and your `Rental Monolith` Application connected to it. From a945435404ed5c194a5482f94e36e1072a7ffea3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20G=C3=B3mez=20G?= Date: Tue, 12 Mar 2024 13:14:09 +0100 Subject: [PATCH 2/3] Fixed internal references --- .../modules/ROOT/pages/create-axon-framework-project.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/tutorial/modules/ROOT/pages/create-axon-framework-project.adoc b/docs/tutorial/modules/ROOT/pages/create-axon-framework-project.adoc index 44686b3..8952507 100644 --- a/docs/tutorial/modules/ROOT/pages/create-axon-framework-project.adoc +++ b/docs/tutorial/modules/ROOT/pages/create-axon-framework-project.adoc @@ -42,7 +42,7 @@ We will create a maven project with the following structure: <.> Finally, the `pom.xml` maven descriptor at the root `bike-rental` project keeps the common dependency definition inherited in all the submodules. It also keeps the list of `` that form part of the project. -If you are already experienced with Maven and/or your IDE, you can just create a multi-maven project with the structure described here and move to the next step of this tutorial to xref:boostraping-axonframework[configure Axon Framework in your project.] +If you are already experienced with Maven and/or your IDE, you can just create a multi-maven project with the structure described here and move to the next step of this tutorial to xref:bootstraping-axonframework.adoc[configure Axon Framework in your project.] If you prefer to follow step-by-step instructions to create the project, keep reading through the following sections in this step: From 5667b1e37e9910af9f80036ccab88a01b7940fc7 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?David=20G=C3=B3mez=20G?= Date: Tue, 12 Mar 2024 13:22:53 +0100 Subject: [PATCH 3/3] Docs sources formatted (page attributes moved to top) --- .../modules/ROOT/pages/bootstraping-axonframework.adoc | 3 ++- .../modules/ROOT/pages/create-axon-framework-project.adoc | 2 +- docs/tutorial/modules/ROOT/pages/implement-create-bike.adoc | 3 ++- docs/tutorial/modules/ROOT/pages/index.adoc | 2 +- .../modules/ROOT/pages/run-app-with-docker-compose.adoc | 1 - 5 files changed, 6 insertions(+), 5 deletions(-) diff --git a/docs/tutorial/modules/ROOT/pages/bootstraping-axonframework.adoc b/docs/tutorial/modules/ROOT/pages/bootstraping-axonframework.adoc index 7ce099c..03e4c58 100644 --- a/docs/tutorial/modules/ROOT/pages/bootstraping-axonframework.adoc +++ b/docs/tutorial/modules/ROOT/pages/bootstraping-axonframework.adoc @@ -1,7 +1,8 @@ -= Bootstraping AxonFramework :navtitle: Bootstrap AxonFramework :reftext: Configure AxonFramework for your project += Bootstraping AxonFramework + In this step we will configure the dependencies to use AxonFramework in our project. == Configuring Axon's bill of materials (BOM) diff --git a/docs/tutorial/modules/ROOT/pages/create-axon-framework-project.adoc b/docs/tutorial/modules/ROOT/pages/create-axon-framework-project.adoc index 8952507..6b5f8e4 100644 --- a/docs/tutorial/modules/ROOT/pages/create-axon-framework-project.adoc +++ b/docs/tutorial/modules/ROOT/pages/create-axon-framework-project.adoc @@ -1,7 +1,7 @@ -= Create New Axon Framework Multi-Project :navtitle: Create New Project :reftext: Creating A New AxonFramework Project += Create New Axon Framework Multi-Project For our sample application, we will create a multi-module maven project containing only two modules: a `core-api` module containing the API definition and messages used within the application and a `rental` module containing the business logic for our bike rental application. diff --git a/docs/tutorial/modules/ROOT/pages/implement-create-bike.adoc b/docs/tutorial/modules/ROOT/pages/implement-create-bike.adoc index 03d8c69..d63f0c0 100644 --- a/docs/tutorial/modules/ROOT/pages/implement-create-bike.adoc +++ b/docs/tutorial/modules/ROOT/pages/implement-create-bike.adoc @@ -1,7 +1,8 @@ -= Implement Create New Bike Feature :navtitle: Create New Bike Feature :reftext: Implementing the create new bike feature += Implement Create New Bike Feature + In this step of the tutorial, we will implement the support for our first feature: create (or register) a new bike in our system. == Design considerations diff --git a/docs/tutorial/modules/ROOT/pages/index.adoc b/docs/tutorial/modules/ROOT/pages/index.adoc index 1c8b641..0fe9731 100644 --- a/docs/tutorial/modules/ROOT/pages/index.adoc +++ b/docs/tutorial/modules/ROOT/pages/index.adoc @@ -1,9 +1,9 @@ -= Introduction :navtitle: Introduction :reftext: Building A Bike Rental Application :page-needs-improvement: content :page-needs-content: Add a section or another page with the required tools: Maven, java21, Springboot, etc.. += Introduction Building a new application from scratch can be daunting, especially when learning something new. This tutorial will guide you through the various stages of development, starting with creating your first project and explaining the capabilities of Axon Framework and Axon Server. diff --git a/docs/tutorial/modules/ROOT/pages/run-app-with-docker-compose.adoc b/docs/tutorial/modules/ROOT/pages/run-app-with-docker-compose.adoc index 79a0ad4..96fb751 100644 --- a/docs/tutorial/modules/ROOT/pages/run-app-with-docker-compose.adoc +++ b/docs/tutorial/modules/ROOT/pages/run-app-with-docker-compose.adoc @@ -1,7 +1,6 @@ :navtitle: Running Your Application Locally With Docker Compose :reftext: Running your application in your local environment with Docker Compose - = Running the Application Locally With Docker Compose In this step, we will see how to run your application in your local environment with everything you need.