[doc] Fix content and linter issues in installation guide

Signed-off-by: Mélanie Bats <[email protected]>

doc/content/modules/installation-guide/pages/how-tos/https.adoc

@@ -4,21 +4,23 @@
 ====
 Enabling HTTPS with a self-signed certificate is intended for testing purposes only and shouldn't be used in a production environment.
 Self-signed certificates don't provide the same level of security and trust as certificates issued by a trusted Certificate Authority (CA).
-For production deployments, obtain a valid certificate from a trusted CA to ensure secure and reliable communication.
+For production deployments, get a valid certificate from a trusted CA to ensure secure and reliable communication.
 ====
 
 If you intend to install {product} on a local server or machine and allow several users to access it, you must enable HTTPS.
 If you don't have a certificate, you can generate one by using https://docs.oracle.com/en/java/javase/11/tools/keytool.html[keytool] for testing purposes only.
 
-This procedure requires to have the `keytool` application to be installed (the application comes with the Java Runtime Environment as explain in xref:requirements.adoc[prerequisites])
+This procedure requires installing the `keytool` application.
+The application includes the Java Runtime Environment, as explained in the xref:requirements.adoc[prerequisites] section.
 
 . Create a self-signed certificate:
 +
 [source, bash]
 ----
 keytool -genkeypair -alias myalias -keyalg RSA -keysize 2048 -validity 365 -keystore keystore.jks
 ----
-. If you have installed {product} with xref:how-tos/install/local_test.adoc#docker-install[docker], just update your docker-compose file as below (otherwise, please go to next instruction): 
+. If you have installed {product} with xref:how-tos/install/local_test.adoc#docker-install[docker], update your docker-compose file as shown below/.
+Otherwise, proceed to the next instruction:
 +
 [source, bash]
 ----
@@ -41,10 +43,10 @@ services:
       - --server.ssl.key-password=PASSWORD_USED_IN_STEP_1
 networks:
   ... no need to change anything in the networks section
----- 
+----
 
 . If you have installed {product} manually, place the certificate file next to your `{product}-application` JAR file
-. Launch your JAR (as explained in the xref:installation-guide:how-tos/install.adoc#start-app[start the application section] with the following extra properties:
+. Launch your JAR as explained in the xref:installation-guide:how-tos/install.adoc#start-app[start the application section] with the following extra properties:
 +
 [source, bash]
 ----
@@ -54,5 +56,4 @@ networks:
   --server.ssl.key-alias=myalias \
   --server.ssl.key-password=PASSWORD_USED_IN_STEP_1
 ----
-. Every user in your local network can now access the application at:
-`https://{product}_SERVER_IP:8080`
+. Every user in your local network can now access the application at: `https://{product}_SERVER_IP:8080`

doc/content/modules/installation-guide/pages/how-tos/install.adoc

@@ -1,9 +1,9 @@
 = How to install {product}?
 
-This section delves into the detailed step-by-step instructions for installing {product}.
+The following provides detailed step-by-step instructions for installing {product}.
 Detailed explanations walk you through each step.
 
-{product} can be installed following several different patterns :
+You can install {product} following several different patterns :
 
 * xref:installation-guide:how-tos/install/local_test.adoc[Basic Local Test Setup: Ideal for quick, standalone testing of {product} on a single machine to evaluate core features.]
 * xref:installation-guide:how-tos/install/multi_user_test.adoc[Local test of {product} with multiple users]

doc/content/modules/installation-guide/pages/how-tos/install/ecosystem_only.adoc

@@ -1,12 +1,13 @@
-= How to install {product} ecosystem only ?
+= Install {product} ecosystem
 
-This section provides a step-by-step guide on setting up the necessary ecosystem to develop the product locally. By following these instructions, you’ll configure your local environment with all required dependencies, tools, and services, enabling you to develop, test, and troubleshoot the product effectively on your own machine.
+This guide provides step-by-step instructions for setting up the ecosystem needed to develop the product locally.
+Following these steps configures your local environment with all required dependencies, tools, and services, enabling you to develop, test, and troubleshoot the product on your own machine.
 
 == Start the database instance
 
 {product} uses PostgreSQL as its database.
 
-For development or local testing, the simplest approach is to initiate a PostgreSQL instance using Docker.
+For development or local testing, the simplest approach is to start a PostgreSQL instance by using Docker.
 
 [source, bash]
 ----
@@ -30,27 +31,27 @@ docker run -p 5433:5432 --name syson-postgres -e POSTGRES_USER=dbuser -e POSTGRE
 [TIP]
 ====
 Docker images are build to run on x86_64 architecture.
-If you need to run {product} docker image on a Mac Silicon architecture, please execute the following command in your terminal before executing the docker image:
+If you need to run {product} Docker image on a Mac Silicon architecture, run the following command in your terminal before executing the Docker image:
 [source, bash]
 ----
-export DOCKER_DEFAULT_PLATFORM=linux/amd64 
+export DOCKER_DEFAULT_PLATFORM=linux/amd64
 ----
 ====
 
 [NOTE]
 ====
-This may take a while the first time you run this as Docker will first pull the PostgreSQL image.
+This take a while the first time you run this as Docker first pulls the PostgreSQL image.
 ====
 
-If you don't have Docker or prefer to use an existing PostgreSQL installation, modify the following command-line parameters and ensure the `POSTGRES_USER` possesses administrative rights on the database.
+If you don't have Docker or prefer to use an existing PostgreSQL installation, change the following command-line parameters and confirm the `POSTGRES_USER` possesses administrative rights on the database.
 These rights are necessary for the automatic creation of the database schema.
 
 [#start-app]
 == Start the application
 
-Before you run the application, please ensure you have following the xref:requirements.adoc[prerequisites] and downloaded the JAR ({product-jar}) from the xref:how-tos/install/production_deploy.adoc#download[download] section.
+Before you run the application, confirm you have following the xref:requirements.adoc[prerequisites] and downloaded the JAR ({product-jar}) from the xref:how-tos/install/production_deploy.adoc#download[download] section.
 
-Go to the folder containing the {product-jar} and run the command:"
+Go to the folder containing the {product-jar} and run the command:
 
 [source, bash]
 ----
@@ -67,11 +68,11 @@ Navigate to `http://localhost:8080` to experience {product}.
 
 [TIP]
 ====
-To end your local testing session, ensure you stop the running PostgreSQL Docker container using the command `docker kill syson-postgres`.
-Please note that this will erase all the data you have generated during testing.
+To end your local testing session, confirm you stop the running PostgreSQL Docker container by using the command `docker kill syson-postgres`.
+Note that this erases all the data you have generated during testing.
 ====
 
-If you encounter any issues during the installation process, please refer to the xref:troubleshooting.adoc[troubleshooting guide] for detailed solutions.
+If you meet any issues during the installation process, see the xref:troubleshooting.adoc[troubleshooting guide] for detailed solutions.
 
 == Other resources
 xref:installation-guide:how-tos/https.adoc[]

doc/content/modules/installation-guide/pages/how-tos/install/local_test.adoc

@@ -1,6 +1,7 @@
 = Local installation of {product} for single-user testing purposes
 
-This section provides instructions for installing a local version of the application, intended for testing purposes. This setup is configured for use by the local user only and does not include any security configurations.
+Follow these instructions to install a local version of the application, intended for testing purposes.
+This setup is configured for use by the local user only and doesn't include any security configurations.
 
 == Get {product}
 
@@ -19,52 +20,63 @@ For more details see xref:user-manual:cycle.adoc[].
 
 The easiest and most straightforward method to deploy {product} using Docker Compose, which automatically deploy prerequisites.
 
-[INFO]
+[NOTE]
 ====
-Before you proceed with the installation, please ensure you have the following xref:requirements.adoc[Hardware prerequisites]:
+Before you proceed with the installation, confirm you have the following xref:requirements.adoc[Hardware prerequisites]:
 
-* https://www.docker.com/[Docker] installed.
+* https://www.docker.com/[Docker] installed and running.
 ====
 
-{product} is distributed as a docker container.
-To deploy {product}, just download the https://github.com/eclipse-syson/syson/blob/{syson-tag}/docker-compose.yml[docker-compose] file and run the following docker command in the same folder as the one where is the _docker-compose.yml_ file:
+{product} is distributed as a Docker container.
+To deploy {product}, just download the https://github.com/eclipse-syson/syson/blob/{syson-tag}/docker-compose.yml[docker-compose] file and run the following docker command in the same folder as the one where's the _docker-compose.yml_ file:
 [source, bash]
 ----
 docker compose up
 ----
 
-This method deploys {product} (matching the version tagged in this documentation) along with a PostgreSQL database, all within a Docker container.
+[IMPORTANT]
+====
+To run Docker Compose confirm your Docker is running.
+====
+
+This method deploys {product} matching the version tagged in this documentation with a PostgreSQL database, all within a Docker container.
 
 [TIP]
 ====
 Docker images are build to run on x86_64 architecture.
-If you need to run {product} docker image on a Mac Silicon architecture, please execute the following command in your terminal before executing the docker image:
+If you need to run {product} Docker image on a Mac Silicon architecture, run the following command in your terminal before executing the Docker image:
+
 [source, bash]
 ----
-export DOCKER_DEFAULT_PLATFORM=linux/amd64 
+export DOCKER_DEFAULT_PLATFORM=linux/amd64
 ----
 ====
 
-[INFO]
+[NOTE]
 ====
-To deploy a specific version vYYYY.MM.0, edit the _docker-compose.yml_ file and replace the tagged version with your desired version. For example, update the following line in the _docker-compose.yml_:
+To deploy a specific version `vYYYY.MM.0`, edit the `docker-compose.yml` file and replace the tagged version with your required version.
+For example, update the following line in the `docker-compose.yml`:
+
+[source,docker]
+----
 app:
   image: "${IMAGE_TAG:-eclipsesyson/syson:*vYYYY.MM.0*}"
+----
 ====
 
-All accessible versions of {product} as Docker containers are listed in the https://hub.docker.com/r/eclipsesyson/syson/tags[{product} Docker registry].
+All available versions of {product} as Docker containers are listed in the https://hub.docker.com/r/eclipsesyson/syson/tags[{product} Docker registry].
 
-Once your Docker up, please go directly to the <<openwebbrowser>>[Open your web browser] section!
+Once your Docker up, go directly to the <<openwebbrowser>>[Open your web browser] section.
 
 [#openwebbrowser]
 == Open your web browser
 
 Navigate to `http://localhost:8080` to experience {product}.
 
-[TIP]
+[CAUTION]
 ====
-To end your local testing session, ensure you stop the running PostgreSQL and {product} Docker container and using the command `docker compose down`.
-Please note that this will erase all the data you have generated during testing.
+To end your local testing session, confirm you stop the running PostgreSQL and {product} Docker container and by using the command `docker compose down`.
+Note that this erases all the data you have generated during testing.
 ====
 
-If you encounter any issues during the installation process, please refer to the xref:troubleshooting.adoc[troubleshooting guide] for detailed solutions.
+If you meet any issues during the installation process, see the xref:troubleshooting.adoc[troubleshooting guide] for detailed solutions.

doc/content/modules/installation-guide/pages/how-tos/install/multi_user_test.adoc

@@ -1,26 +1,27 @@
 = Local installation of {product} for multi-user testing purposes
 
-This section provides instructions for installing a multi-user version of the application, intended for testing in an environment with multiple users. This setup includes configurations to allow access by different users within the same local network but does not apply any specific security configurations.
+Follow these instructions to install a multi-user version of the application, intended for testing in an environment with several users.
+This setup includes configurations to allow access by different users within the same local network but doesn't apply any specific security configurations.
 
-To be used by multiples users, the {product} serveur must be availlable using the network to all users.
-The require to have HTTPS configured on the {product} serveur.
+To be used by multiples users, the {product} server must be available by using the network to all users.
+The require to have HTTPS configured on the {product} server.
 
 
 == Prepare single user deployment
 
-This procedure is an extantion of the basic installation procedure xref:installation-guide:how-tos/install/local_test.adoc[single user]
+This procedure is an extension of the basic installation procedure xref:installation-guide:how-tos/install/local_test.adoc[single user]
 
 == Prepare certificates
 
 Detailed instructions to generate SSL certificates are explained xref:installation-guide:how-tos/https.adoc[here]
 
 == Share the {product} server access
 
-By following the two previous procedure, the {product} server is now availlable on the network, hosted by your local computer and secured using a self-signed HTTPS certificate.
+By following the two previous procedure, the {product} server is now available on the network, hosted by your local computer and secured by using a self-signed HTTPS certificate.
 
-To share the server acces with other people on the same network, the IP adrress of the local computer must be share.
+To share the server access with other people on the same network, the IP address of the local computer must be share.
 
-The {product} server must be availlable ont the url https://<localComputerIp>:8080/[]
+The {product} server must be available on the URL https://<localComputerIp>:8080/[]
 
 
 [WARNING]
@@ -29,4 +30,4 @@ Some enterprise networks can be secured or configured to block this kind of traf
 ====
 
 
-If you encounter any issues during the installation process, please refer to the xref:troubleshooting.adoc[troubleshooting guide] for detailed solutions.
+If you meet any issues during the installation process, see the xref:troubleshooting.adoc[troubleshooting guide] for detailed solutions.

doc/content/modules/installation-guide/pages/how-tos/install/production_deploy.adoc

@@ -1,6 +1,7 @@
-= How to install {product} for production ?
+= Install {product} for production
 
-This section provides instructions for installing a production-ready version of the application. This setup is intended for deployment in a live environment, with full multi-user access and all necessary security configurations.
+Follow these instructions to install a production-ready version of the application.
+This setup is intended for deployment in a live environment, with full multi-user access and all necessary security configurations.
 
 == Get {product}
 
@@ -16,16 +17,17 @@ For more details see xref:user-manual:cycle.adoc[].
 
 == Prepare ecosystem
 
-Pay attention to deploy enterprise grade version of the prerequisites. In particular the database service. Before do deploy manually the database, we recommend to use managed database instance (provided by the IT service of a corporation or using cloud services)
+Pay attention to deploying enterprise-grade version of the prerequisites, including the database service.
+Before manually deploying the database, it's recommend to use a managed database instance, either provided by the organization's IT service or through cloud services.
 
 [INFO]
 ====
-Before you proceed with the installation, please ensure you have  following the xref:requirements.adoc[prerequisites]
+Before you proceed with the installation, confirm you have  following the xref:requirements.adoc[prerequisites]
 ====
 
-We recommend to provide a dedicated host (server or virtual machine) to serve the {product} application and only the application.
+It's recommended to provide a dedicated host, such as a server or virtual machine, to serve the {product} application, and no other services.
 
-This step provide the following configuration elements :
+This step provides the following configuration elements :
 
 * database hostname
 * database port
@@ -36,7 +38,7 @@ This step provide the following configuration elements :
 [#download]
 == Installing {product} Manually
 
-{product} is distributed as a single _executable Java Archive_ `JAR` which contains the complete {product} application along with all its dependencies.
+{product} is distributed as a single _executable Java Archive_ `JAR` which has the complete {product} application along with all its dependencies.
 This distribution simplifies the setup process, enabling convenient exploration of {product}'s features.
 
 To download the latest pre-built JAR for {product}, follow these steps:
@@ -56,13 +58,14 @@ This process ensures that you get the most recent version of the {product} appli
 [#secure-app]
 == Secure the application
 
-As explain on this xref:installation-guide:how-tos/https.adoc[guide], the {product} application must be secured to ba available on a network. For a production grade deployment, certificates used to secure the connection must be valid and provided by a valid authority.
+As explain on this xref:installation-guide:how-tos/https.adoc[guide], the {product} application must be secured to ba available on a network.
+For a production grade deployment, certificates used to secure the connection must be valid and provided by a valid authority.
 
-Documentation to generate this kind of certificate is provided by dedicated organism (https://www.namecheap.com/support/knowledgebase/article.aspx/9422/2290/generating-a-csr-on-tomcat-using-a-keytool/[here is an example]).
+Documentation to generate this kind of certificate is provided by dedicated organization, such as https://www.namecheap.com/support/knowledgebase/article.aspx/9422/2290/generating-a-csr-on-tomcat-using-a-keytool/[Namecheap].
 
-Following the certification authority, a PKCS12 keystore must be produced.
+The certification authority requires producing a PKCS12 keystore.
 
-This step provide the following configuration elements :
+This step provides the following configuration elements:
 
 * keystore path
 * keystore password
@@ -72,7 +75,7 @@ This step provide the following configuration elements :
 [#start-app]
 == Start the application
 
-To run the application, you'll need to use the Java Runtime Environment (JRE) to execute the pre-build JAR ({product-jar}) you xref:how-tos/install/production_deploy.adoc#download[downloaded] earlier.
+To run the application, you'll need to use the Java Runtime Environment (JRE) to run the pre-build JAR, {product-jar} xref:how-tos/install/production_deploy.adoc#download[downloaded] earlier.
 
 Go to the folder containing the {product-jar} and run the command:
 
@@ -98,5 +101,4 @@ java -jar path/to/your/syson-application-YEAR.MONTH.0.jar \
 
 Navigate to `https://<serverIP>:443` to experience {product}.
 
-
-If you encounter any issues during the installation process, please refer to the xref:troubleshooting.adoc[troubleshooting guide] for detailed solutions.
+If you meet any issues during the installation process, see the xref:troubleshooting.adoc[troubleshooting guide] for detailed solutions.