From 5a78e3c7035a1dde52494cb11dd968c1e68949a5 Mon Sep 17 00:00:00 2001 From: Luca Corrieri Date: Thu, 22 Aug 2024 14:58:02 +0200 Subject: [PATCH] docs: fix info callouts --- docs/getting-started.md | 2 +- docs/operator-manual/pr-mr-workflow.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/getting-started.md b/docs/getting-started.md index 717e0d69..f18d86b1 100644 --- a/docs/getting-started.md +++ b/docs/getting-started.md @@ -62,7 +62,7 @@ spec: ``` !!! info -You can also connect to a public repository by omitting `spec.repository.secretName` in your `TerraformRepository` definition. + You can also connect to a public repository by omitting `spec.repository.secretName` in your `TerraformRepository` definition. ## 3. Synchronize a terraform layer diff --git a/docs/operator-manual/pr-mr-workflow.md b/docs/operator-manual/pr-mr-workflow.md index b50dbbcb..0b6b51c6 100644 --- a/docs/operator-manual/pr-mr-workflow.md +++ b/docs/operator-manual/pr-mr-workflow.md @@ -3,14 +3,14 @@

!!! info -In this documentation all references to pull requests can be change to merge requests for GitLab. However, the resulting Kubernetes object will still be named `TerraformPullRequest`. + In this documentation all references to pull requests can be change to merge requests for GitLab. However, the resulting Kubernetes object will still be named `TerraformPullRequest`. ## Components ### The server !!! info -For more information about the server, see the [architectural overview](./architecture.md) documentation. + For more information about the server, see the [architectural overview](./architecture.md) documentation. Upon receiving a Pull Request creation event, the server creates a `TerraformPullRequest` resource. @@ -35,7 +35,7 @@ The status of a `TerraformPulLRequest` is defined using the [conditions standard - `IsCommentUpToDate`. This condition is used to check if the controller needs to send a comment to a pull request. This is checked by comparing the last discovered commit and the last commit for which a comment was already sent. !!! info -We use annotations to store information. + We use annotations to store information. With those 3 conditions, we defined 3 states: