Commit ffb74b09 authored by Pierre Smeyers's avatar Pierre Smeyers
Browse files

docs: normalise table headers

parent edc3fb49

README.md

+4 −4
Original line number Diff line number Diff line
@@ -21,7 +21,7 @@ This job performs a **lint** analysis on Robot Framework files, using [robotfram 


It is bound to the `test` stage, and uses the following variable:



| Name                  | description                              | default value     |

| Name                  | Description                              | Default value     |

| --------------------- | ---------------------------------------- | ----------------- |

| `ROBOT_LINT_DISABLED` | Set to `true` to disable linter                           | _none_ |
@@ -31,7 +31,7 @@ This job performs [Robot Framework tests](https://robotframework.org/). 


It is bound to the `acceptance` stage, and uses the following variable:



| Name                  | description                                                 | default value |

| Name                  | Description                                                 | Default value |

| --------------------- | ----------------------------------------------------------- | ------------- |

| `ROBOT_BASE_IMAGE`    | The Docker image used to run Robot Framework                | `registry.hub.docker.com/ppodgorsek/robot-framework:latest` |

| `ROBOT_TESTS_DIR`     | Robot Framework's tests directory                           | `robot` |
@@ -144,7 +144,7 @@ This variant allows delegating your secrets management to a [Vault](https://www. 


In order to be able to communicate with the Vault server, the variant requires the additional configuration parameters:



| Name              | description                            | default value     |

| Name              | Description                            | Default value     |

| ----------------- | -------------------------------------- | ----------------- |

| `TBC_VAULT_IMAGE` | The [Vault Secrets Provider](https://gitlab.com/to-be-continuous/tools/vault-secrets-provider) image to use (can be overridden) | `$CI_REGISTRY/to-be-continuous/tools/vault-secrets-provider:master` |

| `VAULT_BASE_URL`  | The Vault server base API url          | _none_ |
@@ -166,7 +166,7 @@ Then you may retrieve any of your secret(s) from Vault using the following synta 


With:



| Name                             | description                            |

| Name                             | Description                            |

| -------------------------------- | -------------------------------------- |

| `secret_path` (_path parameter_) | this is your secret location in the Vault server |

| `field` (_query parameter_)      | parameter to access a single basic field from the secret JSON payload |