fix: change yaml tag to yaml key

go-vela · Aug 14, 2024 · 64cb06d · 64cb06d
1 parent ad687b0
commit 64cb06d
Show file tree

Hide file tree

Showing 29 changed files with 184 additions and 171 deletions.
diff --git a/content/faq/usage/_index.md b/content/faq/usage/_index.md
@@ -159,18 +159,21 @@ This can be accomplished by using the [`docker pull` CLI command](https://docs.d
 
 ![Invalid Secret Path](invalid_secret_path.png)
 
-This behavior indicates [the `key` property](/docs/reference/yaml/secrets/#the-key-tag) provided for a secret in the pipeline is invalid.
+This behavior indicates [the `key` property](/docs/reference/yaml/secrets/#the-key-key) provided for a secret in the pipeline is invalid.
 
 To resolve the issue, explicitly define the secret depending on the type as outlined in the [secret usage docs](/docs/usage/secrets/) with all of the expected fields.
 
 If you are using a secret that only defines `name` as the property and are receiving this error, you will need add the missing properties as this way of referencing a secret was deprecated in an older version of Vela.
 
 For example:
+
 ```yaml
 secrets:
   - name: foo
 ```
-and even 
+
+and even
+
 ```yaml
 secrets:
   - name: foo
@@ -193,12 +196,12 @@ secrets:
 Make sure to replace `<org>` and `<repo>` for the `key` property with the appropriate values from your source code provider.
 
 If you're using GitHub and using the secret for a pipeline at `https://github.com/octocat/hello`, your `org` would be `octocat` and `repo` would be `hello`.
-{{% /alert %}} 
+{{% /alert %}}
 
 ### Repo is not trusted
 
 ![Untrusted Repo](untrusted_repo.png)
 
 This behavior indicates [the `vela_executor_enforce_trusted_repos` flag](/docs/installation/worker/reference/#vela_executor_enforce_trusted_repos) has been set by the Vela platform administrators, which allows only certain repositories to run privileged images.
 
-To resolve the issue, identify the step attempting to run a privileged image and consider a workaround. Otherwise, work with your Vela platform administrators to add your repository to the allowlist. 
+To resolve the issue, identify the step attempting to run a privileged image and consider a workaround. Otherwise, work with your Vela platform administrators to add your repository to the allowlist.
diff --git a/content/reference/api/deployment/add.md b/content/reference/api/deployment/add.md
@@ -77,7 +77,7 @@ curl \
 
 #### File with Parameters
 
-If you would like to pass parameters, which can be referenced in the pipeline as `$DEPLOYMENT_PARAMETER_<KEY>`, include them as a map inside the `payload` tag.
+If you would like to pass parameters, which can be referenced in the pipeline as `$DEPLOYMENT_PARAMETER_<KEY>`, include them as a map inside the `payload` key.
 
 ```json
 {

diff --git a/content/reference/yaml/_index.md b/content/reference/yaml/_index.md
@@ -27,7 +27,7 @@ See YAML [design goals](https://yaml.org/spec/1.2/spec.html#Introduction) from s
 Whether you are a YAML expert or a novice, here is some quick terminology that you should be aware of:
 
 {{% alert title="Tip:" color="info" %}}
-You can get feedback directly on your `.vela.yml` or `.vela.yaml` pipelines in your IDE with the available [JSON Schema](/docs/usage/schema/). 
+You can get feedback directly on your `.vela.yml` or `.vela.yaml` pipelines in your IDE with the available [JSON Schema](/docs/usage/schema/).
 {{% /alert %}}
 
 ### Document
@@ -41,9 +41,9 @@ Example:
 key: value
 ```
 
-### Tags
+### Keys
 
-A YAML document is compose of one to many key-value pairs where the key is called the tag and the value is evaluated to an explicit type (Int, Float, string, bool, etc), see [YAML 1.2 spec for full details](https://yaml.org/spec/1.2/spec.html#id2761292).
+A YAML document is compose of one to many key-value pairs where the value is evaluated to an explicit type (Int, Float, string, bool, etc), see [YAML 1.2 spec for full details](https://yaml.org/spec/1.2/spec.html#id2761292).
 
 Example:
 
@@ -60,4 +60,5 @@ canonical: "Hello, World"
 
 # a bool
 canonical: true
-```
+```
+
diff --git a/content/reference/yaml/environment.md b/content/reference/yaml/environment.md
@@ -3,16 +3,17 @@ title: "Environment"
 linkTitle: "Environment"
 weight: 1
 description: >
-  YAML tags for environment block
+  YAML keys for environment block
 ---
 
-The environment tag is intended to be used to inject a global environment configuration into steps, services and secret containers. Control of which container types get the injected environment settings is available via the metadata block.
+The environment key is intended to be used to inject a global environment configuration into steps, services and secret containers. Control of which container types get the injected environment settings is available via the metadata block.
 
 ```yaml
 ---
-# This document is displaying using the environment tag with a map syntax.
+# This document is displaying using the environment key with a map syntax.
 # Additionally, you can also use array syntax where the items in
 # they array are of pattern HELLO="Hello, Vela!"
 environment:
   HELLO: "Hello, Vela!"
-```
+```
+
diff --git a/content/reference/yaml/metadata.md b/content/reference/yaml/metadata.md
@@ -3,23 +3,23 @@ title: "Metadata"
 linkTitle: "Metadata"
 weight: 2
 description: >
-  YAML tags for metadata block
+  YAML keys for metadata block
 ---
 
-The metadata tag is intended to be used during the compile phase to signal how to treat the YAML document.
+The metadata key is intended to be used during the compile phase to signal how to treat the YAML document.
 
 ```yaml
 ---
-# This document is displaying all the available tags
+# This document is displaying all the available keys
 # in their default state for the compile process.
 metadata:
   template: false
   clone: true
 ```
 
-## Tags
+## Keys
 
-| Tag             | Required | Type        | Description                                                       |
+| Key             | Required | Type        | Description                                                       |
 | --------------- | -------- | ----------- | ----------------------------------------------------------------- |
 | `template`      | Y        | bool        | Enables compiling the pipeline as a template.                     |
 | `clone`         | N        | bool        | Enables injecting the default clone process.                      |
@@ -28,7 +28,7 @@ metadata:
 
 ### Usage
 
-#### The `template:` tag
+#### The `template:` key
 
 {{% alert title="Tip:" color="info" %}}
 To learn how to write templates, see the [template documentation](/docs/templates).
@@ -43,7 +43,7 @@ metadata:
   template: true
 ```
 
-#### The `clone:` tag
+#### The `clone:` key
 
 ```yaml
 ---
@@ -52,7 +52,7 @@ metadata:
   clone: true
 ```
 
-#### The `environment:` tag
+#### The `environment:` key
 
 ```yaml
 ---
@@ -63,7 +63,7 @@ metadata:
   environment: [steps, services, secrets]
 ```
 
-#### The `render_inline:` tag
+#### The `render_inline:` key
 
 ```yaml
 ---
@@ -75,9 +75,9 @@ metadata:
   render_inline: false
 ```
 
-#### The `auto_cancel` tag
+#### The `auto_cancel` key
 
-| Tag              | Default | Type | Description                                                                                 |
+| Key              | Default | Type | Description                                                                                 |
 | ---------------- | ------- | ---- | ------------------------------------------------------------------------------------------- |
 | `pending`        | True    | bool | Pending builds will be auto canceled if qualifying build is triggered                       |
 | `running`        | False   | bool | Currently running builds will be auto canceled if qualifying build is triggered             |

diff --git a/content/reference/yaml/secrets.md b/content/reference/yaml/secrets.md
@@ -3,14 +3,14 @@ title: "Secrets"
 linkTitle: "Secrets"
 weight: 8
 description: >
-  YAML tags for secret block
+  YAML keys for secret block
 ---
 
-The secret tag is intended to be used to pull secrets from the Vela server or execute plugins to write the external secrets to the build volume.
+The secret key is intended to be used to pull secrets from the Vela server or execute plugins to write the external secrets to the build volume.
 
 ```yaml
 ---
-# This document is displaying all the required tags
+# This document is displaying all the required keys
 # to pull various secret types.
 secrets:
   # Below is displaying the declarative secret definitions.
@@ -46,9 +46,9 @@ secrets:
            path: user
 ```
 
-## Tags
+## Keys
 
-| Tag      | Required | Type   | Description                                                     |
+| Key      | Required | Type   | Description                                                     |
 | -------- | -------- | ------ | --------------------------------------------------------------- |
 | `name`   | Y        | string | Name of secret to reference in the pipeline.                    |
 | `key`    | N        | string | Path to secret to fetch from storage backend.                   |
@@ -57,7 +57,7 @@ secrets:
 | `pull`   | N        | string | When to pull in secrets from storage backend.                   |
 | `origin` | N        | struct | Declaration to pull secrets from non-internal secret providers. |
 
-#### The `name:` tag
+#### The `name:` key
 
 ```yaml
 ---
@@ -66,7 +66,7 @@ secrets:
   - name: postgres
 ```
 
-#### The `key:` tag
+#### The `key:` key
 
 {{% alert title="Tip:" color="info" %}}
 The key is unique
@@ -94,7 +94,7 @@ secrets:
   - key: go-vela/admins/foo1
 ```
 
-#### The `engine:` tag
+#### The `engine:` key
 
 {{% alert title="Tip:" color="info" %}}
 To know what engines are available for your Vela installation, we recommend consulting your system administrators.
@@ -108,7 +108,7 @@ secrets:
   - engine: native
 ```
 
-#### The `type:` tag
+#### The `type:` key
 
 ```yaml
 ---
@@ -119,7 +119,7 @@ secrets:
   - type: repo
 ```
 
-#### The `pull:` tag
+#### The `pull:` key
 
 ```yaml
 ---
@@ -132,12 +132,12 @@ secrets:
 
 {{% alert title="Important:" color="warning" %}} `step_start` or lazy loading secrets
 is not currently available for the [Kubernetes-based workers](/docs/installation/worker/kubernetes/) and does not work with secrets
-originating from plugins loaded via [`origin:` tag](/docs/reference/yaml/secrets/#the-pull-tag) (see below).
+originating from plugins loaded via [`origin:`](/docs/reference/yaml/secrets/#the-pull-key) (see below).
 {{% /alert %}}
 
-#### The `origin:` tag
+#### The `origin:` key
 
-| Tag           | Required | Type     | Description                                                      |
+| Key           | Required | Type     | Description                                                      |
 | ------------- | -------- | -------- | ---------------------------------------------------------------- |
 | `name`        | Y        | string   | Unique identifier for the container in the pipeline.             |
 | `image`       | Y        | []string | Docker image used to create an ephemeral container.              |
@@ -149,11 +149,11 @@ originating from plugins loaded via [`origin:` tag](/docs/reference/yaml/secrets
 
 {{% alert title="Note:" color="info" %}} The `pull:` option under `origin:`
 allows for different values than the
-[Secrets `pull:` tag](/docs/reference/yaml/secrets/#the-pull-tag). It mimics the
-[Steps version of the `pull:` tag](/docs/reference/yaml/steps/#the-pull-tag).
+[Secrets `pull:` key](/docs/reference/yaml/secrets/#the-pull-key). It mimics the
+[Steps version of the `pull:` key](/docs/reference/yaml/steps/#the-pull-key).
 {{% /alert %}}
 
 {{% alert title="Tip:" color="success" %}} In an effort to reduce duplicate
 documentation, see the comparable
-[step tags documentation](/docs/reference/yaml/steps/#tags) to learn how tags
+[step keys documentation](/docs/reference/yaml/steps/#keys) to learn how keys
 can be set and details on behavior. {{% /alert %}}
diff --git a/content/reference/yaml/services.md b/content/reference/yaml/services.md
@@ -3,23 +3,23 @@ title: "Services"
 linkTitle: "Services"
 weight: 5
 description: >
-  YAML tags for services block
+  YAML keys for services block
 ---
 
-The `services` tag is intended to be used to run applications alongside the pipeline.
+The `services` key is intended to be used to run applications alongside the pipeline.
 
 ```yaml
 ---
-# This document is displaying all the required tags
+# This document is displaying all the required keys
 # to run a postgres database for the duration of a pipeline.
 services: 
   - name: postgres
     image: postgres:latest
 ```
 
-## Tags
+## Keys
 
-| Tag           | Required | Type            | Description                                                     |
+| Key           | Required | Type            | Description                                                     |
 |---------------|----------|-----------------|-----------------------------------------------------------------|
 | `name`        | Y        | string          | Unique identifier for the container in the pipeline             |
 | `image`       | Y        | string          | Docker image used to create an ephemeral container              |
@@ -32,7 +32,7 @@ services:
 
 ### Usage
 
-#### The `name:` tag
+#### The `name:` key
 
 ```yaml
 ---
@@ -41,7 +41,7 @@ services:
   - name: postgres
 ```
 
-#### The `image:` tag
+#### The `image:` key
 
 ```yaml
 ---
@@ -50,7 +50,7 @@ services:
   - image: postgres:latest
 ```
 
-#### The `pull:` tag
+#### The `pull:` key
 
 ```yaml
 ---
@@ -61,7 +61,7 @@ services:
   - pull: always
 ```
 
-#### The `environment:` tag
+#### The `environment:` key
 
 ```yaml
 ---
@@ -81,7 +81,7 @@ services:
       - DB_NAME=vela
 ```
 
-#### The `entrypoint:` tag
+#### The `entrypoint:` key
 
 ```yaml
 ---
@@ -92,7 +92,7 @@ services:
       - /some/binary/postgres
 ```
 
-#### The `ports:` tag
+#### The `ports:` key
 
 ```yaml
 ---
@@ -102,7 +102,7 @@ services:
       - "8080:5432"
 ```
 
-#### The `ulimits:` tag
+#### The `ulimits:` key
 
 ```yaml
 ---
@@ -116,7 +116,7 @@ services:
         hard: 2048
 ```
 
-#### The `user:` tag
+#### The `user:` key
 
 ```yaml
 ---