From ee7758872741c77e2cb201b296bf0354194a5702 Mon Sep 17 00:00:00 2001 From: Timo Beller Date: Thu, 20 Jan 2022 10:50:25 +0100 Subject: [PATCH] docs(typos): fixes copy-and-past-errors --- .../templates/container-publish-snapshot.adoc | 2 +- .../chapters/templates/container-publish.adoc | 4 ++-- .../chapters/templates/docker-compose-deploy.adoc | 12 ++++++------ .../chapters/templates/gradle-build-template.adoc | 2 +- .../chapters/templates/gradle-test-template.adoc | 2 +- .../chapters/templates/maven-build-template.adoc | 2 +- .../templates/maven-dependencies-template.adoc | 4 ++-- .../chapters/templates/npm-build-template.adoc | 2 +- .../templates/npm-dependencies-template.adoc | 2 +- .../chapters/templates/npm-lint-template.adoc | 2 +- .../chapters/templates/npm-test-template.adoc | 2 +- documentation/chapters/templates/publish-image.adoc | 2 +- .../chapters/templates/tool-documentation-tool.adoc | 2 +- documentation/chapters/templates/tool-sonar7.adoc | 2 +- 14 files changed, 21 insertions(+), 21 deletions(-) diff --git a/documentation/chapters/templates/container-publish-snapshot.adoc b/documentation/chapters/templates/container-publish-snapshot.adoc index a3b8118..b52163e 100644 --- a/documentation/chapters/templates/container-publish-snapshot.adoc +++ b/documentation/chapters/templates/container-publish-snapshot.adoc @@ -20,7 +20,7 @@ Dabei sind die Imagenamen der Container abhängig von den Branchnamen. || Siehe <<_container_publish, Container Publish>> | |=== -.sonar-template +.container-publish-snapshot [source,yaml] ---- include::{sourcedir}/container-publish-snapshot.gitlab-ci.yml[] diff --git a/documentation/chapters/templates/container-publish.adoc b/documentation/chapters/templates/container-publish.adoc index 9824c9e..f29f243 100644 --- a/documentation/chapters/templates/container-publish.adoc +++ b/documentation/chapters/templates/container-publish.adoc @@ -16,12 +16,12 @@ Falls das Projekt aus mehreren Poms besteht, kann `before_script:` benutzt werde |DOCKER_REGISTRY | Definiert die Registry an zu dem das Image veröffentlicht werden soll | $CI_REGISTRY_IMAGE |DOCKER_REGISTRY_USER | Definiert den User der benutzt werden soll | $CI_REGISTRY_USER |DOCKER_REGISTRY_PASSWORD | Definiert das Passwort des Benutzers | $CI_REGISTRY_PASSWORD -|EXTRA_ARGS | Weitere Argumente die an an den jeweiligen Job gegeben werden sollen. | "" +|EXTRA_ARGS | Weitere Argumente die an den jeweiligen Job gegeben werden sollen. | "" |USE_VERSIONFILE | Wenn true, dann wird zur Versionierung das ./version file aus dem set-version tool verwendet | "false" |ARTIFACT | Der Name des Versionfiles aus dem set-version tool | "version" |=== -.sonar-template +.container-publish [source,yaml] ---- include::{sourcedir}/container-publish.gitlab-ci.yml[] diff --git a/documentation/chapters/templates/docker-compose-deploy.adoc b/documentation/chapters/templates/docker-compose-deploy.adoc index aa6caf9..ab61fd2 100644 --- a/documentation/chapters/templates/docker-compose-deploy.adoc +++ b/documentation/chapters/templates/docker-compose-deploy.adoc @@ -4,11 +4,11 @@ Kopiert Daten mithilfe von scp aus dem Repo auf ein Deployment-System. Dort wird über SSH Docker-compose up ausgeführt. - Für die SSH Verbindung muss ein Private-Key in den CI-CD variablen hinter dem Namen $SSH_PRIVATE_KEY abgelegt werden. + Für die SSH Verbindung muss ein Private-Key in den CI-CD Variablen unter dem Namen $SSH_PRIVATE_KEY abgelegt werden. Wenn bereits andere SSH Keys vorhanden sind kann SSH_PRIVATE_KEY_DEPLOY in den Varibalen überschrieben werden. Um die Compose-Files zu parametrisieren kann ein .env File benutzt werden. -Dieses sollte mit einem Skript das hinter der variable ENV_SETUP_FILE hinterlegt ist erstellt werden. +Dieses sollte mit einem Skript das unter der Variable ENV_SETUP_FILE hinterlegt ist erstellt werden. .env File sollten nicht in der Repo liegen da keine Passwörter in der Repo liegen sollten. .Beispiel für ein setup_env.sh @@ -29,7 +29,7 @@ echo SOME_PASSWORD="$SOME_PASSWORD" >>.env |Name |Description | Default Value | SSH_PRIVATE_KEY_DEPLOY -| Private key der zugriff auf den Deployment Server hat. +| Private key der Zugriff auf den Deployment Server hat. | $SSH_PRIVATE_KEY (In den CI-CD variablen) | SSH_URL @@ -45,8 +45,8 @@ echo SOME_PASSWORD="$SOME_PASSWORD" >>.env | "$CI_REGISTRY" | ENV_SETUP_FILE -| Falls ein .env file benutzt werden soll kann es mit einem sh script erstellt werden. -Secrets sollten nicht in der Repository liegen sondern in den CI-CD variablen der Repository settings. +| Falls ein .env file benutzt werden soll, kann es mit einem sh script erstellt werden. +Secrets sollten nicht in der Repository liegen, sondern in den CI-CD Variablen der Repository settings. | "setup_env.sh" | SCP_DESTINATION @@ -54,7 +54,7 @@ Secrets sollten nicht in der Repository liegen sondern in den CI-CD variablen de | - | SCP_SOURCE -| Pfad zu den daten die mit hilfe von SCP kopiert werden sollen. +| Pfad zu den daten die mithilfe von SCP kopiert werden sollen. | $CI_PROJECT_DIR | COMPOSE_EXTRA_ARGS diff --git a/documentation/chapters/templates/gradle-build-template.adoc b/documentation/chapters/templates/gradle-build-template.adoc index b78d27e..0f45d65 100644 --- a/documentation/chapters/templates/gradle-build-template.adoc +++ b/documentation/chapters/templates/gradle-build-template.adoc @@ -2,7 +2,7 @@ = Gradle-build-template -Diese Template läd die Dependencies herunter und das Projekt. +Dieses Template lädt die Dependencies herunter und baut das Projekt. Die Ergebnisse werden als Artifact gespeichert. .Variables diff --git a/documentation/chapters/templates/gradle-test-template.adoc b/documentation/chapters/templates/gradle-test-template.adoc index b192c09..85e353f 100644 --- a/documentation/chapters/templates/gradle-test-template.adoc +++ b/documentation/chapters/templates/gradle-test-template.adoc @@ -10,7 +10,7 @@ Die Ergebnisse werden als Artifact gespeichert. |Name |Description | Default Value |=== -.gradle-build-template +.gradle-test-template [source,yaml] ---- include::{sourcedir}/gradle-test-template.gitlab-ci.yml[] diff --git a/documentation/chapters/templates/maven-build-template.adoc b/documentation/chapters/templates/maven-build-template.adoc index 71e9f06..7670432 100644 --- a/documentation/chapters/templates/maven-build-template.adoc +++ b/documentation/chapters/templates/maven-build-template.adoc @@ -2,7 +2,7 @@ = maven-build-template -Diese Template Baut die .jar Files und speichert die Ergebnisse als Artifact. +Dieses Template baut die .jar Files und speichert die Ergebnisse als Artifact. .Variables |=== diff --git a/documentation/chapters/templates/maven-dependencies-template.adoc b/documentation/chapters/templates/maven-dependencies-template.adoc index 9cbba8f..d767fae 100644 --- a/documentation/chapters/templates/maven-dependencies-template.adoc +++ b/documentation/chapters/templates/maven-dependencies-template.adoc @@ -2,8 +2,8 @@ = maven-dependencies-template -Dieses Template läd die Maven Abhängigkeiten des Projekts runter. -Bitte den Cache hinzufügen. Siehe xref:Generel-Veriablen[Generelle Veriablen] +Dieses Template lädt die Maven Abhängigkeiten des Projekts runter. +Bitte den Cache hinzufügen. Siehe xref:Generel-Variablen[Generelle Variablen] .Variables |=== diff --git a/documentation/chapters/templates/npm-build-template.adoc b/documentation/chapters/templates/npm-build-template.adoc index e13b88b..4169d70 100644 --- a/documentation/chapters/templates/npm-build-template.adoc +++ b/documentation/chapters/templates/npm-build-template.adoc @@ -2,7 +2,7 @@ = npm-build-template -Dieses Template baut das NPM projekt und speichert die Ergebnisse als Artifact.. +Dieses Template baut das NPM projekt und speichert die Ergebnisse als Artifact. .Variables |=== diff --git a/documentation/chapters/templates/npm-dependencies-template.adoc b/documentation/chapters/templates/npm-dependencies-template.adoc index 11feb1a..383e624 100644 --- a/documentation/chapters/templates/npm-dependencies-template.adoc +++ b/documentation/chapters/templates/npm-dependencies-template.adoc @@ -3,7 +3,7 @@ = npm-dependencies-template Dieses Template läd die NPM Abhängigkeiten des Projekts runter. -Bitte den Cache hinzufügen. Siehe xref:Generel-Veriablen[Generelle Veriablen] +Bitte den Cache hinzufügen. Siehe xref:Generel-Variablen[Generelle Variablen] .Variables |=== diff --git a/documentation/chapters/templates/npm-lint-template.adoc b/documentation/chapters/templates/npm-lint-template.adoc index 50437f2..f559f09 100644 --- a/documentation/chapters/templates/npm-lint-template.adoc +++ b/documentation/chapters/templates/npm-lint-template.adoc @@ -2,7 +2,7 @@ = npm-lint-template -Dieses Template durchläuft den Linter das NPM projekts. +Dieses Template durchläuft den Linter des NPM Projekts. .Variables |=== diff --git a/documentation/chapters/templates/npm-test-template.adoc b/documentation/chapters/templates/npm-test-template.adoc index 190f7fc..94d7d07 100644 --- a/documentation/chapters/templates/npm-test-template.adoc +++ b/documentation/chapters/templates/npm-test-template.adoc @@ -2,7 +2,7 @@ = npm-test-template -Dieses Template baut das NPM projekt. +Dieses Template baut das NPM Projekt. .Variables |=== diff --git a/documentation/chapters/templates/publish-image.adoc b/documentation/chapters/templates/publish-image.adoc index bf41cfd..0126c78 100644 --- a/documentation/chapters/templates/publish-image.adoc +++ b/documentation/chapters/templates/publish-image.adoc @@ -2,7 +2,7 @@ = Publish-Image-jib -Baut mithilfe von jib ein Docker Image und läd es in der Docker Registry des Projekt hoch. +Baut mithilfe von jib ein Docker Image und läd es in die Docker Registry des Projekts hoch. Dieser Schritt wird nur ausgeführt, wenn ein Tag gesetzt wird. .Variables diff --git a/documentation/chapters/templates/tool-documentation-tool.adoc b/documentation/chapters/templates/tool-documentation-tool.adoc index e58075f..97f8299 100644 --- a/documentation/chapters/templates/tool-documentation-tool.adoc +++ b/documentation/chapters/templates/tool-documentation-tool.adoc @@ -3,7 +3,7 @@ = Dokumentation-Tool-template Das Dokumentation-Tool template. -Mehr Details und die Variablendokumentation sind zu finden hier: https://gitlab.exxcellent.de/gilden/ci/exxcellent-documentation-tool[Gilde CI/CD: exxcellent-documentation-tool]. +Mehr Details und die Variablendokumentation sind hier zu finden: https://gitlab.exxcellent.de/gilden/ci/exxcellent-documentation-tool[Gilde CI/CD: exxcellent-documentation-tool]. .dokumentation-tool [source,yaml] diff --git a/documentation/chapters/templates/tool-sonar7.adoc b/documentation/chapters/templates/tool-sonar7.adoc index 080ceb9..bdc55c7 100644 --- a/documentation/chapters/templates/tool-sonar7.adoc +++ b/documentation/chapters/templates/tool-sonar7.adoc @@ -3,7 +3,7 @@ = sonar-template Ruft den Sonar Job für das Projekt auf. -Mehr Details zu finden hier: https://gitlab.exxcellent.de/gilden/ci/exxcellent-sonar-tool[Gilde CI/CD: exxcellent-sonar-tool]. +Mehr Details sind hier zu finden: https://gitlab.exxcellent.de/gilden/ci/exxcellent-sonar-tool[Gilde CI/CD: exxcellent-sonar-tool]. .Variables |===