Merge branch 'admonitions' into 'master'

added more admonitions for warnings and examples

See merge request CodeScoring/docs!650

Author: amaksimovv

docs/agent/gitlab-ci.en.md

@@ -9,35 +9,34 @@ The CLI agent supports integration into Gitlab CI using the `.gitlab-ci.yaml` fi
 
 ### Johnny Docker image
 
-An example of the contents of the `.gitlab-ci.yaml` file when using a Docker image of the agent:
-
-`<version>` must be replaced with the agent version. A list of current versions with descriptions is available in [Changelog](/changelog/johnny-changelog.en/).
-
-```yaml
-stages:
- - test
-
-sca:
- stage: test
-
- script:
- - docker pull REGISTRY_URL/johnny-depp:<version>
- ->
- docker run -v $(pwd):/code
- <registry-address>/johnny-depp
- --api_token $CODESCORING_API_TOKEN
- --api_url $CODESCORING_API_URL
- --ignore.git
- --ignore fixtures
- --ignore parsers
- .
-
- artifacts:
- paths:
- -bom.json
- when: always
- expire_in: 1 week
-```
+!!! example "Example .gitlab-ci.yaml file (Docker image)"
+    `<version>` must be replaced with the agent version. A list of current versions with descriptions is available in [Changelog](/changelog/johnny-changelog.en/).
+
+    ```yaml
+    stages:
+     - test
+
+    sca:
+     stage: test
+
+     script:
+     - docker pull REGISTRY_URL/johnny-depp:<version>
+     ->
+     docker run -v $(pwd):/code
+     <registry-address>/johnny-depp
+     --api_token $CODESCORING_API_TOKEN
+     --api_url $CODESCORING_API_URL
+     --ignore.git
+     --ignore fixtures
+     --ignore parsers
+     .
+
+     artifacts:
+     paths:
+     -bom.json
+     when: always
+     expire_in: 1 week
+    ```
 
 ### Johnny binary file
 
@@ -57,29 +56,28 @@ To use the agent binary file, you must first perform the following steps on the
  chmod +x /usr/local/bin/johnny
  ```
 
-An example of executing the binary file in `.gitlab-ci.yaml`:
-
-```yaml
-stages:
- -test
-
-sca:
- stage: test
-
- script:
- ->
- johnny
- scan dir
- --api_token $JOHNNY_API_TOKEN
- --api_url $JOHNNY_API_URL
- --ignore.git
- --ignore fixtures
- --ignore parsers
- .
-
- artifacts:
- paths:
- -bom.json
- when: always
- expire_in: 1 week
-```
+!!! example "Example .gitlab-ci.yaml (binary file)"
+    ```yaml
+    stages:
+     -test
+
+    sca:
+     stage: test
+
+     script:
+     ->
+     johnny
+     scan dir
+     --api_token $JOHNNY_API_TOKEN
+     --api_url $JOHNNY_API_URL
+     --ignore.git
+     --ignore fixtures
+     --ignore parsers
+     .
+
+     artifacts:
+     paths:
+     -bom.json
+     when: always
+     expire_in: 1 week
+    ```

docs/agent/gitlab-ci.md

@@ -9,35 +9,34 @@ hide:
 
 ### Docker-образ Johnny
 
-Пример содержания файла `.gitlab-ci.yaml` при использовании docker-образа консольного агента:
-
-`<version>` необходимо заменить на версию агента. Список актуальных версий с описанием доступен на странице [Changelog](/changelog/johnny-changelog/).
-
-```yaml
-stages:
-  - test
-
-sca:
-  stage: test
-
-  script:
-    - docker pull REGISTRY_URL/johnny-depp:<version>
-    - >
-      docker run -v $(pwd):/code 
-      <registry-address>/johnny-depp 
-      --api_token $CODESCORING_API_TOKEN
-      --api_url $CODESCORING_API_URL 
-      --ignore .git 
-      --ignore fixtures 
-      --ignore parsers
-      .
-
-  artifacts:
-    paths:
-      - bom.json
-    when: always
-    expire_in: 1 week
-```
+!!! example "Пример файла .gitlab-ci.yaml (Docker-образ)"
+    `<version>` необходимо заменить на версию агента. Список актуальных версий с описанием доступен на странице [Changelog](/changelog/johnny-changelog/).
+
+    ```yaml
+    stages:
+      - test
+
+    sca:
+      stage: test
+
+      script:
+        - docker pull REGISTRY_URL/johnny-depp:<version>
+        - >
+          docker run -v $(pwd):/code
+          <registry-address>/johnny-depp
+          --api_token $CODESCORING_API_TOKEN
+          --api_url $CODESCORING_API_URL
+          --ignore .git
+          --ignore fixtures
+          --ignore parsers
+          .
+
+      artifacts:
+        paths:
+          - bom.json
+        when: always
+        expire_in: 1 week
+    ```
 
 ### Бинарный файл Johnny
 
@@ -57,29 +56,28 @@ sca:
   chmod +x /usr/local/bin/johnny
   ```
 
-Пример вызова бинарного файла агента в `.gitlab-ci.yaml`:
-
-```yaml
-stages:
-  - test
-
-sca:
-  stage: test
-
-  script:
-    - >
-      johnny
-      scan dir
-      --api_token $JOHNNY_API_TOKEN
-      --api_url $JOHNNY_API_URL
-      --ignore .git
-      --ignore fixtures
-      --ignore parsers
-      .
-
-  artifacts:
-    paths:
-      - bom.json
-    when: always
-    expire_in: 1 week
-```
+!!! example "Пример вызова в .gitlab-ci.yaml (бинарный файл)"
+    ```yaml
+    stages:
+      - test
+
+    sca:
+      stage: test
+
+      script:
+        - >
+          johnny
+          scan dir
+          --api_token $JOHNNY_API_TOKEN
+          --api_url $JOHNNY_API_URL
+          --ignore .git
+          --ignore fixtures
+          --ignore parsers
+          .
+
+      artifacts:
+        paths:
+          - bom.json
+        when: always
+        expire_in: 1 week
+    ```

docs/agent/jenkins-pipeline.en.md

@@ -11,39 +11,38 @@ The CLI agent supports integration into Jenkins in two ways: through `Jenkinsfil
 
 ### Using a Docker image
 
-An example of adding agent to a `pipeline` using a Docker image:
-
-```groovy
-pipeline {
- agent any
-
- environment {
- CODESCORING_REGISTRY_URL='REGISTRY_URL'
- CODESCORING_AGENT_IMAGE='REGISTRY_URL/johnny-depp:<version>'
- CODESCORING_REGISTRY_CREDENTIALS=credentials('cs-registry-creds')
- CODESCORING_API_URL='https://localhost:8080'
- }
-
- stages {
-
- stage("Login to Codescoring docker registry") {
- steps {
- sh """
- docker login -u "$CODESCORING_REGISTRY_CREDENTIALS_USR" "$CODESCORING_REGISTRY_URL" -p "$CODESCORING_REGISTRY_CREDENTIALS_PSW"
- """
- }
- }
-
- stage('Run CodeScoring Agent') {
- steps {
- sh """
- docker run -v \$(pwd):/code --rm ${CODESCORING_AGENT_IMAGE} --api_token ${CODESCORING_API_TOKEN} --api_url ${CODESCORING_API_URL} --ignore .tmp --ignore fixtures --ignore .git .
- """
- }
- }
- }
-}
-```
+!!! example "Example of adding agent to a pipeline (Docker image)"
+    ```groovy
+    pipeline {
+     agent any
+
+     environment {
+     CODESCORING_REGISTRY_URL='REGISTRY_URL'
+     CODESCORING_AGENT_IMAGE='REGISTRY_URL/johnny-depp:<version>'
+     CODESCORING_REGISTRY_CREDENTIALS=credentials('cs-registry-creds')
+     CODESCORING_API_URL='https://localhost:8080'
+     }
+
+     stages {
+
+     stage("Login to Codescoring docker registry") {
+     steps {
+     sh """
+     docker login -u "$CODESCORING_REGISTRY_CREDENTIALS_USR" "$CODESCORING_REGISTRY_URL" -p "$CODESCORING_REGISTRY_CREDENTIALS_PSW"
+     """
+     }
+     }
+
+     stage('Run CodeScoring Agent') {
+     steps {
+     sh """
+     docker run -v \$(pwd):/code --rm ${CODESCORING_AGENT_IMAGE} --api_token ${CODESCORING_API_TOKEN} --api_url ${CODESCORING_API_URL} --ignore .tmp --ignore fixtures --ignore .git .
+     """
+     }
+     }
+     }
+    }
+    ```
 
 ### Using a binary file
 
@@ -71,26 +70,25 @@ To use the console agent binary file, you must first perform the following steps
  chmod +x /usr/local/bin/johnny
 ```
 
-An example of executing the binary file in `pipeline`:
-
-```groovy
-pipeline {
- agent any
-
- environment {
- CODESCORING_API_URL='http://localhost:8001'
- CODESCORING_API_TOKEN='API_TOKEN'
- }
-
- stages {
-
- stage('Run CodeScoring Agent') {
- steps {
- sh """
- johnny scan dir --api_token ${CODESCORING_API_TOKEN} --api_url ${CODESCORING_API_URL} --ignore .tmp --ignore fixtures --ignore .git .
- """
- }
- }
- }
-}
-```
+!!! example "Example of running agent in pipeline (binary file)"
+    ```groovy
+    pipeline {
+     agent any
+
+     environment {
+     CODESCORING_API_URL='http://localhost:8001'
+     CODESCORING_API_TOKEN='API_TOKEN'
+     }
+
+     stages {
+
+     stage('Run CodeScoring Agent') {
+     steps {
+     sh """
+     johnny scan dir --api_token ${CODESCORING_API_TOKEN} --api_url ${CODESCORING_API_URL} --ignore .tmp --ignore fixtures --ignore .git .
+     """
+     }
+     }
+     }
+    }
+    ```