Skip to content

Commit

Permalink
Merge pull request #12 from AxonIQ/docs
Browse files Browse the repository at this point in the history
Minor doc fixes
  • Loading branch information
dgomezg authored Mar 12, 2024
2 parents 3a600fe + 5667b1e commit 7636b59
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 9 deletions.
Original file line number Diff line number Diff line change
@@ -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)
Expand Down
Original file line number Diff line number Diff line change
@@ -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.

Expand Down Expand Up @@ -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 `<modules>` 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:

Expand Down
3 changes: 2 additions & 1 deletion docs/tutorial/modules/ROOT/pages/implement-create-bike.adoc
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/tutorial/modules/ROOT/pages/index.adoc
Original file line number Diff line number Diff line change
@@ -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.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,12 +13,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.

Expand Down Expand Up @@ -71,7 +71,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]
----
. ____ _ __ _ _
Expand All @@ -93,7 +93,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.

Expand Down

0 comments on commit 7636b59

Please sign in to comment.