#822 Quick review of the documentation

nemerosa · Mar 13, 2021 · fa58837 · fa58837
1 parent 3d16440
commit fa58837
Show file tree

Hide file tree

Showing 4 changed files with 10 additions and 28 deletions.
diff --git a/ontrack-docs/src/docs/asciidoc/index.adoc b/ontrack-docs/src/docs/asciidoc/index.adoc
@@ -17,6 +17,8 @@ Damien Coraboeuf
 
 include::quick-start.adoc[]
 
+// TODO include::saas.adoc[]
+
 include::installation.adoc[]
 
 include::setup.adoc[]
@@ -27,16 +29,4 @@ include::usage.adoc[]
 
 include::api.adoc[]
 
-//include::usage.adoc[]
-//
-//include::administration.adoc[]
-//
-//include::integration.adoc[]
-//
-//include::dsl.adoc[]
-//
-//include::contributing.adoc[]
-//
-//include::appendixes.adoc[]
-
 // ========================================================
diff --git a/ontrack-docs/src/docs/asciidoc/installation-docker-compose.adoc b/ontrack-docs/src/docs/asciidoc/installation-docker-compose.adoc
@@ -1,8 +1,7 @@
 [[installation-docker-compose]]
 === Docker Compose installation
 
-The fastest way to start Ontrack is to use Docker Compose, but it might not be
-the best way to run it in production.
+The fastest way to start Ontrack is to use Docker Compose, but it might not be adapted for a production environment.
 
 The Docker Compose file can be downloaded from:
 
@@ -21,8 +20,7 @@ This starts three services:
 * a Postgres database
 * an Elasticsearch single node
 
-Neither Postgres or Elasticsearch are exposed by default, but you can of course
-edit the Docker Compose file at your convenience.
+Neither Postgres or Elasticsearch are exposed by default, but you can of course edit the Docker Compose file at your convenience.
 
 The version of Ontrack is set by default to `4` (latest 4.x version) but
 you can override it using the `ONTRACK_VERSION` environment variable.

diff --git a/ontrack-docs/src/docs/asciidoc/installation-docker.adoc b/ontrack-docs/src/docs/asciidoc/installation-docker.adoc
@@ -1,11 +1,9 @@
 [[installation-docker]]
 === Docker installation
 
-The Ontrack Docker image is available in the Docker Hub
-at https://hub.docker.com/r/nemerosa/ontrack.
+The Ontrack Docker image is available in the Docker Hub at https://hub.docker.com/r/nemerosa/ontrack.
 
-Each specific version is available and also a "latest" version per major and minor
-version. For example:
+Each specific version is available and also a "latest" version per major and minor version. For example:
 
 * 4
 * 4.0
@@ -32,12 +30,8 @@ docker container run \
     nemerosa/ontrack:4
 ----
 
-The memory settings and other JVM parameters for Ontrack can be passed
-using the `JAVA_OPTIONS` environment variable.
+The memory settings and other JVM parameters for Ontrack can be passed using the `JAVA_OPTIONS` environment variable.
 
-Other <<configuration-properties,Ontrack configuration properties>> must be passed
-through environment variables.
+Other <<configuration-properties,Ontrack configuration properties>> must be passed through environment variables.
 
-Optionally, a volume can be mapped to the Ontrack `/var/ontrack/data` Docker
-volume. This is particularly needed when using a secret storage based on the
-file system (see <<setup>>).
+Optionally, a volume can be mapped to the Ontrack `/var/ontrack/data` Docker volume. This is particularly needed when using a secret storage based on the file system (see <<setup>>).
diff --git a/ontrack-docs/src/docs/asciidoc/installation-jar.adoc b/ontrack-docs/src/docs/asciidoc/installation-jar.adoc
@@ -36,5 +36,5 @@ java -jar ontrack.jar
 
 [source,bash]
 ----
-SPRING_DATASOURCE_URL=... java ...
+SPRING_DATASOURCE_URL=...
 ----