diff --git a/docs/installation/server/docker.md b/docs/installation/server/docker.md index 542d426..10cc7f3 100644 --- a/docs/installation/server/docker.md +++ b/docs/installation/server/docker.md @@ -16,7 +16,7 @@ You can refer to [Docker's official documentation](https://docs.docker.com/get-d ### Dependency 2: Redis -[Redis](https://redis.io/) will be used for storing workloads, created by the server, that will run on a [worker](/docs/installation/worker/). +[Redis](https://redis.io/) will be used for storing workloads, created by the server, that will run on a [worker](/docs/installation/worker/worker.md). You can refer to [Redis's official documentation](https://redis.io/topics/quickstart/) on installing and configuring the service. @@ -104,7 +104,7 @@ These credentials are used to authenticate and authorize actions preformed withi Vela has support for many Source Control Management (SCM) providers to enable the preferences of you and your team. -You can follow the [SCM reference](/docs/installation/server/reference/scm/) for instructions on creating the OAuth application. +You can follow the [SCM reference](/docs/reference/installation/server/scm.md) for instructions on creating the OAuth application. ### Step 7: Start the Server @@ -137,7 +137,7 @@ If using the [server-worker trusted symmetric auth method](/docs/installation/wo ```shell --env=VELA_SECRET= ``` -For a full list of configuration options, please see the [server reference](/docs/installation/server/reference/). +For a full list of configuration options, please see the [server reference](/docs/reference/installation/server/server.md). ::: ### Step 8: Verify the Server Logs @@ -154,4 +154,4 @@ $ docker logs server After the server is up and running, you need to install workers to run workloads. -Please refer to [the worker installation docs](/docs/installation/worker/) for more information. \ No newline at end of file +Please refer to [the worker installation docs](/docs/installation/worker/worker.md) for more information. \ No newline at end of file diff --git a/docs/installation/ui/docker.md b/docs/installation/ui/docker.md index 34ede85..fd31a66 100644 --- a/docs/installation/ui/docker.md +++ b/docs/installation/ui/docker.md @@ -54,7 +54,7 @@ $ docker run \ ``` :::info -For a full list of configuration options, please see the [UI reference](/docs/installation/ui/reference/). +For a full list of configuration options, please see the [UI reference](None). ::: ### Step 3: Verify the UI Logs diff --git a/docs/installation/ui/ui.md b/docs/installation/ui/ui.md index 13e9413..e20eaf3 100644 --- a/docs/installation/ui/ui.md +++ b/docs/installation/ui/ui.md @@ -23,7 +23,7 @@ From the [Docker official website](https://docker.io/): > Docker takes away repetitive, mundane configuration tasks and is used throughout the development lifecycle for fast, easy and portable application development - desktop and cloud. Docker’s comprehensive end to end platform includes UIs, CLIs, APIs and security that are engineered to work together across the entire application delivery lifecycle. -Please refer to [our Docker deployment guide](/docs/installation/ui/docker/) to get started. +Please refer to [our Docker deployment guide](/docs/installation/ui/docker.md) to get started. ### Kubernetes @@ -31,4 +31,4 @@ From the [Kubernetes official website](https://kubernetes.io/): > Kubernetes, also known as K8s, is an open-source system for automating deployment, scaling, and management of containerized applications. -Please refer to [our Kubernetes deployment guide](/docs/installation/ui/kubernetes/) to get started. \ No newline at end of file +Please refer to [our Kubernetes deployment guide](/docs/installation/ui/kubernetes.md) to get started. \ No newline at end of file diff --git a/docs/installation/worker/kubernetes.md b/docs/installation/worker/kubernetes.md index df4cee7..c3315c9 100644 --- a/docs/installation/worker/kubernetes.md +++ b/docs/installation/worker/kubernetes.md @@ -81,7 +81,7 @@ $ kubectl apply -f worker-configmap.yaml ``` :::info -For a full list of configuration options, please see the [worker reference](/docs/installation/worker/reference/). +For a full list of configuration options, please see the [worker reference](/docs/reference/installation/worker/worker.md). ::: diff --git a/docs/reference/api/admin/admin.md b/docs/reference/api/admin/admin.md index 189447f..d218f74 100644 --- a/docs/reference/api/admin/admin.md +++ b/docs/reference/api/admin/admin.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on as an admin of the platform. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: diff --git a/docs/reference/api/admin/build.md b/docs/reference/api/admin/build.md index 4bedb9f..cfdedaa 100644 --- a/docs/reference/api/admin/build.md +++ b/docs/reference/api/admin/build.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: Note: You must provide the entire build object, as this endpoint overwrites the diff --git a/docs/reference/api/admin/build_queue.md b/docs/reference/api/admin/build_queue.md index 50fbf8b..b336b34 100644 --- a/docs/reference/api/admin/build_queue.md +++ b/docs/reference/api/admin/build_queue.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/admin/clean.md b/docs/reference/api/admin/clean.md index df98178..075d35f 100644 --- a/docs/reference/api/admin/clean.md +++ b/docs/reference/api/admin/clean.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/admin/hook.md b/docs/reference/api/admin/hook.md index 880f9a7..59bd26e 100644 --- a/docs/reference/api/admin/hook.md +++ b/docs/reference/api/admin/hook.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: Note: You must provide the entire hook object, as this endpoint overwrites the diff --git a/docs/reference/api/admin/repo.md b/docs/reference/api/admin/repo.md index 206308e..8f0b7c4 100644 --- a/docs/reference/api/admin/repo.md +++ b/docs/reference/api/admin/repo.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: Note: You must provide the entire repo object, as this endpoint overwrites the diff --git a/docs/reference/api/admin/secret.md b/docs/reference/api/admin/secret.md index 9797fd7..4fcb182 100644 --- a/docs/reference/api/admin/secret.md +++ b/docs/reference/api/admin/secret.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: Note: You must provide the entire secret object, as this endpoint overwrites the diff --git a/docs/reference/api/admin/service.md b/docs/reference/api/admin/service.md index 423ed9d..b64b8cf 100644 --- a/docs/reference/api/admin/service.md +++ b/docs/reference/api/admin/service.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: Note: You must provide the entire service object, as this endpoint overwrites the diff --git a/docs/reference/api/admin/settings/restore.md b/docs/reference/api/admin/settings/restore.md index 2ff5419..8dc3033 100644 --- a/docs/reference/api/admin/settings/restore.md +++ b/docs/reference/api/admin/settings/restore.md @@ -29,7 +29,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/admin/settings/settings.md b/docs/reference/api/admin/settings/settings.md index ed4f908..037bdae 100644 --- a/docs/reference/api/admin/settings/settings.md +++ b/docs/reference/api/admin/settings/settings.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on the `settings` resource. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: diff --git a/docs/reference/api/admin/settings/update.md b/docs/reference/api/admin/settings/update.md index 68c0852..903106a 100644 --- a/docs/reference/api/admin/settings/update.md +++ b/docs/reference/api/admin/settings/update.md @@ -29,7 +29,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/admin/settings/view.md b/docs/reference/api/admin/settings/view.md index 94771e5..6406fda 100644 --- a/docs/reference/api/admin/settings/view.md +++ b/docs/reference/api/admin/settings/view.md @@ -28,7 +28,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/admin/step.md b/docs/reference/api/admin/step.md index fc01247..532d532 100644 --- a/docs/reference/api/admin/step.md +++ b/docs/reference/api/admin/step.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: Note: You must provide the entire step object, as this endpoint overwrites the diff --git a/docs/reference/api/admin/user.md b/docs/reference/api/admin/user.md index 8616263..4e177d9 100644 --- a/docs/reference/api/admin/user.md +++ b/docs/reference/api/admin/user.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: Note: You must provide the entire service object, as this endpoint overwrites the diff --git a/docs/reference/api/admin/worker.md b/docs/reference/api/admin/worker.md index cb1e03f..912ef96 100644 --- a/docs/reference/api/admin/worker.md +++ b/docs/reference/api/admin/worker.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/build/add.md b/docs/reference/api/build/add.md index b79744e..2ecc073 100644 --- a/docs/reference/api/build/add.md +++ b/docs/reference/api/build/add.md @@ -36,7 +36,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/build/build.md b/docs/reference/api/build/build.md index 960462b..3ed5cf3 100644 --- a/docs/reference/api/build/build.md +++ b/docs/reference/api/build/build.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on the `build` resource. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: diff --git a/docs/reference/api/build/cancel.md b/docs/reference/api/build/cancel.md index bed7713..c2741a5 100644 --- a/docs/reference/api/build/cancel.md +++ b/docs/reference/api/build/cancel.md @@ -29,7 +29,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/build/get.md b/docs/reference/api/build/get.md index 9a0a8ed..736a348 100644 --- a/docs/reference/api/build/get.md +++ b/docs/reference/api/build/get.md @@ -51,7 +51,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/build/logs.md b/docs/reference/api/build/logs.md index fbd6a9d..51d6cd0 100644 --- a/docs/reference/api/build/logs.md +++ b/docs/reference/api/build/logs.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/build/remove.md b/docs/reference/api/build/remove.md index 46edf54..2abca56 100644 --- a/docs/reference/api/build/remove.md +++ b/docs/reference/api/build/remove.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/build/restart.md b/docs/reference/api/build/restart.md index c32753b..0c7c7ba 100644 --- a/docs/reference/api/build/restart.md +++ b/docs/reference/api/build/restart.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/build/update.md b/docs/reference/api/build/update.md index 41b1cbe..5acebf5 100644 --- a/docs/reference/api/build/update.md +++ b/docs/reference/api/build/update.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/build/view.md b/docs/reference/api/build/view.md index 69e57f4..5e47e19 100644 --- a/docs/reference/api/build/view.md +++ b/docs/reference/api/build/view.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request @@ -111,7 +111,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/dashboard/add.md b/docs/reference/api/dashboard/add.md index f43ca92..a3285ef 100644 --- a/docs/reference/api/dashboard/add.md +++ b/docs/reference/api/dashboard/add.md @@ -29,7 +29,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/dashboard/dashboard.md b/docs/reference/api/dashboard/dashboard.md index 5a845ed..e4b3020 100644 --- a/docs/reference/api/dashboard/dashboard.md +++ b/docs/reference/api/dashboard/dashboard.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on the `dashboard` resource. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: \ No newline at end of file diff --git a/docs/reference/api/dashboard/delete.md b/docs/reference/api/dashboard/delete.md index b387731..6b1b6b2 100644 --- a/docs/reference/api/dashboard/delete.md +++ b/docs/reference/api/dashboard/delete.md @@ -29,7 +29,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/dashboard/get.md b/docs/reference/api/dashboard/get.md index c6527a9..10a6ec0 100644 --- a/docs/reference/api/dashboard/get.md +++ b/docs/reference/api/dashboard/get.md @@ -30,7 +30,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/dashboard/list.md b/docs/reference/api/dashboard/list.md index 21a0642..1e7c81a 100644 --- a/docs/reference/api/dashboard/list.md +++ b/docs/reference/api/dashboard/list.md @@ -30,7 +30,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/dashboard/update.md b/docs/reference/api/dashboard/update.md index 7891f6c..55e7524 100644 --- a/docs/reference/api/dashboard/update.md +++ b/docs/reference/api/dashboard/update.md @@ -29,7 +29,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/deployment/add.md b/docs/reference/api/deployment/add.md index c67404d..9179979 100644 --- a/docs/reference/api/deployment/add.md +++ b/docs/reference/api/deployment/add.md @@ -36,7 +36,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/deployment/deployment.md b/docs/reference/api/deployment/deployment.md index bd126a7..190298e 100644 --- a/docs/reference/api/deployment/deployment.md +++ b/docs/reference/api/deployment/deployment.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on the `deployment` resource. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: diff --git a/docs/reference/api/deployment/get.md b/docs/reference/api/deployment/get.md index c38794b..c41a37c 100644 --- a/docs/reference/api/deployment/get.md +++ b/docs/reference/api/deployment/get.md @@ -36,7 +36,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/deployment/view.md b/docs/reference/api/deployment/view.md index 0a8bc7b..a995bad 100644 --- a/docs/reference/api/deployment/view.md +++ b/docs/reference/api/deployment/view.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/hook/add.md b/docs/reference/api/hook/add.md index 33d3c90..820adfc 100644 --- a/docs/reference/api/hook/add.md +++ b/docs/reference/api/hook/add.md @@ -36,7 +36,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/hook/get.md b/docs/reference/api/hook/get.md index 17ad1b6..e1f3e0f 100644 --- a/docs/reference/api/hook/get.md +++ b/docs/reference/api/hook/get.md @@ -36,7 +36,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/hook/hook.md b/docs/reference/api/hook/hook.md index abd81c6..f6510b5 100644 --- a/docs/reference/api/hook/hook.md +++ b/docs/reference/api/hook/hook.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on the `hook` resource. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: diff --git a/docs/reference/api/hook/remove.md b/docs/reference/api/hook/remove.md index e394c46..6cafda3 100644 --- a/docs/reference/api/hook/remove.md +++ b/docs/reference/api/hook/remove.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/hook/update.md b/docs/reference/api/hook/update.md index e3b0cf8..7870402 100644 --- a/docs/reference/api/hook/update.md +++ b/docs/reference/api/hook/update.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/hook/view.md b/docs/reference/api/hook/view.md index 5bd6bbf..9bb043b 100644 --- a/docs/reference/api/hook/view.md +++ b/docs/reference/api/hook/view.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/pipeline/add.md b/docs/reference/api/pipeline/add.md index 0950be2..435ebc7 100644 --- a/docs/reference/api/pipeline/add.md +++ b/docs/reference/api/pipeline/add.md @@ -36,7 +36,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/pipeline/compile.md b/docs/reference/api/pipeline/compile.md index 6fa249e..051ef16 100644 --- a/docs/reference/api/pipeline/compile.md +++ b/docs/reference/api/pipeline/compile.md @@ -41,7 +41,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/pipeline/expand.md b/docs/reference/api/pipeline/expand.md index d571a9f..eb4b319 100644 --- a/docs/reference/api/pipeline/expand.md +++ b/docs/reference/api/pipeline/expand.md @@ -41,7 +41,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/pipeline/get.md b/docs/reference/api/pipeline/get.md index a5cbcfa..dd13106 100644 --- a/docs/reference/api/pipeline/get.md +++ b/docs/reference/api/pipeline/get.md @@ -39,7 +39,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/pipeline/pipeline.md b/docs/reference/api/pipeline/pipeline.md index 4395b59..3792ce2 100644 --- a/docs/reference/api/pipeline/pipeline.md +++ b/docs/reference/api/pipeline/pipeline.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on the `pipeline` resource. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: diff --git a/docs/reference/api/pipeline/remove.md b/docs/reference/api/pipeline/remove.md index 3ebb327..c845882 100644 --- a/docs/reference/api/pipeline/remove.md +++ b/docs/reference/api/pipeline/remove.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/pipeline/templates.md b/docs/reference/api/pipeline/templates.md index 2a913ef..6155fa5 100644 --- a/docs/reference/api/pipeline/templates.md +++ b/docs/reference/api/pipeline/templates.md @@ -41,7 +41,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/pipeline/update.md b/docs/reference/api/pipeline/update.md index 94a4ad2..ce7f17e 100644 --- a/docs/reference/api/pipeline/update.md +++ b/docs/reference/api/pipeline/update.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/pipeline/validate.md b/docs/reference/api/pipeline/validate.md index bf5ed7f..62ac452 100644 --- a/docs/reference/api/pipeline/validate.md +++ b/docs/reference/api/pipeline/validate.md @@ -41,7 +41,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/pipeline/view.md b/docs/reference/api/pipeline/view.md index db462af..d2b45ee 100644 --- a/docs/reference/api/pipeline/view.md +++ b/docs/reference/api/pipeline/view.md @@ -39,7 +39,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/repo/add.md b/docs/reference/api/repo/add.md index 08586e0..7fe31c4 100644 --- a/docs/reference/api/repo/add.md +++ b/docs/reference/api/repo/add.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/repo/chown.md b/docs/reference/api/repo/chown.md index da873f3..1db7027 100644 --- a/docs/reference/api/repo/chown.md +++ b/docs/reference/api/repo/chown.md @@ -36,7 +36,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/repo/get.md b/docs/reference/api/repo/get.md index 8084b55..ccf26ea 100644 --- a/docs/reference/api/repo/get.md +++ b/docs/reference/api/repo/get.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request @@ -195,7 +195,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/repo/remove.md b/docs/reference/api/repo/remove.md index 52499c7..7edde37 100644 --- a/docs/reference/api/repo/remove.md +++ b/docs/reference/api/repo/remove.md @@ -36,7 +36,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/repo/repair.md b/docs/reference/api/repo/repair.md index 7f4c59b..19fb2d9 100644 --- a/docs/reference/api/repo/repair.md +++ b/docs/reference/api/repo/repair.md @@ -36,7 +36,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/repo/repo.md b/docs/reference/api/repo/repo.md index e53a2aa..9da0af0 100644 --- a/docs/reference/api/repo/repo.md +++ b/docs/reference/api/repo/repo.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on the `repo` resource. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: diff --git a/docs/reference/api/repo/update.md b/docs/reference/api/repo/update.md index 7f1a618..6b1a320 100644 --- a/docs/reference/api/repo/update.md +++ b/docs/reference/api/repo/update.md @@ -36,7 +36,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/repo/view.md b/docs/reference/api/repo/view.md index b34855d..38e7330 100644 --- a/docs/reference/api/repo/view.md +++ b/docs/reference/api/repo/view.md @@ -36,7 +36,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/schedule/add.md b/docs/reference/api/schedule/add.md index a3f3f72..8d0ef60 100644 --- a/docs/reference/api/schedule/add.md +++ b/docs/reference/api/schedule/add.md @@ -36,7 +36,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/schedule/get.md b/docs/reference/api/schedule/get.md index 57e71fc..836112a 100644 --- a/docs/reference/api/schedule/get.md +++ b/docs/reference/api/schedule/get.md @@ -39,7 +39,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/schedule/remove.md b/docs/reference/api/schedule/remove.md index 3524b5a..19c7f53 100644 --- a/docs/reference/api/schedule/remove.md +++ b/docs/reference/api/schedule/remove.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/schedule/schedule.md b/docs/reference/api/schedule/schedule.md index 4a1e7cf..4e7ddb7 100644 --- a/docs/reference/api/schedule/schedule.md +++ b/docs/reference/api/schedule/schedule.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on the `schedule` resource. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: \ No newline at end of file diff --git a/docs/reference/api/schedule/update.md b/docs/reference/api/schedule/update.md index d14930c..d59137d 100644 --- a/docs/reference/api/schedule/update.md +++ b/docs/reference/api/schedule/update.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/schedule/view.md b/docs/reference/api/schedule/view.md index 3ff1562..ac6eb3d 100644 --- a/docs/reference/api/schedule/view.md +++ b/docs/reference/api/schedule/view.md @@ -39,7 +39,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/scm/scm.md b/docs/reference/api/scm/scm.md index ade0776..c1d010b 100644 --- a/docs/reference/api/scm/scm.md +++ b/docs/reference/api/scm/scm.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on the `scm` resource. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: \ No newline at end of file diff --git a/docs/reference/api/scm/sync.md b/docs/reference/api/scm/sync.md index ab86f23..b13b37d 100644 --- a/docs/reference/api/scm/sync.md +++ b/docs/reference/api/scm/sync.md @@ -44,7 +44,7 @@ hitting the sync endpoint should re-configure the SCM webhook to only send event :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/scm/syncAll.md b/docs/reference/api/scm/syncAll.md index 6c8be4b..6a460fc 100644 --- a/docs/reference/api/scm/syncAll.md +++ b/docs/reference/api/scm/syncAll.md @@ -43,7 +43,7 @@ hitting the sync-all endpoint should re-configure the SCM webhook for all repos :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/secret/add.md b/docs/reference/api/secret/add.md index 8601f77..5351c87 100644 --- a/docs/reference/api/secret/add.md +++ b/docs/reference/api/secret/add.md @@ -38,7 +38,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/secret/get.md b/docs/reference/api/secret/get.md index 7042e90..4a7ac74 100644 --- a/docs/reference/api/secret/get.md +++ b/docs/reference/api/secret/get.md @@ -38,7 +38,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/secret/remove.md b/docs/reference/api/secret/remove.md index e28a56c..dea7e2c 100644 --- a/docs/reference/api/secret/remove.md +++ b/docs/reference/api/secret/remove.md @@ -39,7 +39,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/secret/secret.md b/docs/reference/api/secret/secret.md index f108bbd..1cf5c4e 100644 --- a/docs/reference/api/secret/secret.md +++ b/docs/reference/api/secret/secret.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on the `secret` resource. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: diff --git a/docs/reference/api/secret/update.md b/docs/reference/api/secret/update.md index 3618b4a..d1ecd6a 100644 --- a/docs/reference/api/secret/update.md +++ b/docs/reference/api/secret/update.md @@ -39,7 +39,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/secret/view.md b/docs/reference/api/secret/view.md index bf2e4d6..112bec5 100644 --- a/docs/reference/api/secret/view.md +++ b/docs/reference/api/secret/view.md @@ -39,7 +39,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/service/add.md b/docs/reference/api/service/add.md index b5fec5e..c9ad084 100644 --- a/docs/reference/api/service/add.md +++ b/docs/reference/api/service/add.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/service/get.md b/docs/reference/api/service/get.md index 52585bd..78d0150 100644 --- a/docs/reference/api/service/get.md +++ b/docs/reference/api/service/get.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/service/logs.md b/docs/reference/api/service/logs.md index 6d0931e..2bdc66d 100644 --- a/docs/reference/api/service/logs.md +++ b/docs/reference/api/service/logs.md @@ -38,7 +38,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/service/remove.md b/docs/reference/api/service/remove.md index 495ca47..7b186ed 100644 --- a/docs/reference/api/service/remove.md +++ b/docs/reference/api/service/remove.md @@ -38,7 +38,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/service/service.md b/docs/reference/api/service/service.md index d6f24bc..78cabcf 100644 --- a/docs/reference/api/service/service.md +++ b/docs/reference/api/service/service.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on the `service` resource. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: diff --git a/docs/reference/api/service/update.md b/docs/reference/api/service/update.md index dfc798d..c50fc15 100644 --- a/docs/reference/api/service/update.md +++ b/docs/reference/api/service/update.md @@ -38,7 +38,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/service/view.md b/docs/reference/api/service/view.md index 835aad6..7a10562 100644 --- a/docs/reference/api/service/view.md +++ b/docs/reference/api/service/view.md @@ -38,7 +38,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/step/add.md b/docs/reference/api/step/add.md index 82db72c..10c7d11 100644 --- a/docs/reference/api/step/add.md +++ b/docs/reference/api/step/add.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/step/get.md b/docs/reference/api/step/get.md index 73d096a..619c376 100644 --- a/docs/reference/api/step/get.md +++ b/docs/reference/api/step/get.md @@ -37,7 +37,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/step/logs.md b/docs/reference/api/step/logs.md index 0245c0b..38f0d31 100644 --- a/docs/reference/api/step/logs.md +++ b/docs/reference/api/step/logs.md @@ -38,7 +38,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/step/remove.md b/docs/reference/api/step/remove.md index 8b8d83b..807cc67 100644 --- a/docs/reference/api/step/remove.md +++ b/docs/reference/api/step/remove.md @@ -38,7 +38,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/step/step.md b/docs/reference/api/step/step.md index 1f73da7..a4db5da 100644 --- a/docs/reference/api/step/step.md +++ b/docs/reference/api/step/step.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on the `step` resource. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: diff --git a/docs/reference/api/step/update.md b/docs/reference/api/step/update.md index e6aab7c..8d01732 100644 --- a/docs/reference/api/step/update.md +++ b/docs/reference/api/step/update.md @@ -38,7 +38,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/step/view.md b/docs/reference/api/step/view.md index d746ab1..68f806d 100644 --- a/docs/reference/api/step/view.md +++ b/docs/reference/api/step/view.md @@ -38,7 +38,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/user/add.md b/docs/reference/api/user/add.md index 04bac56..9f7c883 100644 --- a/docs/reference/api/user/add.md +++ b/docs/reference/api/user/add.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/user/current/current.md b/docs/reference/api/user/current/current.md index 121f12a..30ae559 100644 --- a/docs/reference/api/user/current/current.md +++ b/docs/reference/api/user/current/current.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on for the current user. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: diff --git a/docs/reference/api/user/current/repos.md b/docs/reference/api/user/current/repos.md index cd4afdd..fd2ebb3 100644 --- a/docs/reference/api/user/current/repos.md +++ b/docs/reference/api/user/current/repos.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/user/current/update.md b/docs/reference/api/user/current/update.md index 6f3f299..d293d4e 100644 --- a/docs/reference/api/user/current/update.md +++ b/docs/reference/api/user/current/update.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/user/current/view.md b/docs/reference/api/user/current/view.md index 02f4cdb..de2229f 100644 --- a/docs/reference/api/user/current/view.md +++ b/docs/reference/api/user/current/view.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/user/get.md b/docs/reference/api/user/get.md index 4142a22..27739dd 100644 --- a/docs/reference/api/user/get.md +++ b/docs/reference/api/user/get.md @@ -27,7 +27,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/user/remove.md b/docs/reference/api/user/remove.md index e45b232..419e335 100644 --- a/docs/reference/api/user/remove.md +++ b/docs/reference/api/user/remove.md @@ -35,7 +35,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/api/user/update.md b/docs/reference/api/user/update.md index 6b52015..e8212a5 100644 --- a/docs/reference/api/user/update.md +++ b/docs/reference/api/user/update.md @@ -35,7 +35,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### File diff --git a/docs/reference/api/user/user.md b/docs/reference/api/user/user.md index d5ab4f4..a87fd64 100644 --- a/docs/reference/api/user/user.md +++ b/docs/reference/api/user/user.md @@ -10,5 +10,5 @@ The below endpoints are available to operate on the `user` resource. :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: diff --git a/docs/reference/api/user/view.md b/docs/reference/api/user/view.md index 5f7241a..74b6726 100644 --- a/docs/reference/api/user/view.md +++ b/docs/reference/api/user/view.md @@ -35,7 +35,7 @@ COMING SOON! :::warning This section assumes you already know how to authenticate to the API. -To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication/). +To authenticate to the API, please review the [authentication documentation](/docs/reference/api/authentication.md). ::: #### Request diff --git a/docs/reference/cli/authentication.md b/docs/reference/cli/authentication.md index 7a12f1e..7afdb32 100644 --- a/docs/reference/cli/authentication.md +++ b/docs/reference/cli/authentication.md @@ -46,7 +46,7 @@ Authentication complete. Continue to save configuration (existing config will be ``` :::tip -For more information, you can visit the [CLI config documentation](/docs/reference/cli/config/). +For more information, you can visit the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ### Environment Variables diff --git a/docs/reference/cli/build/approve.md b/docs/reference/cli/build/approve.md index 627396a..5e0e9f4 100644 --- a/docs/reference/cli/build/approve.md +++ b/docs/reference/cli/build/approve.md @@ -33,7 +33,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -47,7 +47,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/build/build.md b/docs/reference/cli/build/build.md index b0a43ba..5fb8a84 100644 --- a/docs/reference/cli/build/build.md +++ b/docs/reference/cli/build/build.md @@ -9,5 +9,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: diff --git a/docs/reference/cli/build/cancel.md b/docs/reference/cli/build/cancel.md index cf8b7a8..d03eb60 100644 --- a/docs/reference/cli/build/cancel.md +++ b/docs/reference/cli/build/cancel.md @@ -33,7 +33,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -47,7 +47,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/build/get.md b/docs/reference/cli/build/get.md index 5bd8a5d..897a5ca 100644 --- a/docs/reference/cli/build/get.md +++ b/docs/reference/cli/build/get.md @@ -37,7 +37,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -51,7 +51,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/build/restart.md b/docs/reference/cli/build/restart.md index 348665f..7aa08e0 100644 --- a/docs/reference/cli/build/restart.md +++ b/docs/reference/cli/build/restart.md @@ -33,7 +33,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -47,7 +47,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/build/view.md b/docs/reference/cli/build/view.md index d805e42..a0cb2b6 100644 --- a/docs/reference/cli/build/view.md +++ b/docs/reference/cli/build/view.md @@ -33,7 +33,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -47,7 +47,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/completion/completion.md b/docs/reference/cli/completion/completion.md index 3be1149..291be1a 100644 --- a/docs/reference/cli/completion/completion.md +++ b/docs/reference/cli/completion/completion.md @@ -12,5 +12,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: diff --git a/docs/reference/cli/completion/generate.md b/docs/reference/cli/completion/generate.md index 49c4a5b..7924c9d 100644 --- a/docs/reference/cli/completion/generate.md +++ b/docs/reference/cli/completion/generate.md @@ -35,7 +35,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/config/config.md b/docs/reference/cli/config/config.md index 5787b69..7fa3939 100644 --- a/docs/reference/cli/config/config.md +++ b/docs/reference/cli/config/config.md @@ -12,5 +12,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: diff --git a/docs/reference/cli/config/generate.md b/docs/reference/cli/config/generate.md index 5bdf979..5c8ad9c 100644 --- a/docs/reference/cli/config/generate.md +++ b/docs/reference/cli/config/generate.md @@ -45,7 +45,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/config/remove.md b/docs/reference/cli/config/remove.md index 12dbf03..bfbe02a 100644 --- a/docs/reference/cli/config/remove.md +++ b/docs/reference/cli/config/remove.md @@ -48,7 +48,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/config/update.md b/docs/reference/cli/config/update.md index bdd6895..c491140 100644 --- a/docs/reference/cli/config/update.md +++ b/docs/reference/cli/config/update.md @@ -44,7 +44,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/config/view.md b/docs/reference/cli/config/view.md index 4a666c1..a1a75e5 100644 --- a/docs/reference/cli/config/view.md +++ b/docs/reference/cli/config/view.md @@ -26,7 +26,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/dashboard/add.md b/docs/reference/cli/dashboard/add.md index 802fc8c..872a9c0 100644 --- a/docs/reference/cli/dashboard/add.md +++ b/docs/reference/cli/dashboard/add.md @@ -33,7 +33,7 @@ This command also supports setting the following parameters via a configuration - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Sample @@ -43,7 +43,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/dashboard/dashboard.md b/docs/reference/cli/dashboard/dashboard.md index cf46593..8448a04 100644 --- a/docs/reference/cli/dashboard/dashboard.md +++ b/docs/reference/cli/dashboard/dashboard.md @@ -12,5 +12,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: diff --git a/docs/reference/cli/dashboard/get.md b/docs/reference/cli/dashboard/get.md index 17e324d..1931d1e 100644 --- a/docs/reference/cli/dashboard/get.md +++ b/docs/reference/cli/dashboard/get.md @@ -29,7 +29,7 @@ This command also supports setting the following parameters via a configuration - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Sample @@ -39,7 +39,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/dashboard/update.md b/docs/reference/cli/dashboard/update.md index b1bd625..d0f0826 100644 --- a/docs/reference/cli/dashboard/update.md +++ b/docs/reference/cli/dashboard/update.md @@ -37,7 +37,7 @@ This command also supports setting the following parameters via a configuration - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Sample @@ -47,7 +47,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/dashboard/view.md b/docs/reference/cli/dashboard/view.md index 558284c..2b5b23e 100644 --- a/docs/reference/cli/dashboard/view.md +++ b/docs/reference/cli/dashboard/view.md @@ -30,7 +30,7 @@ This command also supports setting the following parameters via a configuration - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Sample @@ -40,7 +40,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/deployment/add.md b/docs/reference/cli/deployment/add.md index 2f357b0..b97c168 100644 --- a/docs/reference/cli/deployment/add.md +++ b/docs/reference/cli/deployment/add.md @@ -37,7 +37,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Sample @@ -47,7 +47,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/deployment/deployment.md b/docs/reference/cli/deployment/deployment.md index 4555370..3af3ef7 100644 --- a/docs/reference/cli/deployment/deployment.md +++ b/docs/reference/cli/deployment/deployment.md @@ -12,5 +12,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: diff --git a/docs/reference/cli/deployment/get.md b/docs/reference/cli/deployment/get.md index 3750619..8fe9dd1 100644 --- a/docs/reference/cli/deployment/get.md +++ b/docs/reference/cli/deployment/get.md @@ -34,7 +34,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Sample @@ -44,7 +44,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/deployment/view.md b/docs/reference/cli/deployment/view.md index bd1b559..5e76493 100644 --- a/docs/reference/cli/deployment/view.md +++ b/docs/reference/cli/deployment/view.md @@ -33,7 +33,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Sample @@ -43,7 +43,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/hook/get.md b/docs/reference/cli/hook/get.md index c066bea..b3b7f3f 100644 --- a/docs/reference/cli/hook/get.md +++ b/docs/reference/cli/hook/get.md @@ -34,7 +34,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -48,7 +48,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/hook/hook.md b/docs/reference/cli/hook/hook.md index 68a93fe..5757186 100644 --- a/docs/reference/cli/hook/hook.md +++ b/docs/reference/cli/hook/hook.md @@ -12,5 +12,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: diff --git a/docs/reference/cli/hook/view.md b/docs/reference/cli/hook/view.md index 20f43ff..22d9524 100644 --- a/docs/reference/cli/hook/view.md +++ b/docs/reference/cli/hook/view.md @@ -33,7 +33,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -47,7 +47,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/log/get.md b/docs/reference/cli/log/get.md index f3f7433..02bc489 100644 --- a/docs/reference/cli/log/get.md +++ b/docs/reference/cli/log/get.md @@ -33,7 +33,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -47,7 +47,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/log/log.md b/docs/reference/cli/log/log.md index 179df11..6f9376a 100644 --- a/docs/reference/cli/log/log.md +++ b/docs/reference/cli/log/log.md @@ -12,5 +12,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: diff --git a/docs/reference/cli/log/view.md b/docs/reference/cli/log/view.md index 80c53dc..16044ce 100644 --- a/docs/reference/cli/log/view.md +++ b/docs/reference/cli/log/view.md @@ -35,7 +35,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -49,7 +49,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/pipeline/exec.md b/docs/reference/cli/pipeline/exec.md index b65bae8..99f9c7f 100644 --- a/docs/reference/cli/pipeline/exec.md +++ b/docs/reference/cli/pipeline/exec.md @@ -87,7 +87,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/pipeline/generate.md b/docs/reference/cli/pipeline/generate.md index 5ccd8d2..c161760 100644 --- a/docs/reference/cli/pipeline/generate.md +++ b/docs/reference/cli/pipeline/generate.md @@ -37,7 +37,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/pipeline/get.md b/docs/reference/cli/pipeline/get.md index 52f9e42..b39ea3e 100644 --- a/docs/reference/cli/pipeline/get.md +++ b/docs/reference/cli/pipeline/get.md @@ -34,7 +34,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -48,7 +48,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/pipeline/pipeline.md b/docs/reference/cli/pipeline/pipeline.md index d399759..078b08b 100644 --- a/docs/reference/cli/pipeline/pipeline.md +++ b/docs/reference/cli/pipeline/pipeline.md @@ -12,5 +12,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: diff --git a/docs/reference/cli/pipeline/validate.md b/docs/reference/cli/pipeline/validate.md index d609ce7..8bcde71 100644 --- a/docs/reference/cli/pipeline/validate.md +++ b/docs/reference/cli/pipeline/validate.md @@ -53,7 +53,7 @@ COMING SOON! This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Simple Request diff --git a/docs/reference/cli/repo/add.md b/docs/reference/cli/repo/add.md index 937b326..d86a05a 100644 --- a/docs/reference/cli/repo/add.md +++ b/docs/reference/cli/repo/add.md @@ -44,7 +44,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -58,7 +58,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/repo/chown.md b/docs/reference/cli/repo/chown.md index 48eaa28..416fec7 100644 --- a/docs/reference/cli/repo/chown.md +++ b/docs/reference/cli/repo/chown.md @@ -32,7 +32,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -46,7 +46,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/repo/get.md b/docs/reference/cli/repo/get.md index 4b4935a..cf110aa 100644 --- a/docs/reference/cli/repo/get.md +++ b/docs/reference/cli/repo/get.md @@ -34,7 +34,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -48,7 +48,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/repo/remove.md b/docs/reference/cli/repo/remove.md index 5d001e1..8640c3e 100644 --- a/docs/reference/cli/repo/remove.md +++ b/docs/reference/cli/repo/remove.md @@ -32,7 +32,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -46,7 +46,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/repo/repair.md b/docs/reference/cli/repo/repair.md index 5acd246..06fa7f1 100644 --- a/docs/reference/cli/repo/repair.md +++ b/docs/reference/cli/repo/repair.md @@ -32,7 +32,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -46,7 +46,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/repo/repo.md b/docs/reference/cli/repo/repo.md index 723d41f..00b9248 100644 --- a/docs/reference/cli/repo/repo.md +++ b/docs/reference/cli/repo/repo.md @@ -12,5 +12,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: diff --git a/docs/reference/cli/repo/sync.md b/docs/reference/cli/repo/sync.md index f52988d..b2b72fa 100644 --- a/docs/reference/cli/repo/sync.md +++ b/docs/reference/cli/repo/sync.md @@ -31,7 +31,7 @@ This command also supports setting the following parameters via a configuration - `org` - `repo` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Description @@ -53,7 +53,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/repo/update.md b/docs/reference/cli/repo/update.md index 2c72805..6882231 100644 --- a/docs/reference/cli/repo/update.md +++ b/docs/reference/cli/repo/update.md @@ -44,7 +44,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: :::warning @@ -68,7 +68,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/repo/view.md b/docs/reference/cli/repo/view.md index 440f660..71458d6 100644 --- a/docs/reference/cli/repo/view.md +++ b/docs/reference/cli/repo/view.md @@ -32,7 +32,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -46,7 +46,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/schedule/add.md b/docs/reference/cli/schedule/add.md index 56ad364..720a88f 100644 --- a/docs/reference/cli/schedule/add.md +++ b/docs/reference/cli/schedule/add.md @@ -35,7 +35,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Sample @@ -45,7 +45,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/schedule/get.md b/docs/reference/cli/schedule/get.md index b86de87..cf2803a 100644 --- a/docs/reference/cli/schedule/get.md +++ b/docs/reference/cli/schedule/get.md @@ -34,7 +34,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Sample @@ -44,7 +44,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/schedule/remove.md b/docs/reference/cli/schedule/remove.md index 130321d..c7a3e85 100644 --- a/docs/reference/cli/schedule/remove.md +++ b/docs/reference/cli/schedule/remove.md @@ -33,7 +33,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -47,7 +47,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/schedule/schedule.md b/docs/reference/cli/schedule/schedule.md index f0884eb..ef626b2 100644 --- a/docs/reference/cli/schedule/schedule.md +++ b/docs/reference/cli/schedule/schedule.md @@ -12,5 +12,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: \ No newline at end of file diff --git a/docs/reference/cli/schedule/update.md b/docs/reference/cli/schedule/update.md index 3fa70be..abdf38a 100644 --- a/docs/reference/cli/schedule/update.md +++ b/docs/reference/cli/schedule/update.md @@ -35,7 +35,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -49,7 +49,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/schedule/view.md b/docs/reference/cli/schedule/view.md index 135084b..0540546 100644 --- a/docs/reference/cli/schedule/view.md +++ b/docs/reference/cli/schedule/view.md @@ -33,7 +33,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Sample @@ -43,7 +43,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/secret/add.md b/docs/reference/cli/secret/add.md index 4123b57..c7bb349 100644 --- a/docs/reference/cli/secret/add.md +++ b/docs/reference/cli/secret/add.md @@ -51,7 +51,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -65,7 +65,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/secret/get.md b/docs/reference/cli/secret/get.md index 2b92891..4980e4c 100644 --- a/docs/reference/cli/secret/get.md +++ b/docs/reference/cli/secret/get.md @@ -37,7 +37,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -51,7 +51,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/secret/remove.md b/docs/reference/cli/secret/remove.md index 3a56e99..6cbf8db 100644 --- a/docs/reference/cli/secret/remove.md +++ b/docs/reference/cli/secret/remove.md @@ -38,7 +38,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -52,7 +52,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/secret/secret.md b/docs/reference/cli/secret/secret.md index 237a0a4..9a72a9e 100644 --- a/docs/reference/cli/secret/secret.md +++ b/docs/reference/cli/secret/secret.md @@ -12,5 +12,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: diff --git a/docs/reference/cli/secret/update.md b/docs/reference/cli/secret/update.md index 2e7e76f..70e6c20 100644 --- a/docs/reference/cli/secret/update.md +++ b/docs/reference/cli/secret/update.md @@ -44,7 +44,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -58,7 +58,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/secret/view.md b/docs/reference/cli/secret/view.md index 4f33584..0e7fa87 100644 --- a/docs/reference/cli/secret/view.md +++ b/docs/reference/cli/secret/view.md @@ -38,7 +38,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -52,7 +52,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/service/get.md b/docs/reference/cli/service/get.md index 81cf2df..6a43d88 100644 --- a/docs/reference/cli/service/get.md +++ b/docs/reference/cli/service/get.md @@ -35,7 +35,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -49,7 +49,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/service/service.md b/docs/reference/cli/service/service.md index ecc9b03..8df8322 100644 --- a/docs/reference/cli/service/service.md +++ b/docs/reference/cli/service/service.md @@ -12,5 +12,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: diff --git a/docs/reference/cli/service/view.md b/docs/reference/cli/service/view.md index 11ced9d..84f4b68 100644 --- a/docs/reference/cli/service/view.md +++ b/docs/reference/cli/service/view.md @@ -34,7 +34,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -48,7 +48,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/settings/settings.md b/docs/reference/cli/settings/settings.md index 8ea4388..fcf00cb 100644 --- a/docs/reference/cli/settings/settings.md +++ b/docs/reference/cli/settings/settings.md @@ -12,5 +12,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: diff --git a/docs/reference/cli/settings/update.md b/docs/reference/cli/settings/update.md index 18ea922..45b639a 100644 --- a/docs/reference/cli/settings/update.md +++ b/docs/reference/cli/settings/update.md @@ -43,7 +43,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/settings/view.md b/docs/reference/cli/settings/view.md index 23aaf36..742702e 100644 --- a/docs/reference/cli/settings/view.md +++ b/docs/reference/cli/settings/view.md @@ -26,7 +26,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/step/get.md b/docs/reference/cli/step/get.md index 7ae91b6..2ba335e 100644 --- a/docs/reference/cli/step/get.md +++ b/docs/reference/cli/step/get.md @@ -35,7 +35,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -49,7 +49,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/step/step.md b/docs/reference/cli/step/step.md index c8b308e..6557130 100644 --- a/docs/reference/cli/step/step.md +++ b/docs/reference/cli/step/step.md @@ -12,5 +12,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: diff --git a/docs/reference/cli/step/view.md b/docs/reference/cli/step/view.md index 73509f0..43b35ea 100644 --- a/docs/reference/cli/step/view.md +++ b/docs/reference/cli/step/view.md @@ -34,7 +34,7 @@ This command also supports setting the following parameters via a configuration - `repo` - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -48,7 +48,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/validate.md b/docs/reference/cli/validate.md index 292b539..7e11914 100644 --- a/docs/reference/cli/validate.md +++ b/docs/reference/cli/validate.md @@ -6,5 +6,5 @@ sidebar_position: 3 :::tip This command has been moved to `vela validate pipeline`. -For more information, please see the [command documentation](/docs/reference/cli/pipeline/validate/) +For more information, please see the [command documentation](/docs/reference/cli/pipeline/validate.md) ::: diff --git a/docs/reference/cli/version.md b/docs/reference/cli/version.md index 3844b48..208f344 100644 --- a/docs/reference/cli/version.md +++ b/docs/reference/cli/version.md @@ -15,7 +15,7 @@ $ vela version This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/worker/add.md b/docs/reference/cli/worker/add.md index 8198d1a..ce81de5 100644 --- a/docs/reference/cli/worker/add.md +++ b/docs/reference/cli/worker/add.md @@ -30,7 +30,7 @@ This command also supports setting the following parameters via a configuration - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -44,7 +44,7 @@ This section assumes you have already installed and setup the CLI and are authen To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/worker/get.md b/docs/reference/cli/worker/get.md index 29a5fc8..885c15b 100644 --- a/docs/reference/cli/worker/get.md +++ b/docs/reference/cli/worker/get.md @@ -28,7 +28,7 @@ This command also supports setting the following parameters via a configuration - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -42,7 +42,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/worker/update.md b/docs/reference/cli/worker/update.md index 4871987..d15878c 100644 --- a/docs/reference/cli/worker/update.md +++ b/docs/reference/cli/worker/update.md @@ -33,7 +33,7 @@ This command also supports setting the following parameters via a configuration - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -47,7 +47,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/worker/view.md b/docs/reference/cli/worker/view.md index 8930442..caad51b 100644 --- a/docs/reference/cli/worker/view.md +++ b/docs/reference/cli/worker/view.md @@ -30,7 +30,7 @@ This command also supports setting the following parameters via a configuration - `output` -For more information, please review the [CLI config documentation](/docs/reference/cli/config/). +For more information, please review the [CLI config documentation](/docs/reference/cli/config/config.md). ::: ## Permissions @@ -44,7 +44,7 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: #### Request diff --git a/docs/reference/cli/worker/worker.md b/docs/reference/cli/worker/worker.md index a264609..35afb6f 100644 --- a/docs/reference/cli/worker/worker.md +++ b/docs/reference/cli/worker/worker.md @@ -12,5 +12,5 @@ This section assumes you have already installed and setup the CLI. To install the CLI, please review the [installation documentation](/docs/reference/cli/install.md). -To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication/). +To setup the CLI, please review the [authentication documentation](/docs/reference/cli/authentication.md). ::: diff --git a/docs/reference/environment/environment.md b/docs/reference/environment/environment.md index 1307ac1..b6e9d7d 100644 --- a/docs/reference/environment/environment.md +++ b/docs/reference/environment/environment.md @@ -9,5 +9,5 @@ description: > Vela allows ways to set environment variables within the step, service, or secret container environment. This allows users to pass custom environment configurations to the container. Custom environment configuration can allow you to customize the build environment or simply add metadata for whatever the container image is running. :::tip -An example is available within the usage tab called ["Using the Environment"](/docs/usage/environment/) +An example is available within the usage tab called ["Using the Environment"](/docs/usage/environment.md) ::: diff --git a/docs/reference/installation/_category_.json b/docs/reference/installation/_category_.json index 1daf919..0d527f1 100644 --- a/docs/reference/installation/_category_.json +++ b/docs/reference/installation/_category_.json @@ -1,6 +1,6 @@ { "label": "Installation", - "position": 2, + "position": 3, "link": { "type": "generated-index" } diff --git a/docs/reference/installation/server/authentication_workflow.puml b/docs/reference/installation/server/authentication_workflow.puml deleted file mode 100644 index 48cfbdf..0000000 --- a/docs/reference/installation/server/authentication_workflow.puml +++ /dev/null @@ -1,23 +0,0 @@ -@startuml - -title Vela Authentication Workflow - -skinparam actorStyle awesome -actor "Developer" as Developer - -participant "UI" as UI -participant "Server" as Server -participant "GitHub" as Github - -Developer -> UI : Connect to vela.example.com -UI -> Server : Redirect to vela-server.example.com/authenticate -Server -> Github : GET github.com/login/oauth/authorize for authorization code -Github -> Server : Return temporary code -Server -> Github : POST github.com/login/oauth/access_token for OAuth token -Github -> Server : Return OAuth token -Server -> Server : Store OAuth token in the database -Server -> Server : Generate short-lived token for user (automatically refreshes) -Server -> Developer : Redirect to vela.example.com with short-lived token -Developer -> UI : Successful completion of authentication workflow - -@enduml \ No newline at end of file diff --git a/docs/reference/installation/server/compiler.md b/docs/reference/installation/server/compiler.md index 6b8cfc9..4951075 100644 --- a/docs/reference/installation/server/compiler.md +++ b/docs/reference/installation/server/compiler.md @@ -10,7 +10,7 @@ description: > The compiler is embedded directly in the server and can only be accessed through the server. ::: -This component is responsible for transforming a [pipeline](/docs/tour/) into an executable representation for the [worker](/docs/installation/worker/). +This component is responsible for transforming a [pipeline](None) into an executable representation for the [worker](/docs/installation/worker/worker.md). During the transformation, it will retrieve [templates](/docs/tour/templates/) from one or more registries depending on the pipeline configuration. @@ -49,7 +49,7 @@ The following options are used to configure the component: _(1) this will be the latest available, tagged release of `target/vela-git` at the time the server component is released_ :::note -For more information on these configuration options, please see the [server reference](/docs/installation/server/reference/). +For more information on these configuration options, please see the [server reference](/docs/reference/installation/server/server.md). ::: ## Drivers diff --git a/docs/reference/installation/server/database.md b/docs/reference/installation/server/database.md index d9efdfe..587cdad 100644 --- a/docs/reference/installation/server/database.md +++ b/docs/reference/installation/server/database.md @@ -36,7 +36,7 @@ The following options are used to configure the component: | `database.log.slow_threshold` | queries higher than this value are considered slow and logged | `false` | `200ms` | `DATABASE_LOG_SLOW_THRESHOLD` \ `VELA_DATABASE_LOG_SLOW_THRESHOLD` | :::note -For more information on these configuration options, please see the [server reference](/docs/installation/server/reference/). +For more information on these configuration options, please see the [server reference](/docs/reference/installation/server/server.md). ::: ## Drivers diff --git a/docs/reference/installation/server/queue.md b/docs/reference/installation/server/queue.md index 57918e0..c498e98 100644 --- a/docs/reference/installation/server/queue.md +++ b/docs/reference/installation/server/queue.md @@ -8,7 +8,7 @@ description: > This component is responsible for integrating with a queue system based off the configuration provided. -The queue system is used by the Vela server for pushing workloads that will be run by a [worker](/docs/installation/worker/). +The queue system is used by the Vela server for pushing workloads that will be run by a [worker](/docs/installation/worker/worker.md). Workloads published to the queue are managed with a [first in, first out (FIFO)](https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics)) strategy. @@ -27,7 +27,7 @@ The following options are used to configure the component: | `queue.public-key` | public key for opening items after popping them off the queue | `false` | `N/A` | `QUEUE_PUBLIC_KEY`\`VELA_QUEUE_PUBLIC_KEY` | :::note -For more information on these configuration options, please see the [server reference](/docs/installation/server/reference/). +For more information on these configuration options, please see the [server reference](/docs/reference/installation/server/server.md). ::: ## Drivers diff --git a/docs/reference/installation/server/scm.md b/docs/reference/installation/server/scm.md index 23b392d..c825a60 100644 --- a/docs/reference/installation/server/scm.md +++ b/docs/reference/installation/server/scm.md @@ -27,7 +27,7 @@ The following options are used to configure the component: | `scm.webhook.addr` | url for webhooks on the SCM to send requests to | `false` | the address of the Vela server (`$VELA_ADDR`) | `SCM_WEBHOOK_ADDR`\`VELA_SCM_WEBHOOK_ADDR` | :::note -For more information on these configuration options, please see the [server reference](/docs/installation/server/reference/). +For more information on these configuration options, please see the [server reference](/docs/reference/installation/server/server.md). ::: ## Drivers diff --git a/docs/reference/installation/server/secret.md b/docs/reference/installation/server/secret.md index 486298c..ccf0981 100644 --- a/docs/reference/installation/server/secret.md +++ b/docs/reference/installation/server/secret.md @@ -32,7 +32,7 @@ The following options are used to configure the component: | `secret.vault.version` | version for the k/v backend for the HashiCorp Vault instance | `true` | `2` | `SECRET_VAULT_VERSION`\`VELA_SECRET_VAULT_VERSION` | :::note -For more information on these configuration options, please see the [server reference](/docs/installation/server/reference/). +For more information on these configuration options, please see the [server reference](/docs/reference/installation/server/server.md). ::: ## Drivers diff --git a/docs/reference/installation/server/server.md b/docs/reference/installation/server/server.md index ad90808..88af3f2 100644 --- a/docs/reference/installation/server/server.md +++ b/docs/reference/installation/server/server.md @@ -1,7 +1,7 @@ --- no_list: true -title: "Reference" -linkTitle: "Reference" +title: "Server" +sidebar_position: 1 weight: 4 description: > This section contains a reference of configuration options for the Vela server service. @@ -13,13 +13,13 @@ The server is made up of several components, responsible for specific tasks, nec | Name | Description | | ---------- | ----------------------------------------------------------------------------------------------------------------- | -| `settings` | keeps track of updated runtime properties for the [server](/docs/installation/server/) | -| `compiler` | transforms a [pipeline](/docs/tour/) into an executable workload for the [worker](/docs/installation/worker/) | +| `settings` | keeps track of updated runtime properties for the [server](/docs/installation/server/server.md) | +| `compiler` | transforms a [pipeline](None) into an executable workload for the [worker](/docs/installation/worker/worker.md) | | `database` | integrates with a database provider for storing application data at rest | -| `queue` | integrates with a queue provider for pushing workloads that will be run by a [worker](/docs/installation/worker/) | +| `queue` | integrates with a queue provider for pushing workloads that will be run by a [worker](/docs/installation/worker/worker.md) | | `secret` | integrates with a secret provider for storing sensitive application data at rest | | `source` | integrates with a source control management (SCM) provider for authentication and authorization | -| `tracing` | implements OpenTelemetry tracing instrumentation for the [server](/docs/installation/server/) | +| `tracing` | implements OpenTelemetry tracing instrumentation for the [server](/docs/installation/server/server.md) | ## Required @@ -29,13 +29,13 @@ Some properties can be updated while the server is running using the [settings c ### VELA_ADDR -This variable sets a fully qualified URL to the Vela [server](/docs/installation/server/) address. +This variable sets a fully qualified URL to the Vela [server](/docs/installation/server/server.md) address. The variable should be provided as a `string`. ### VELA_DATABASE_ENCRYPTION_KEY -This configuration variable is used by the [database component](/docs/installation/server/reference/database/) for the server. +This configuration variable is used by the [database component](/docs/reference/installation/server/database.md) for the server. Examples using this configuration variable are provided in the above reference documentation. @@ -45,17 +45,17 @@ The variable should be provided as an `string`. ### VELA_QUEUE_ADDR -This configuration variable is used by the [queue component](/docs/installation/server/reference/queue/) for the server. +This configuration variable is used by the [queue component](/docs/reference/installation/server/queue.md) for the server. Examples using this configuration variable are provided in the above reference documentation. -This variable sets a fully qualified URL to the queue instance for pushing workloads that will be run by a [worker](/docs/installation/worker/). +This variable sets a fully qualified URL to the queue instance for pushing workloads that will be run by a [worker](/docs/installation/worker/worker.md). The variable should be provided as a `string`. ### VELA_QUEUE_DRIVER -This configuration variable is used by the [queue component](/docs/installation/server/reference/queue/) for the server. +This configuration variable is used by the [queue component](/docs/reference/installation/server/queue.md) for the server. Examples using this configuration variable are provided in the above reference documentation. @@ -73,7 +73,7 @@ The possible options to provide for this variable are: ### VELA_SCM_CLIENT -This configuration variable is used by the [SCM component](/docs/installation/server/reference/scm/) for the server. +This configuration variable is used by the [SCM component](/docs/reference/installation/server/scm.md) for the server. This variable sets the client ID from the OAuth application created on the SCM system. @@ -81,7 +81,7 @@ The variable should be provided as a `string`. ### VELA_SCM_SECRET -This configuration variable is used by the [SCM component](/docs/installation/server/reference/scm/) for the server. +This configuration variable is used by the [SCM component](/docs/reference/installation/server/scm.md) for the server. This variable sets the client secret from the OAuth application created on the SCM system. @@ -113,7 +113,7 @@ This property can be updated while the server is running using the [settings com ### VELA_COMPILER_GITHUB -This configuration variable is used by the [compiler component](/docs/installation/server/reference/compiler/) for the server. +This configuration variable is used by the [compiler component](/docs/reference/installation/server/compiler.md) for the server. Examples using this configuration variable are provided in the above reference documentation. @@ -131,7 +131,7 @@ This variable has a default value of `false`. ### VELA_COMPILER_GITHUB_TOKEN -This configuration variable is used by the [compiler component](/docs/installation/server/reference/compiler/) for the server. +This configuration variable is used by the [compiler component](/docs/reference/installation/server/compiler.md) for the server. Examples using this configuration variable are provided in the above reference documentation. @@ -145,7 +145,7 @@ The variable can be provided as a `string`. ### VELA_COMPILER_GITHUB_URL -This configuration variable is used by the [compiler component](/docs/installation/server/reference/compiler/) for the server. +This configuration variable is used by the [compiler component](/docs/reference/installation/server/compiler.md) for the server. Examples using this configuration variable are provided in the above reference documentation. @@ -159,7 +159,7 @@ The variable can be provided as a `string`. ### VELA_DATABASE_ADDR -This configuration variable is used by the [database component](/docs/installation/server/reference/database/) for the server. +This configuration variable is used by the [database component](/docs/reference/installation/server/database.md) for the server. Examples using this configuration variable are provided in the above reference documentation. @@ -173,9 +173,9 @@ This variable has a default value of `vela.sqlite`. ### VELA_DATABASE_COMPRESSION_LEVEL -This configuration variable is used by the [database component](/docs/installation/server/reference/database/) for the server. +This configuration variable is used by the [database component](/docs/reference/installation/server/database.md) for the server. -This variable sets the level of compression for workload logs, uploaded by the Vela [worker](/docs/installation/worker/), which are stored in the database. +This variable sets the level of compression for workload logs, uploaded by the Vela [worker](/docs/installation/worker/worker.md), which are stored in the database. The variable can be provided as an `integer`. @@ -199,7 +199,7 @@ The possible options to provide for this variable are: ### VELA_DATABASE_CONNECTION_IDLE -This configuration variable is used by the [database component](/docs/installation/server/reference/database/) for the server. +This configuration variable is used by the [database component](/docs/reference/installation/server/database.md) for the server. This variable sets the maximum number of [idle connections](https://pkg.go.dev/database/sql#DB.SetMaxIdleConns) allowed for the database client. @@ -211,7 +211,7 @@ This variable has a default value of `2`. ### VELA_DATABASE_CONNECTION_LIFE -This configuration variable is used by the [database component](/docs/installation/server/reference/database/) for the server. +This configuration variable is used by the [database component](/docs/reference/installation/server/database.md) for the server. This variable sets the maximum duration of time [a connection is reusable](https://pkg.go.dev/database/sql#DB.SetConnMaxLifetime) for the database client. @@ -223,7 +223,7 @@ This variable has a default value of `30m`. ### VELA_DATABASE_CONNECTION_OPEN -This configuration variable is used by the [database component](/docs/installation/server/reference/database/) for the server. +This configuration variable is used by the [database component](/docs/reference/installation/server/database.md) for the server. This variable sets the maximum number of [open connections](https://pkg.go.dev/database/sql#DB.SetMaxOpenConns) allowed for the database client. @@ -235,7 +235,7 @@ This variable has a default value of `0` (meaning no limit is set). ### VELA_DATABASE_DRIVER -This configuration variable is used by the [database component](/docs/installation/server/reference/database/) for the server. +This configuration variable is used by the [database component](/docs/reference/installation/server/database.md) for the server. Examples using this configuration variable are provided in the above reference documentation. @@ -254,7 +254,7 @@ The possible options to provide for this variable are: ### VELA_DATABASE_SKIP_CREATION -This configuration variable is used by the [database component](/docs/installation/server/reference/database/) for the server. +This configuration variable is used by the [database component](/docs/reference/installation/server/database.md) for the server. This variable enables skipping the creation of tables and indexes in the database system. @@ -266,7 +266,7 @@ This variable has a default value of `false`. ### VELA_DATABASE_LOG_LEVEL -This configuration variable is used by the [database component](/docs/installation/server/reference/database/) for the server. +This configuration variable is used by the [database component](/docs/reference/installation/server/database.md) for the server. This variable controls the log level to use in the database system. This can be different than the log level for the rest of the application. @@ -278,7 +278,7 @@ This variable has a default value of `warn`. ### VELA_DATABASE_LOG_SHOW_SQL -This configuration variable is used by the [database component](/docs/installation/server/reference/database/) for the server. +This configuration variable is used by the [database component](/docs/reference/installation/server/database.md) for the server. This variable controls whether to show the SQL query in the logs for the database system. @@ -290,7 +290,7 @@ This variable has a default value of `false`. ### VELA_DATABASE_LOG_SKIP_NOTFOUND -This configuration variable is used by the [database component](/docs/installation/server/reference/database/) for the server. +This configuration variable is used by the [database component](/docs/reference/installation/server/database.md) for the server. This variable controls whether to skip showing record not found errors in the logs for the in the database system. @@ -302,7 +302,7 @@ This variable has a default value of `true`. ### VELA_DATABASE_LOG_SLOW_THRESHOLD -This configuration variable is used by the [database component](/docs/installation/server/reference/database/) for the server. +This configuration variable is used by the [database component](/docs/reference/installation/server/database.md) for the server. This variable controls the threshold that determines which queries are considered slow and logged in the database system. @@ -398,7 +398,7 @@ This variable should match [the `VELA_MAX_BUILD_LIMIT` variable](/docs/installat ### VELA_MODIFICATION_ADDR -This configuration variable is used by the [compiler component](/docs/installation/server/reference/compiler/) for the server. +This configuration variable is used by the [compiler component](/docs/reference/installation/server/compiler.md) for the server. This variable sets a fully qualified URL to the modification endpoint used for the compiler. @@ -406,7 +406,7 @@ The variable can be provided as a `string`. ### VELA_MODIFICATION_RETRIES -This configuration variable is used by the [compiler component](/docs/installation/server/reference/compiler/) for the server. +This configuration variable is used by the [compiler component](/docs/reference/installation/server/compiler.md) for the server. This variable sets the maximum number of times to resend failed requests to the modification endpoint for the compiler. @@ -418,7 +418,7 @@ This variable has a default value of `5`. ### VELA_MODIFICATION_SECRET -This configuration variable is used by the [compiler component](/docs/installation/server/reference/compiler/) for the server. +This configuration variable is used by the [compiler component](/docs/reference/installation/server/compiler.md) for the server. This variable sets a shared secret for authenticating communication between the compiler and the modification endpoint. @@ -426,7 +426,7 @@ The variable can be provided as a `string`. ### VELA_MODIFICATION_TIMEOUT -This configuration variable is used by the [compiler component](/docs/installation/server/reference/compiler/) for the server. +This configuration variable is used by the [compiler component](/docs/reference/installation/server/compiler.md) for the server. This variable sets the maximum duration of time the compiler will wait before timing out requests sent to the modification endpoint. @@ -476,7 +476,7 @@ This variable has a default value of `8080`. ### VELA_QUEUE_CLUSTER -This configuration variable is used by the [queue component](/docs/installation/server/reference/queue/) for the server. +This configuration variable is used by the [queue component](/docs/reference/installation/server/queue.md) for the server. This variable enables the server to connect to a queue cluster rather than a standalone instance. @@ -488,7 +488,7 @@ This variable should match [the `VELA_QUEUE_CLUSTER` variable](/docs/installatio ### VELA_QUEUE_POP_TIMEOUT -This configuration variable is unused by the [queue component](/docs/installation/server/reference/queue/) for the server. +This configuration variable is unused by the [queue component](/docs/reference/installation/server/queue.md) for the server. This variable sets the maximum duration of time the worker will wait before timing out requests sent for pushing workloads. @@ -500,7 +500,7 @@ This variable has a default value of `60s`. ### VELA_QUEUE_ROUTES -This configuration variable is used by the [queue component](/docs/installation/server/reference/queue/) for the server. +This configuration variable is used by the [queue component](/docs/reference/installation/server/queue.md) for the server. This variable sets the unique channels or topics to push workloads to. @@ -560,7 +560,7 @@ This variable has a default value of `1h`. ### VELA_SCM_ADDR -This configuration variable is used by the [SCM component](/docs/installation/server/reference/scm/) for the server. +This configuration variable is used by the [SCM component](/docs/reference/installation/server/scm.md) for the server. This variable sets a fully qualified URL to the source control management (SCM) system. @@ -572,7 +572,7 @@ This variable has a default value of `https://github.com`. ### VELA_SCM_CONTEXT -This configuration variable is used by the [SCM component](/docs/installation/server/reference/scm/) for the server. +This configuration variable is used by the [SCM component](/docs/reference/installation/server/scm.md) for the server. This variable sets the message to set in the commit status on the SCM system. @@ -584,7 +584,7 @@ This variable has a default value of `continuous-integration/vela`. ### VELA_SCM_DRIVER -This configuration variable is used by the [SCM component](/docs/installation/server/reference/scm/) for the server. +This configuration variable is used by the [SCM component](/docs/reference/installation/server/scm.md) for the server. This variable sets the driver to use for the SCM functionality for the server. @@ -600,7 +600,7 @@ The possible options to provide for this variable are: ### VELA_SCM_SCOPES -This configuration variable is used by the [SCM component](/docs/installation/server/reference/scm/) for the server. +This configuration variable is used by the [SCM component](/docs/reference/installation/server/scm.md) for the server. This variable sets the permission scopes to apply for OAuth credentials captured from the SCM system. @@ -612,7 +612,7 @@ This variable has a default value of `read:org,read:user,repo,repo:status,user:e ### VELA_SCM_WEBHOOK_ADDR -This configuration variable is used by the [SCM component](/docs/installation/server/reference/scm/) for the server. +This configuration variable is used by the [SCM component](/docs/reference/installation/server/scm.md) for the server. This variable sets a fully qualified URL on the SCM system to send webhooks to the server. @@ -624,7 +624,7 @@ This variable has a default value of [the `VELA_ADDR` variable](/docs/installati ### VELA_SECRET -This variable sets a shared secret with the Vela [worker](/docs/installation/worker/) for authenticating communication between workers and the server. +This variable sets a shared secret with the Vela [worker](/docs/installation/worker/worker.md) for authenticating communication between workers and the server. Only necessary to provide if utilizing the [server-worker trusted symmetric worker authentication method](/docs/installation/worker/docker/#worker-server-trusted-symmetric-token). @@ -636,7 +636,7 @@ This variable should match [the `VELA_SERVER_SECRET` variable](/docs/installatio ### VELA_SECRET_VAULT -This configuration variable is used by the [secret component](/docs/installation/server/reference/secret/) for the server. +This configuration variable is used by the [secret component](/docs/reference/installation/server/secret.md) for the server. Examples using this configuration variable are provided in the above reference documentation. @@ -650,7 +650,7 @@ This variable has a default value of `false`. ### VELA_SECRET_VAULT_ADDR -This configuration variable is used by the [secret component](/docs/installation/server/reference/secret/) for the server. +This configuration variable is used by the [secret component](/docs/reference/installation/server/secret.md) for the server. Examples using this configuration variable are provided in the above reference documentation. @@ -660,7 +660,7 @@ The variable can be provided as a `string`. ### VELA_SECRET_VAULT_AUTH_METHOD -This configuration variable is used by the [secret component](/docs/installation/server/reference/secret/) for the server. +This configuration variable is used by the [secret component](/docs/reference/installation/server/secret.md) for the server. This variable sets the authentication method to obtain a token from the HashiCorp Vault instance. @@ -668,7 +668,7 @@ The variable can be provided as a `string`. ### VELA_SECRET_VAULT_AWS_ROLE -This configuration variable is used by the [secret component](/docs/installation/server/reference/secret/) for the server. +This configuration variable is used by the [secret component](/docs/reference/installation/server/secret.md) for the server. This variable sets the HashiCorp Vault role to connect to the `auth/aws/login` endpoint. @@ -676,7 +676,7 @@ The variable can be provided as a `string`. ### VELA_SECRET_VAULT_PREFIX -This configuration variable is used by the [secret component](/docs/installation/server/reference/secret/) for the server. +This configuration variable is used by the [secret component](/docs/reference/installation/server/secret.md) for the server. This variable sets the prefix for k/v secrets in the HashiCorp Vault instance. @@ -684,7 +684,7 @@ The variable can be provided as a `string`. ### VELA_SECRET_VAULT_RENEWAL -This configuration variable is used by the [secret component](/docs/installation/server/reference/secret/) for the server. +This configuration variable is used by the [secret component](/docs/reference/installation/server/secret.md) for the server. This variable sets the frequency to renew the token for the HashiCorp Vault instance. @@ -696,7 +696,7 @@ This variable has a default value of `30m`. ### VELA_SECRET_VAULT_TOKEN -This configuration variable is used by the [secret component](/docs/installation/server/reference/secret/) for the server. +This configuration variable is used by the [secret component](/docs/reference/installation/server/secret.md) for the server. Examples using this configuration variable are provided in the above reference documentation. @@ -706,7 +706,7 @@ The variable can be provided as a `string`. ### VELA_SECRET_VAULT_VERSION -This configuration variable is used by the [secret component](/docs/installation/server/reference/secret/) for the server. +This configuration variable is used by the [secret component](/docs/reference/installation/server/secret.md) for the server. This variable sets the version for the k/v backend for the HashiCorp Vault instance. @@ -754,13 +754,13 @@ This variable has a default value of `5m`. ### VELA_WEBUI_ADDR -This variable sets a fully qualified URL to the Vela [UI](/docs/installation/ui/) address. +This variable sets a fully qualified URL to the Vela [UI](/docs/installation/ui/ui.md) address. The variable can be provided as a `string`. ### VELA_WEBUI_OAUTH_CALLBACK_PATH -This variable sets the endpoint to use for the OAuth callback path for the Vela [UI](/docs/installation/ui/). +This variable sets the endpoint to use for the OAuth callback path for the Vela [UI](/docs/installation/ui/ui.md). The variable can be provided as a `string`. @@ -805,7 +805,7 @@ The variable can be provided as a `duration` (i.e. `5s`, `10m`). :::note This variable has a default value of `5m`.\ \ -The value should coordinate with the [`VELA_CHECK_IN`](/docs/installation/worker/reference/#vela_check_in) setting provided to the [worker](/docs/installation/worker/). +The value should coordinate with the [`VELA_CHECK_IN`](/docs/installation/worker/reference/#vela_check_in) setting provided to the [worker](/docs/installation/worker/worker.md). ::: ### VELA_OTEL_TRACING_ENABLE diff --git a/docs/reference/installation/server/settings.md b/docs/reference/installation/server/settings.md index c049d8c..73235f9 100644 --- a/docs/reference/installation/server/settings.md +++ b/docs/reference/installation/server/settings.md @@ -26,18 +26,18 @@ The following options are used to configure the component: | `settings-refresh-interval` | the interval at which the server syncs with the database | `true` | `5s` | `VELA_PLATFORM_SETTINGS_REFRESH_INTERVAL`, `VELA_SETTINGS_REFRESH_INTERVAL` | :::note -For more information on how the runtime properties are consumed, please see the [server reference](/docs/installation/server/reference/). +For more information on how the runtime properties are consumed, please see the [server reference](/docs/reference/installation/server/server.md). ::: ## Permissions -This functionality only exists for [Platform Administrators](/docs/usage/roles/). +This functionality only exists for [Platform Administrators](/docs/usage/roles.md). ## Usage ### Initializing -The server will ensure shared settings are first initialized using the variables provided in the environment. For more information on how the runtime properties are configured, please see the [server reference](/docs/installation/server/reference/). +The server will ensure shared settings are first initialized using the variables provided in the environment. For more information on how the runtime properties are configured, please see the [server reference](/docs/reference/installation/server/server.md). On subsequent server startups, the properties controlled by the `settings` component will be retrieved from the database. diff --git a/docs/reference/installation/server/token_manager.md b/docs/reference/installation/server/token_manager.md index 16d9c78..bef81d4 100644 --- a/docs/reference/installation/server/token_manager.md +++ b/docs/reference/installation/server/token_manager.md @@ -29,5 +29,5 @@ The following options are used to configure the component: :::note \* `worker-auth-token-duration` and `worker-register-token-duration` are required if you intend to register workers. -For more information on these configuration options, please see the [server reference](/docs/installation/server/reference/). +For more information on these configuration options, please see the [server reference](/docs/reference/installation/server/server.md). ::: diff --git a/docs/reference/installation/server/tracing.md b/docs/reference/installation/server/tracing.md index 52efee6..de9eccb 100644 --- a/docs/reference/installation/server/tracing.md +++ b/docs/reference/installation/server/tracing.md @@ -27,7 +27,7 @@ The following options are used to configure the component: | `tracing.tracestate.attributes` | This variable sets OTel tracestate [(span) attributes](https://www.w3.org/TR/trace-context) as a list of `key=value` pairs. Each pair will be inserted into the tracestate for each sampled span. | `false` | `N/A` | `VELA_OTEL_TRACING_TRACESTATE_ATTRIBUTES` | :::note -For more information on how the runtime properties are consumed, please see the [server reference](/docs/installation/server/reference/). +For more information on how the runtime properties are consumed, please see the [server reference](/docs/reference/installation/server/server.md). ::: ## Exporter diff --git a/docs/reference/installation/ui.md b/docs/reference/installation/ui.md new file mode 100644 index 0000000..d5d9da8 --- /dev/null +++ b/docs/reference/installation/ui.md @@ -0,0 +1,82 @@ +--- +title: "UI" +sidebar_position: 3 +--- + +## Required + +This section contains a list of all variables that must be provided to the UI. + +### VELA_API + +This variable sets a fully qualified URL to the Vela [server](/docs/installation/server/) address. + +The variable should be provided as a `string`. + +:::note +This variable should match [the `VELA_ADDR` variable](/docs/installation/server/reference/#vela_addr) provided to the server. +::: + +## Optional + +This section contains a list of all variables that can be provided to the UI. + +### NODE_ENV + +This variable sets the targeted deployment environment for [node.js](https://nodejs.org/). + +Setting this variable to `development` will enable development mode for the service and output verbose logging. + +The variable can be provided as a `string`. + +:::note +This variable has a default value of `production`. +::: + +### VELA_DOCS_URL + +This variable sets a fully qualified URL to the documentation website for Vela. + +The variable can be provided as a `string`. + +:::note +This variable has a default value of `https://go-vela.github.io/docs/`. + +Please note that this variable is used in deep links throughout the UI. Customizing this value assumes the target location utilizes the same URL structure as the official docs at the default location. +::: + +### VELA_FEEDBACK_URL + +This variable sets a fully qualified URL to the feedback website for Vela. + +The variable can be provided as a `string`. + +:::note +This variable has a default value of `https://github.com/go-vela/ui/issues/new/`. +::: + +### VELA_LOG_BYTES_LIMIT + +This variable sets the maximum amount of bytes for logs the UI will attempt to render. + +The variable can be provided as an `integer`. + +:::note +This variable has a default value of `20000` (2 MB). +::: + +### VELA_MAX_BUILD_LIMIT + +This variable sets the maximum amount of concurrent builds a repo is allowed to run. + +In this context, concurrent builds refers to any `pending` or `running` builds for that repo. + +If the amount of concurrent builds for a repo matches the limit, then any new builds will be blocked from being created. + +The variable can be provided as an `integer`. + +:::note +This variable has a default value of `30`. + +This variable should match [the `VELA_MAX_BUILD_LIMIT` variable](/docs/installation/server/reference/#vela_max_build_limit) provided to the server. +::: \ No newline at end of file diff --git a/docs/reference/installation/worker/executor.md b/docs/reference/installation/worker/executor.md index 71ce9d5..706167c 100644 --- a/docs/reference/installation/worker/executor.md +++ b/docs/reference/installation/worker/executor.md @@ -7,7 +7,7 @@ description: > This component is responsible for coordinating with [the runtime](/docs/installation/worker/runtime/) to manage workload resources. -Throughout the lifecycle of these resources, this component will track and report results back to the [server](/docs/installation/server/). +Throughout the lifecycle of these resources, this component will track and report results back to the [server](/docs/installation/server/server.md). ## Configuration @@ -20,7 +20,7 @@ The following options are used to configure the component: | `executor.log_streaming_timeout` | maximum time to wait, after build completion, for logs to finish streaming | `false` | `5m` | `EXECUTOR_LOG_STREAMING_TIMEOUT`\`VELA_EXECUTOR_LOG_STREAMING_TIMEOUT` | :::note -For more information on these configuration options, please see the [worker reference](/docs/installation/worker/reference/). +For more information on these configuration options, please see the [worker reference](/docs/reference/installation/worker/worker.md). ::: ## Drivers @@ -62,6 +62,6 @@ This Linux configuration is enabled by default and is not necessary to provide i ### Local -The `local` executor driver is only intended for use with the [Vela CLI](/docs/reference/cli/). +The `local` executor driver is only intended for use with the [Vela CLI](None). It's not recommended to run any workloads on a worker configured with this driver. diff --git a/docs/reference/installation/worker/queue.md b/docs/reference/installation/worker/queue.md index d83ad0d..57349e4 100644 --- a/docs/reference/installation/worker/queue.md +++ b/docs/reference/installation/worker/queue.md @@ -7,7 +7,7 @@ description: > This component is responsible for integrating with a queue system based off the configuration provided. -The queue system is used by Vela for pulling workloads, provided by the [server](/docs/installation/server/), that will be run. +The queue system is used by Vela for pulling workloads, provided by the [server](/docs/installation/server/server.md), that will be run. Workloads fetched from the queue are managed with a [first in, first out (FIFO)](https://en.wikipedia.org/wiki/FIFO_(computing_and_electronics)) strategy. @@ -23,7 +23,7 @@ The following options are used to configure the component: | `queue.routes` | unique channels or topics for pulling workloads | `true` | `[ vela ]` | `QUEUE_ROUTES`\`VELA_QUEUE_ROUTES` | :::note -For more information on these configuration options, please see the [worker reference](/docs/installation/worker/reference/). +For more information on these configuration options, please see the [worker reference](/docs/reference/installation/worker/worker.md). ::: ## Drivers diff --git a/docs/reference/installation/worker/runtime.md b/docs/reference/installation/worker/runtime.md index c92be74..20efbba 100644 --- a/docs/reference/installation/worker/runtime.md +++ b/docs/reference/installation/worker/runtime.md @@ -25,7 +25,7 @@ The following options are used to configure the component: | `runtime.volumes` | path to host volumes to mount into resources for the runtime | `false` | `N/A` | `RUNTIME_VOLUMES`\`VELA_RUNTIME_VOLUMES` | :::note -For more information on these configuration options, please see the [worker reference](/docs/installation/worker/reference/). +For more information on these configuration options, please see the [worker reference](/docs/reference/installation/worker/worker.md). ::: ## Drivers diff --git a/docs/reference/installation/worker/worker.md b/docs/reference/installation/worker/worker.md index 188f218..71f370e 100644 --- a/docs/reference/installation/worker/worker.md +++ b/docs/reference/installation/worker/worker.md @@ -1,6 +1,7 @@ --- no_list: true title: "Worker" +sidebar_position: 2 --- ## Components @@ -9,8 +10,8 @@ The worker is made up of several components, responsible for specific tasks, nec | Name | Description | | ---------- | -------------------------------------------------------------------------------------------------------------------------------- | -| `executor` | coordinates with the runtime to manage workload resources and reports results back to the [server](/docs/installation/server/) | -| `queue` | integrates with a queue provider for pulling workloads, provided by the [server](/docs/installation/server/), that will be run | +| `executor` | coordinates with the runtime to manage workload resources and reports results back to the [server](/docs/installation/server/server.md) | +| `queue` | integrates with a queue provider for pulling workloads, provided by the [server](/docs/installation/server/server.md), that will be run | | `runtime` | integrates with a runtime environment for executing workload resources | ## Required @@ -19,7 +20,7 @@ This section contains a list of all variables that must be provided to the worke ### VELA_QUEUE_DRIVER -This configuration variable is used by the [queue component](/docs/installation/worker/reference/queue/) for the worker. +This configuration variable is used by the [queue component](/docs/reference/installation/server/queue.md) for the worker. Examples using this configuration variable are provided in the above reference documentation. @@ -37,7 +38,7 @@ The possible options to provide for this variable are: ### VELA_SERVER_ADDR -This variable sets a fully qualified URL to the Vela [server](/docs/installation/server/) address. +This variable sets a fully qualified URL to the Vela [server](/docs/installation/server/server.md) address. The variable should be provided as a `string`. @@ -47,7 +48,7 @@ This variable should match [the `VELA_ADDR` variable](/docs/installation/server/ ### VELA_WORKER_ADDR -This variable sets a fully qualified URL to the Vela [worker](/docs/installation/worker/) address. +This variable sets a fully qualified URL to the Vela [worker](/docs/installation/worker/worker.md) address. The variable should be provided as a `string`. @@ -89,19 +90,19 @@ This variable has a default value of `30m`. ### VELA_CHECK_IN -This variable sets the maximum duration of time a worker will wait before registering with the Vela [server](/docs/installation/server/). +This variable sets the maximum duration of time a worker will wait before registering with the Vela [server](/docs/installation/server/server.md). The variable can be provided as a `duration` (i.e. `5s`, `10m`). :::note This variable has a default value of `15m`.\ \ -The value should coordinate with the [`VELA_WORKER_ACTIVE_INTERVAL`](/docs/installation/server/reference/#vela_worker_active_interval) setting provided to the [server](/docs/installation/server/). +The value should coordinate with the [`VELA_WORKER_ACTIVE_INTERVAL`](/docs/installation/server/reference/#vela_worker_active_interval) setting provided to the [server](/docs/installation/server/server.md). ::: ### VELA_EXECUTOR_DRIVER -This configuration variable is used by the [executor component](/docs/installation/worker/reference/executor/) for the worker. +This configuration variable is used by the [executor component](/docs/reference/installation/worker/executor.md) for the worker. Examples using this configuration variable are provided in the above reference documentation. @@ -120,7 +121,7 @@ The possible options to provide for this variable are: ### VELA_EXECUTOR_MAX_LOG_SIZE -This configuration variable is used by the [executor component](/docs/installation/worker/reference/executor/) for the worker. +This configuration variable is used by the [executor component](/docs/reference/installation/worker/executor.md) for the worker. This variable sets the maximum number of bytes for logs allowed to be uploaded per step. @@ -132,7 +133,7 @@ This variable has a default value of `0`. No limit. ### VELA_EXECUTOR_ENFORCE_TRUSTED_REPOS -This configuration variable is used by the [executor component](/docs/installation/worker/reference/executor/) for the worker. +This configuration variable is used by the [executor component](/docs/reference/installation/worker/executor.md) for the worker. This variable sets whether or not the executor will verify a repository is `trusted` before executing a build that contains privileged images (see [runtime privileged images](/docs/installation/worker/reference/#vela_runtime_privileged_images)). @@ -144,7 +145,7 @@ This variable has a default value of `true`. ### VELA_QUEUE_CLUSTER -This configuration variable is used by the [queue component](/docs/installation/worker/reference/queue/) for the worker. +This configuration variable is used by the [queue component](/docs/reference/installation/server/queue.md) for the worker. This variable enables the worker to connect to a queue cluster rather than a standalone instance. @@ -156,7 +157,7 @@ This variable should match [the `VELA_QUEUE_CLUSTER` variable](/docs/installatio ### VELA_QUEUE_POP_TIMEOUT -This configuration variable is used by the [queue component](/docs/installation/worker/reference/queue/) for the worker. +This configuration variable is used by the [queue component](/docs/reference/installation/server/queue.md) for the worker. This variable sets the maximum duration of time the worker will wait before timing out requests sent for pulling workloads. @@ -168,7 +169,7 @@ This variable has a default value of `60s`. ### VELA_QUEUE_ROUTES -This configuration variable is used by the [queue component](/docs/installation/worker/reference/queue/) for the worker. +This configuration variable is used by the [queue component](/docs/reference/installation/server/queue.md) for the worker. This variable sets the unique channels or topics to pull workloads from. @@ -182,7 +183,7 @@ This variable has a default value of `vela`. ### VELA_RUNTIME_CONFIG -This configuration variable is used by the [runtime component](/docs/installation/worker/reference/runtime/) for the worker. +This configuration variable is used by the [runtime component](/docs/reference/installation/worker/runtime.md) for the worker. Examples using this configuration variable are provided in the above reference documentation. @@ -192,7 +193,7 @@ The variable can be provided as a `string`. ### VELA_RUNTIME_DRIVER -This configuration variable is used by the [runtime component](/docs/installation/worker/reference/runtime/) for the worker. +This configuration variable is used by the [runtime component](/docs/reference/installation/worker/runtime.md) for the worker. Examples using this configuration variable are provided in the above reference documentation. @@ -211,7 +212,7 @@ The possible options to provide for this variable are: ### VELA_RUNTIME_NAMESPACE -This configuration variable is used by the [runtime component](/docs/installation/worker/reference/runtime/) for the worker. +This configuration variable is used by the [runtime component](/docs/reference/installation/worker/runtime.md) for the worker. Examples using this configuration variable are provided in the above reference documentation. @@ -221,9 +222,9 @@ The variable can be provided as a `string`. ### VELA_RUNTIME_PODS_TEMPLATE_NAME -This configuration variable is used by the [runtime component](/docs/installation/worker/reference/runtime/) for the worker. +This configuration variable is used by the [runtime component](/docs/reference/installation/worker/runtime.md) for the worker. -Examples using this configuration variable are provided in the [kubernetes runtime documentation](/docs/installation/worker/kubernetes/). +Examples using this configuration variable are provided in the [kubernetes runtime documentation](/docs/installation/worker/kubernetes.md). This variable sets a `PipelinePodsTemplate` name (for Kubernetes only) to use for runtime workloads. The named template must be in the `VELA_RUNTIME_NAMESPACE`. @@ -232,12 +233,12 @@ The variable can be provided as a `string`. ### VELA_RUNTIME_PODS_TEMPLATE_FILE -This configuration variable is used by the [runtime component](/docs/installation/worker/reference/runtime/) for the worker. +This configuration variable is used by the [runtime component](/docs/reference/installation/worker/runtime.md) for the worker. This variable sets the path to a `PipelinePodsTemplate` YAML file (for Kubernetes only) to use for runtime workloads. This file is only used if `VELA_RUNTIME_PODS_TEMPLATE_NAME` is empty. -An example file is provided in the [kubernetes runtime documentation](/docs/installation/worker/kubernetes/). +An example file is provided in the [kubernetes runtime documentation](/docs/installation/worker/kubernetes.md). This is useful for Kubernetes clusters that do not allow loading CRDs. It is also used for testing Vela. @@ -245,7 +246,7 @@ The variable can be provided as a `string`. ### VELA_RUNTIME_PRIVILEGED_IMAGES -This configuration variable is used by the [runtime component](/docs/installation/worker/reference/runtime/) for the worker. +This configuration variable is used by the [runtime component](/docs/reference/installation/worker/runtime.md) for the worker. This variable sets the [Docker image(s)](https://docs.docker.com/get-started/overview/#images) that are allowed to have privileged access on the worker. @@ -257,7 +258,7 @@ Please use with caution. This setting essentially grants any defined image root ### VELA_RUNTIME_DROP_CAPABILITIES -This configuration variable is used by the [runtime component](/docs/installation/worker/reference/runtime/) for the worker. +This configuration variable is used by the [runtime component](/docs/reference/installation/worker/runtime.md) for the worker. This variable leverages the [`--cap-drop` Docker run flag](https://docs.docker.com/engine/reference/run/#runtime-privilege-and-linux-capabilities) to disable certain kernel capabilities given to the container by default. @@ -265,7 +266,7 @@ This variable can be provided as a comma-separated `list` (e.g. `CAP_CHOWN,CAP_D ### VELA_RUNTIME_VOLUMES -This configuration variable is used by the [runtime component](/docs/installation/worker/reference/runtime/) for the worker. +This configuration variable is used by the [runtime component](/docs/reference/installation/worker/runtime.md) for the worker. This variable sets the fully qualified system path(s) to file(s) on the host machine that will be mounted into workloads executed on that worker. diff --git a/docs/reference/yaml/secrets.md b/docs/reference/yaml/secrets.md index 709702d..1e7652d 100644 --- a/docs/reference/yaml/secrets.md +++ b/docs/reference/yaml/secrets.md @@ -131,7 +131,7 @@ secrets: ``` :::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 +is not currently available for the [Kubernetes-based workers](/docs/installation/worker/kubernetes.md) and does not work with secrets originating from plugins loaded via [`origin:`](/docs/reference/yaml/secrets/#the-pull-key) (see below). ::: diff --git a/docs/reference/yaml/worker.md b/docs/reference/yaml/worker.md index 6e50fe7..45072fb 100644 --- a/docs/reference/yaml/worker.md +++ b/docs/reference/yaml/worker.md @@ -31,7 +31,7 @@ Routes are defined by the Vela system administrators during installation. To kno ### Usage :::tip -See an [example](/docs/usage/examples/route/) on how to route a build. +See an [example](/docs/usage/examples/route.md) on how to route a build. ::: #### The `flavor:` key diff --git a/docs/reference/yaml/yaml.md b/docs/reference/yaml/yaml.md index 199c9fc..74615ba 100644 --- a/docs/reference/yaml/yaml.md +++ b/docs/reference/yaml/yaml.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: :::tip -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/json-schema-support.md). ::: ### Document diff --git a/docs/usage/authenticate.md b/docs/usage/authenticate.md index 2b5f2ff..50ffcb4 100644 --- a/docs/usage/authenticate.md +++ b/docs/usage/authenticate.md @@ -12,14 +12,14 @@ Navigate to your deployed instance and follow the OAuth workflow presented on th ## CLI -Please see authentication in the [CLI reference](/docs/reference/cli/authentication/). +Please see authentication in the [CLI reference](/docs/reference/cli/authentication.md). _If you have not yet installed the CLI, see [CLI install reference](/docs/reference/cli/install.md) first._ ## API -Please see authentication in the [API reference](/docs/reference/api/authentication/). +Please see authentication in the [API reference](/docs/reference/api/authentication.md). ## SDK -Please see authentication in the [sdk reference](/docs/reference/sdk/go/). +Please see authentication in the [sdk reference](/docs/reference/sdk/go.md). diff --git a/docs/usage/docker.md b/docs/usage/docker.md index 19f1797..1659688 100644 --- a/docs/usage/docker.md +++ b/docs/usage/docker.md @@ -18,7 +18,7 @@ Both options have disadvantages and advantages, so we encourage all Vela adminis Building an image without elevated access gives administrators the most secure pattern for not allowing any elevated access to the workers within the cluster. There are two plugin options for building those images: -* [vela-kaniko](/docs/plugins/registry/pipeline/kaniko/) +* [vela-kaniko](None) We recommend customers read the [tool comparisons](/docs/usage/docker/#additional-resources) before picking a technology for building their images. In-depth examples for building with either utility are available within their respective plugin documentation pages. A simple example is provided below: @@ -37,7 +37,7 @@ steps: Building an image with elevated access is a allowed pattern as long as the administrators have set the required allow list of images on the worker. It's *important to work with your administrator* to understand stand which pattern you instances was deployed to support. The supported plugin for building those images: -* [vela-docker](/docs/plugins/registry/pipeline/docker/) +* [vela-docker](None) ```yaml version: "1" diff --git a/docs/usage/enable_repo.md b/docs/usage/enable_repo.md index 6445519..ccfa3ad 100644 --- a/docs/usage/enable_repo.md +++ b/docs/usage/enable_repo.md @@ -9,7 +9,7 @@ to the repo. ### Via the UI -For this example, we'll go over using the UI to add the repo. You can always head over to the [CLI docs](/docs/reference/cli/repo/add/) for docs on how to add a repo via CLI. +For this example, we'll go over using the UI to add the repo. You can always head over to the [CLI docs](/docs/reference/cli/repo/add.md) for docs on how to add a repo via CLI. 1. Log into your Vela instance. 1. Click "Add Repositories". @@ -21,5 +21,5 @@ For this example, we'll go over using the UI to add the repo. You can always hea Your repo now has the necessary web hook to Vela. :::tip -If you're coming from another CI platform you can set a starting build number by updating the counter field on the repo via the UI, [CLI](/docs/reference/cli/repo/), or [API](/docs/reference/api/repo/). +If you're coming from another CI platform you can set a starting build number by updating the counter field on the repo via the UI, [CLI](/docs/reference/cli/repo/repo.md), or [API](/docs/reference/api/repo/repo.md). ::: diff --git a/docs/usage/examples/_category_.json b/docs/usage/examples/_category_.json index 37ad9f3..c543bc0 100644 --- a/docs/usage/examples/_category_.json +++ b/docs/usage/examples/_category_.json @@ -1,6 +1,6 @@ { "label": "Examples", - "position": 2, + "position": 3, "link": { "type": "generated-index" } diff --git a/docs/usage/examples/file_list.txt b/docs/usage/examples/file_list.txt deleted file mode 100644 index 7131b53..0000000 --- a/docs/usage/examples/file_list.txt +++ /dev/null @@ -1,13 +0,0 @@ -_index.md -file_list.txt -go_modules.md -java_gradle.md -java_maven.md -mongo.md -node.md -postgres.md -redis.md -route.md -rust_cargo.md -secrets_external.md -secrets_internal.md diff --git a/docs/usage/examples/go_modules.md b/docs/usage/examples/go_modules.md index cf1327d..08e4de1 100644 --- a/docs/usage/examples/go_modules.md +++ b/docs/usage/examples/go_modules.md @@ -14,7 +14,7 @@ User is looking to create a pipeline that builds an artifact on any event or bra ### Steps -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Steps](/docs/tour/steps/) * [image](/docs/tour/image/) @@ -62,7 +62,7 @@ steps: ### Stages -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Stages](/docs/tour/stages/) * [Needs](/docs/tour/stages/) diff --git a/docs/usage/examples/java_gradle.md b/docs/usage/examples/java_gradle.md index 1af1c3c..64abffa 100644 --- a/docs/usage/examples/java_gradle.md +++ b/docs/usage/examples/java_gradle.md @@ -14,7 +14,7 @@ User is looking to create a pipeline that builds an artifact on any event or bra ### Steps -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Steps](/docs/tour/steps/) * [image](/docs/tour/image/) diff --git a/docs/usage/examples/java_maven.md b/docs/usage/examples/java_maven.md index 84e5d60..f2a047b 100644 --- a/docs/usage/examples/java_maven.md +++ b/docs/usage/examples/java_maven.md @@ -14,7 +14,7 @@ User is looking to create a pipeline that builds an artifact on any event or bra ### Steps -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Steps](/docs/tour/steps/) * [image](/docs/tour/image/) diff --git a/docs/usage/examples/mongo.md b/docs/usage/examples/mongo.md index acba050..5b1c935 100644 --- a/docs/usage/examples/mongo.md +++ b/docs/usage/examples/mongo.md @@ -16,7 +16,7 @@ User is looking to create a pipeline that can integrate with an ephemeral Mongo Services Yaml block can be used with stages and steps pipelines. This example uses a basic steps configuration. -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Services](/docs/tour/services/) * [Image](/docs/tour/image/) @@ -52,7 +52,7 @@ steps: If you're looking for more granular start time for the container you can add a detach flag within stages and steps pipelines. -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Steps](/docs/tour/steps/) * [Image](/docs/tour/image/) diff --git a/docs/usage/examples/node.md b/docs/usage/examples/node.md index d016d56..97eb51a 100644 --- a/docs/usage/examples/node.md +++ b/docs/usage/examples/node.md @@ -14,7 +14,7 @@ User is looking to create a pipeline that builds an artifact on any event or bra ### Steps -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Steps](/docs/tour/steps/) * [image](/docs/tour/image/) @@ -52,7 +52,7 @@ steps: ### Stages -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Stages](/docs/tour/stages/) * [Needs](/docs/tour/stages/) diff --git a/docs/usage/examples/postgres.md b/docs/usage/examples/postgres.md index 331f927..80d2e2a 100644 --- a/docs/usage/examples/postgres.md +++ b/docs/usage/examples/postgres.md @@ -16,7 +16,7 @@ User is looking to create a pipeline that can integrate with an ephemeral Postgr Services Yaml block can be used with stages and steps pipelines. This example uses a basic steps configuration. -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Services](/docs/tour/services/) * [Image](/docs/tour/image/) @@ -58,7 +58,7 @@ steps: If you're looking for more granular start time for the container you can add a detach flag within stages and steps pipelines. -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Steps](/docs/tour/steps/) * [Image](/docs/tour/image/) diff --git a/docs/usage/examples/redis.md b/docs/usage/examples/redis.md index 7b1e4c4..f805fbc 100644 --- a/docs/usage/examples/redis.md +++ b/docs/usage/examples/redis.md @@ -16,7 +16,7 @@ User is looking to create a pipeline that can integrate with an ephemeral Redis Services Yaml block can be used with stages and steps pipelines. This example uses a basic steps configuration. -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Services](/docs/tour/services/) * [Image](/docs/tour/image/) @@ -52,7 +52,7 @@ steps: If you're looking for more granular start time for the container you can add a detach flag within stages and steps pipelines. -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Steps](/docs/tour/steps/) * [image](/docs/tour/image/) diff --git a/docs/usage/examples/route.md b/docs/usage/examples/route.md index a85851a..1d6defb 100644 --- a/docs/usage/examples/route.md +++ b/docs/usage/examples/route.md @@ -18,7 +18,7 @@ Work with your server administer to understand what routes are available for you ### Steps -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * *Worker* * *Platform* @@ -49,7 +49,7 @@ steps: ### Stages -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * *Worker* * *Platform* diff --git a/docs/usage/examples/rust_cargo.md b/docs/usage/examples/rust_cargo.md index 20115c2..c15bfc4 100644 --- a/docs/usage/examples/rust_cargo.md +++ b/docs/usage/examples/rust_cargo.md @@ -14,7 +14,7 @@ User is looking to create a pipeline that builds an artifact on any event or bra ### Steps -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Steps](/docs/tour/steps/) * [image](/docs/tour/image/) @@ -58,7 +58,7 @@ steps: ### Stages -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Stages](/docs/tour/stages/) * [Needs](/docs/tour/stages/) diff --git a/docs/usage/examples/secrets_external.md b/docs/usage/examples/secrets_external.md index b1b6ab8..6c52864 100644 --- a/docs/usage/examples/secrets_external.md +++ b/docs/usage/examples/secrets_external.md @@ -13,14 +13,14 @@ Example [Yaml](https://yaml.org/spec/) configuration for a project requiring a s User is looking to create a pipeline that can integrate with a private Vault to inject secrets that can not be used with pushing a Docker image to a registry. :::tip -It is assumed you have created secret `vault_token` in the web interface or [CLI](/docs/reference/cli/). +It is assumed you have created secret `vault_token` in the web interface or [CLI](None). ::: The examples show a pipeline using repository secrets. Vela contains three secret types: repository, organization, and shared. For examples on organization and shared, please see the [secret concepts](/docs/tour/secrets/) documentation. ### Steps -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Steps](/docs/tour/steps/) * [Image](/docs/tour/image/) @@ -29,9 +29,9 @@ The following [pipeline concepts](/docs/tour/) are being used in the pipeline be * [Parameters](/docs/tour/plugins/) * [Secrets](/docs/tour/secrets/) -The following [Vela plugins](/docs/tour/) are being used in the pipeline below: +The following [Vela plugins](None) are being used in the pipeline below: -* [Docker](/docs/plugins/registry/pipeline/docker/) +* [Docker](None) :::tip Pipeline must be stored in base of repository as `.vela.yml` or `.vela.yaml` @@ -86,9 +86,9 @@ The following [pipeline concepts](/docs/tour) are being used in the pipeline bel * [Parameters](/docs/tour/plugins/) * [Secrets](/docs/tour/secrets/) -The following [Vela plugins](/docs/tour/) are being used in the pipeline below: +The following [Vela plugins](None) are being used in the pipeline below: -* [Docker](/docs/plugins/registry/pipeline/docker/) +* [Docker](None) :::tip Pipeline must be stored in base of repository as `.vela.yml` or `.vela.yaml` diff --git a/docs/usage/examples/secrets_internal.md b/docs/usage/examples/secrets_internal.md index 7314a63..ecc12f4 100644 --- a/docs/usage/examples/secrets_internal.md +++ b/docs/usage/examples/secrets_internal.md @@ -13,7 +13,7 @@ Example [Yaml](https://yaml.org/spec/) configuration for a project requiring a s User is looking to create a pipeline that can inject configuration that can not be placed into a Yaml file. A simple example would be producing a Docker image with username and password. :::tip -It is assumed you have created secrets `docker_username` and `docker_password` in the web interface or [CLI](/docs/reference/cli/). +It is assumed you have created secrets `docker_username` and `docker_password` in the web interface or [CLI](None). ::: :::warning @@ -24,7 +24,7 @@ The examples show a pipeline using repo secrets. Vela contains three secret type ### Steps -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Steps](/docs/tour/steps/) * [Image](/docs/tour/image/) @@ -33,9 +33,9 @@ The following [pipeline concepts](/docs/tour/) are being used in the pipeline be * [Parameters](/docs/tour/plugins/) * [Secrets](/docs/tour/secrets/) -The following [Vela plugins](/docs/tour/) are being used in the pipeline below: +The following [Vela plugins](None) are being used in the pipeline below: -* [Docker](/docs/plugins/registry/pipeline/docker/) +* [Docker](None) :::tip Pipeline must be stored in base of repository as `.vela.yml` or `.vela.yaml` @@ -70,7 +70,7 @@ secrets: ### Stages -The following [pipeline concepts](/docs/tour/) are being used in the pipeline below: +The following [pipeline concepts](None) are being used in the pipeline below: * [Stages](/docs/tour/stages/) * [Steps](/docs/tour/steps/) @@ -80,9 +80,9 @@ The following [pipeline concepts](/docs/tour/) are being used in the pipeline be * [Parameters](/docs/tour/plugins/) * [Secrets](/docs/tour/secrets/) -The following [Vela plugins](/docs/tour/) are being used in the pipeline below: +The following [Vela plugins](None) are being used in the pipeline below: -* [Docker](/docs/plugins/registry/pipeline/docker/) +* [Docker](None) :::tip Pipeline must be stored in base of repository as `.vela.yml` or `.vela.yaml` diff --git a/docs/usage/plugin.md b/docs/usage/plugin.md index b3a3c0f..d949eec 100644 --- a/docs/usage/plugin.md +++ b/docs/usage/plugin.md @@ -8,8 +8,8 @@ description: > :::note The following plugins are used within the example -* [Kaniko](/docs/plugins/registry/pipeline/kaniko/) -* [Vault](/docs/plugins/registry/secret/vault/) +* [Kaniko](None) +* [Vault](None) ::: Typically, plugins are configured as a step in a pipeline and should accept their configuration via environment variables. The below example shows a pipeline and secret plugin working together to publish an image to a registry: diff --git a/docs/usage/plugins/index.md b/docs/usage/plugins/index.md index 9374264..91c1728 100644 --- a/docs/usage/plugins/index.md +++ b/docs/usage/plugins/index.md @@ -1,6 +1,6 @@ --- title: "Plugins" -sidebar_position: 2 +sidebar_position: 4 --- Vela contains two plugin types: diff --git a/docs/usage/quickstart.md b/docs/usage/quickstart.md index 017c187..d61cb29 100644 --- a/docs/usage/quickstart.md +++ b/docs/usage/quickstart.md @@ -23,7 +23,7 @@ For this example, we'll go over using the UI to add the repo. You can always hea Your repo now has the necessary web hook to Vela. :::info -If you're coming from another CI platform you can set a starting build number by updating the counter field on the repo via the UI, [CLI](/docs/reference/cli/repo/), or [API](/docs/reference/api/repo/). +If you're coming from another CI platform you can set a starting build number by updating the counter field on the repo via the UI, [CLI](/docs/reference/cli/repo/repo.md), or [API](/docs/reference/api/repo/repo.md). ::: ## Step 2 - Build a Pipeline @@ -51,11 +51,11 @@ steps: ``` **See it in action with examples!** -* [Go](/docs/usage/examples/go_modules/) -* [Rust](/docs/usage/examples/rust_cargo/) -* [Gradle](/docs/usage/examples/java_gradle/) -* [Maven](/docs/usage/examples/java_maven/) -* [Node](/docs/usage/examples/node/) +* [Go](/docs/usage/examples/go_modules.md) +* [Rust](/docs/usage/examples/rust_cargo.md) +* [Gradle](/docs/usage/examples/java_gradle.md) +* [Maven](/docs/usage/examples/java_maven.md) +* [Node](/docs/usage/examples/node.md) ## Step 3 - Customize the Pipeline with Rulesets @@ -99,13 +99,13 @@ These actions can be for any number of general tasks, deploying code, publishing Anyone can create a plugin and use it in their pipeline. -The registry of existing plugins can be found on this site in the [plugins](/docs/plugins/registry/) tab. +The registry of existing plugins can be found on this site in the [plugins](docs/usage/plugins/index.md) tab. Within the parameters block, keys are injected as upper case environment variables with the pattern of `PARAMETER_`. **Expand your knowledge with an example!** -* [Working with Plugins](/docs/usage/plugin/) +* [Working with Plugins](/docs/usage/plugin.md) @@ -131,7 +131,7 @@ steps: ``` ## Step 5 - Trigger the Pipeline -If you've followed the documentation for [enabling a repo](/docs/usage/enable_repo/) and wrote a pipeline ([here are some example pipelines](/docs/usage/examples/)), all that should be left is to push your pipeline to your repo. +If you've followed the documentation for [enabling a repo](/docs/usage/enable_repo.md) and wrote a pipeline ([here are some example pipelines](None)), all that should be left is to push your pipeline to your repo. If a build does not trigger when your push a change to your repo, check the webhook response to see if there is an error. diff --git a/docs/usage/repo_settings.md b/docs/usage/repo_settings.md index 4ea187b..8927905 100644 --- a/docs/usage/repo_settings.md +++ b/docs/usage/repo_settings.md @@ -9,7 +9,7 @@ description: > Before going through all the Vela repository settings, it's important to cover Vela permissions and how they apply to various parts of the Vela application. -An overview of permissions can be found [here](/docs/usage/roles/). +An overview of permissions can be found [here](/docs/usage/roles.md). ## General Repository Settings @@ -89,11 +89,11 @@ Occasionally, due to various compilation errors, this counter can fall behind re ### Status Badge -Check out the [usage documentation](/docs/usage/badge/) for more details on customizing status badges for Vela repositories. +Check out the [usage documentation](/docs/usage/badge.md) for more details on customizing status badges for Vela repositories. ### Repository Actions -**Chown** — every Vela repository requires an owner. This owner is typically the user that first enabled the repository. The owner must have _write_ permissions for the repository at the minimum. The "Chown" button (or [command](/docs/reference/cli/repo/chown/)) will transfer the ownership to the user making the request. +**Chown** — every Vela repository requires an owner. This owner is typically the user that first enabled the repository. The owner must have _write_ permissions for the repository at the minimum. The "Chown" button (or [command](/docs/reference/cli/repo/chown.md)) will transfer the ownership to the user making the request. **Repair** — whenever the connection between Vela and the webhook configured with the source control manager has been invalidated, the Vela repository must be repaired. This involves the deletion and re-creation of the webhook with the source repository. The build history will be preserved, but the ability to redeliver old webhooks will not. @@ -103,9 +103,9 @@ The following are the options for the formatting of the base pipeline: | Type | Description | |-------------|---------------------------------------------------------------------------------------------------------| -| `YAML` | Default pipeline syntax ([Reference Documentation](/docs/reference/yaml/)) | +| `YAML` | Default pipeline syntax ([Reference Documentation](/docs/reference/yaml/yaml.md)) | | `Go` | Standard YAML with Go inline functionality ([Reference Documentation](/docs/templates/tutorials/go/)) | -| `Starlark` | YAML generation using Starlark ([Reference Documentation](/docs/templates/tutorials/starlark/)) | +| `Starlark` | YAML generation using Starlark ([Reference Documentation](None)) | Note: by default, templates are treated with `Go` syntax. In order to match that behavior for the base pipeline, this setting must be changed to `Go`. diff --git a/docs/usage/schedule_build.md b/docs/usage/schedule_build.md index 83e3245..fad3f92 100644 --- a/docs/usage/schedule_build.md +++ b/docs/usage/schedule_build.md @@ -13,7 +13,7 @@ Vela supports the ability to periodically trigger builds for a repo known as a " Outside of the Vela ecosystem, this is more commonly known as a [cron expression](https://en.wikipedia.org/wiki/Cron). -Users will be able to manage schedules for a repo via the UI, [API](/docs/reference/api/schedule/) and [CLI](/docs/reference/cli/schedule/). +Users will be able to manage schedules for a repo via the UI, [API](/docs/reference/api/schedule/schedule.md) and [CLI](/docs/reference/cli/schedule/schedule.md). Only users with `admin` access to a repo will be able to manage schedules for that repo. diff --git a/docs/usage/secrets.md b/docs/usage/secrets.md index 7611837..ad0d7f6 100644 --- a/docs/usage/secrets.md +++ b/docs/usage/secrets.md @@ -5,16 +5,16 @@ description: > Learn about internal Vela secrets. --- -This page will primarily focus on `internal secrets`. If you would like to learn more about `external secrets`, check out the [external secrets examples page](/docs/usage/examples/secrets_external/). For a broader view of secrets and how to use `internal` or `external` secrets in your pipeline, check out the [secrets tour page](/docs/tour/secrets/). +This page will primarily focus on `internal secrets`. If you would like to learn more about `external secrets`, check out the [external secrets examples page](/docs/usage/examples/secrets_external.md). For a broader view of secrets and how to use `internal` or `external` secrets in your pipeline, check out the [secrets tour page](/docs/tour/secrets/). :::warning Internal secrets do NOT have the `pull_request` event enabled by default. This is intentional to help mitigate exposure via a pull request against the repo. You can override this behavior, at your own risk, for each secret. ::: ## Internal Secrets -Internal secrets are generally managed via the UI or the [CLI](/docs/reference/cli/secret/). They can also be managed via the [API](/docs/reference/api/secret/). +Internal secrets are generally managed via the UI or the [CLI](/docs/reference/cli/secret/secret.md). They can also be managed via the [API](/docs/reference/api/secret/secret.md). -A full pipeline example is available [here](/docs/usage/examples/secrets_internal/) +A full pipeline example is available [here](/docs/usage/examples/secrets_internal.md) _Example pipeline yaml block for internal secrets_ diff --git a/docs/usage/start_build.md b/docs/usage/start_build.md index eb5582f..f1eb4f0 100644 --- a/docs/usage/start_build.md +++ b/docs/usage/start_build.md @@ -5,6 +5,6 @@ description: > Start a build for the first time. --- -If you've followed the documentation for [enabling a repo](/docs/usage/enable_repo/) and wrote a pipeline ([here are some example pipelines](/docs/usage/examples/)), all that should be left is to push your pipeline to your repo. +If you've followed the documentation for [enabling a repo](/docs/usage/enable_repo.md) and wrote a pipeline ([here are some example pipelines](None)), all that should be left is to push your pipeline to your repo. If a build does not trigger when your push a change to your repo, check the webhook response to see if there is an error. diff --git a/docs/usage/templates/go/functions.md b/docs/usage/templates/go/functions.md index 99675f5..ed7e29c 100644 --- a/docs/usage/templates/go/functions.md +++ b/docs/usage/templates/go/functions.md @@ -93,5 +93,5 @@ steps: #### vela -The `vela` function provides the convenience of accessing [Vela environment variables](/docs/reference/environment/variables/) within your Vela templates. See its dedicated [platform vars page](/docs/templates/tutorials/go/vars_platform/) for more info. +The `vela` function provides the convenience of accessing [Vela environment variables](/docs/reference/environment/variables.md) within your Vela templates. See its dedicated [platform vars page](/docs/templates/tutorials/go/vars_platform/) for more info. diff --git a/docs/usage/templates/templates.md b/docs/usage/templates/templates.md index 6ceda43..d557c7f 100644 --- a/docs/usage/templates/templates.md +++ b/docs/usage/templates/templates.md @@ -13,7 +13,7 @@ Stages can only be utilized within a template if you use the [`render_inline: tr ## Reference documentation -Check out the [YAML reference documentation](/docs/reference/yaml/templates/) for templates. +Check out the [YAML reference documentation](/docs/reference/yaml/templates.md) for templates. ## Template Engines @@ -415,7 +415,7 @@ Note: when using nested templates with `render_inline: true`, all templates that # Working with Templates :::warning -It is highly recommended before reviewing the below content to have a solid grasp on Vela's core concepts that are explored while taking the [Vela Tour](/docs/tour/)). +It is highly recommended before reviewing the below content to have a solid grasp on Vela's core concepts that are explored while taking the [Vela Tour](None)). ::: When writing a new template getting feedback can be a very painful process. Vela provides a few core methods to get feedback quickly to ensure the template you're writing expands in the pipeline you expect to run. The main methods for seeing expanded pipelines are: diff --git a/docs/usage/tour/cloning.md b/docs/usage/tour/cloning.md new file mode 100644 index 0000000..d61f94a --- /dev/null +++ b/docs/usage/tour/cloning.md @@ -0,0 +1,59 @@ +--- +title: "Cloning" +linkTitle: "Cloning" +weight: 6 +description: > + Learn about cloning. +--- + +Vela will clone your repository automatically before executing the pipeline. + +Vela injects the clone credentials that are the oauth2 token associated with the repository to authenticate. + +However, sometimes you may need to customize, override or disable the default clone behavior. + +**Expand your knowledge with an example!** + +* [Understanding the workspace](/docs/usage/workspace/) + + + +```yaml +# Below is displaying the default behavior that occurs in a pipeline. +metadata: + clone: true + +steps: + # Since the default behavior is to clone, we can instantly access + # files in our repository. + - name: view pipeline file + image: alpine + commands: + - cat .vela.yml +``` + +```yaml +# Below is displaying how to turn off the clone behavior. +metadata: + clone: false + +steps: + # Now that the clone is turned off; you can use any Docker + # image with git installed to manually clone the repo + # with any clone specific settings for the repository. + - name: clone + image: target/vela-git + parameters: + path: hello-world + ref: refs/heads/main + remote: https://github.com/octocat/hello-world.git + sha: 7fd1a60b01f91b314f59955a4e4d4e80d8edf11d + +``` + + + +**Key references:** + +[`clone:`](/docs/reference/yaml/metadata/#the-clone-key), [`name:`](/docs/reference/yaml/steps/#the-name-key), [`image:`](/docs/reference/yaml/steps/#the-image-key), [`parameters:`](/docs/reference/yaml/steps/#the-parameters-key), + diff --git a/docs/usage/tour/environment.md b/docs/usage/tour/environment.md new file mode 100644 index 0000000..6cb7ab1 --- /dev/null +++ b/docs/usage/tour/environment.md @@ -0,0 +1,62 @@ +--- +title: "Environment" +--- + + +To define environment variables you can add an `environment:` YAML key. Environment variables can be scoped to be global, within a stage, or within a step. + +All platform variables get injected with a custom `VELA_` prefix pattern. + +The global environment encompasses all stages, steps, and services within the pipeline. + +Every stage's environment is isolated to each individual stage and its steps. A stage environment variable will overwrite a global environment variable of the same name. + +Every step's environment is isolated to each individual step. A step environment variable will overwrite a global or stage environment variable of the same name. + +Vela does import a library to provide partial string operations. You can use the functions to manipulate string values prior to substitution. + +With this substitution you should be aware `${variable}` expressions are subject to pre-processing. If you want to avoid this behavior you can escape your expressions to avoid the pre-processor evaluations. + +**Expand your knowledge with an example!** + +* [Using the environment](/docs/usage/environment/) + + + +```yaml +version: "1" + +environment: + GLOBAL_ENV: Global Environment +stages: + hello: + environment: + HELLO_MESSAGE: Hello, World! + steps: + - name: Vela Platform ENV + image: alpine + commands: + - echo ${VELA_REPO_FULL_NAME} + + - name: Custom User ENV + image: alpine + commands: + - echo ${HELLO_MESSAGE} + goodbye: + steps: + - name: String Operation + image: alpine + environment: + goodbye_message: Goodbye, World! + commands: + # This ":0:8" shorthand will cut the value of the commit + # down to just the first 0 through 8 characters of the sha. + - echo ${VELA_BUILD_COMMIT:0:8} + - echo ${goodbye_message} +``` + + + +**Key references:** + +[`name:`](/docs/reference/yaml/steps/#the-name-key), [`image:`](/docs/reference/yaml/steps/#the-image-key), [`environment:`](/docs/reference/yaml/steps/#the-environment-key), [`commands:`](/docs/reference/yaml/steps/#the-commands-key), diff --git a/docs/usage/tour/image.md b/docs/usage/tour/image.md new file mode 100644 index 0000000..5a11aee --- /dev/null +++ b/docs/usage/tour/image.md @@ -0,0 +1,55 @@ +--- +title: "Image" +linkTitle: "Image" +weight: 2 +description: > + Learn about images. +--- +All Vela steps will require an image declaration to be provided. + +The `image:` key is a key component that defines the [Docker Image](https://docs.docker.com/engine/docker-overview/#images) you want to be executed during the step. + +The default behavior is for a Vela worker to pull an image if it is not present on the host. Docker daemon's cache image layers locally, by allowing the default behavior to use the cache you can get the advantage of faster build start up times. + +Sometimes this isn't the desired behavior and you want the image to always be pulled or pulled at a specific point in the pipeline lifecycle. + +That's when you can use the `pull:` key to set the policy for how/when the image pull interaction should be treated. + +**Expand your knowledge with an example!** + +* [Pull policy](/docs/usage/pull_policies/) + + + +```yaml +# All the below syntaxes would pull an image. +image: alpine +image: alpine:latest +image: alpine:3 +image: library/alpine:3 +image: index.docker.io/library/alpine +image: index.docker.io/library/alpine:3 +``` + +```yaml +# This is telling Vela to pull the image at the beginning of the pipeline always. +- name: always pull the image + image: alpine + pull: always + commands: + - echo "Welcome to the Vela docs" + +# This is telling Vela to pull the image just before executing the step +- name: pull the image on start + image: alpine + pull: on_start + commands: + - echo "Welcome to the Vela docs" +``` + + + +**Key references:** + +[`name:`](/docs/reference/yaml/steps/#the-name-key), [`image:`](/docs/reference/yaml/steps/#the-image-key), [`pull:`](/docs/reference/yaml/steps/#the-commands-key), [`commands:`](/docs/reference/yaml/steps/#the-commands-key), + diff --git a/docs/usage/tour/plugins.md b/docs/usage/tour/plugins.md new file mode 100644 index 0000000..9b0c31d --- /dev/null +++ b/docs/usage/tour/plugins.md @@ -0,0 +1,51 @@ +--- +title: "Plugins" +linkTitle: "Plugins" +weight: 5 +description: > + Learn about plugin. +--- + +A plugin is a Docker container that is designed to perform a set of pre-defined actions. + +These actions can be for any number of general tasks, deploying code, publishing artifacts and more. + +Anyone can create a plugin and use it in their pipeline. + +The registry of existing plugins can be found on this site in the [plugins](/docs/plugins/registry/) tab. + +Within the parameters block, keys are injected as upper case environment variables with the pattern of `PARAMETER_`. + +**Expand your knowledge with an example!** + +* [Working with Plugins](/docs/usage/plugin/) + + + +```yaml +steps: + + - name: publish hello world + image: target/vela-kaniko + # Environment variables injected: + # PARAMETER_REGISTRY=index.docker.io + # PARAMETER_REPO=index.docker.io/go-vela/hello-world + # PARAMETER_USERNAME=moby + # PARAMETER_PASSWORD=mypassword + # PARAMETER_TAGS=latest,v1.0.0 + parameters: + registry: index.docker.io + repo: index.docker.io/go-vela/hello-world + username: moby + password: mypassword + tags: + - latest + - v1.0.0 +``` + + + +**Key references:** + +[`name:`](/docs/reference/yaml/steps/#the-name-key), [`image:`](/docs/reference/yaml/steps/#the-image-key), [`parameters:`](/docs/reference/yaml/steps/#the-parameters-key), + diff --git a/docs/usage/tour/rulesets.md b/docs/usage/tour/rulesets.md new file mode 100644 index 0000000..95723ad --- /dev/null +++ b/docs/usage/tour/rulesets.md @@ -0,0 +1,48 @@ +--- +title: "Rulesets" +linkTitle: "Rulesets" +weight: 3 +description: > + Learn about rulesets. +--- + +The ruleset allows you to provide conditions to limit the execution of the container. + +When you push your code to a source control management system a payload is sent to Vela. + +Within that payload contains characteristics about what just happened. Maybe it was a push to the main branch, feature branch or tag on any specific commit. + +The ruleset key gives you the ability to add conditions on the step to tell Vela when this step should be executed. + + + +```yaml +- name: Welcome + # This ruleset would scope the step to only executing + # under the conditions a push to the main branch occurred + ruleset: + event: push + branch: main + image: alpine + commands: + - echo "Welcome to the Vela docs" +``` + +```yaml +- name: Welcome + # This ruleset would scope the step to never executing + # under the conditions a push to the main branch occurred + ruleset: + unless: + event: push + branch: main + image: alpine + commands: + - echo "Welcome to the Vela docs" +``` + + + +**Key references:** + +[`name:`](/docs/reference/yaml/steps/#the-name-key), [`ruleset:`](/docs/reference/yaml/steps/#the-ruleset-key),[`image:`](/docs/reference/yaml/steps/#the-image-key), [`commands:`](/docs/reference/yaml/steps/#the-commands-key), diff --git a/docs/usage/tour/secrets.md b/docs/usage/tour/secrets.md new file mode 100644 index 0000000..22eea28 --- /dev/null +++ b/docs/usage/tour/secrets.md @@ -0,0 +1,76 @@ +--- +title: "Secrets" +linkTitle: "Secrets" +weight: 7 +description: > + Learn about secrets. +--- + +Sometimes you need to inject environment information into an image or plugin that you don't want in plain text. + +For this, we introduce pipeline secrets as a pattern to keep sensitive data safe. Secrets are always retrieved at the beginning of a pipeline before any services, stages, or steps are created or started. + +They are the answer when you don’t want to provide that sensitive information in plain text. + +Let's go back to our Docker image used within the plugin tutorial and focus only on the repo secrets type. You can learn about all secret types in the [secrets usage section](/docs/usage/secrets/). + +The pipeline we are looking at shows a few different patterns on how you can leverage adding and aliasing secrets in your pipeline. + +However, this time we are going to remove the `username:` and `password:` YAML keys in the `parameter:` block and replace them with secrets within the container environment. + +**See it in action with examples!** + +* [internal secrets](/docs/usage/examples/secrets_internal/) +* [external secrets](/docs/usage/examples/secrets_external/) + + + +```yaml +steps: + - name: publish hello world + image: target/vela-kaniko + # Here we simply just match the key with the plugin then + # when the container starts you will get "DOCKER_PASSWORD=" + # in the container environment + secrets: [ docker_password ] + parameters: + registry: index.docker.io + repo: index.docker.io/go-vela/hello-world + username: moby + tags: + - latest + - v1.0.0 + + - name: publish hello world + image: target/vela-kaniko + # Now lets try something more complicated let's say you want to + # alias your secret. You can do that via source and target syntax + # where source is the new name and target is the name of the env var. + secrets: + - source: password + target: docker_password + - source: docker_username + target: docker_username + parameters: + registry: index.docker.io + repo: index.docker.io/go-vela/hello-world + tags: + - latest + - v1.0.0 + +secrets: + # Notice here how the name and the key don't need to match. + # This gives end users an ability to reuse or rename secrets with + # different names across their various pipelines. This is similar + # to the alias above, but allows for aliasing across the entire pipeline. + - name: docker_username + key: go-vela/docs/username + engine: native + type: repo +``` + + + +**Key references:** + +[(step) `secrets:`](/docs/reference/yaml/steps/#the-secrets-key), [(parent) `secrets:`](/docs/reference/yaml/secrets), diff --git a/docs/usage/tour/services.md b/docs/usage/tour/services.md new file mode 100644 index 0000000..49da1f9 --- /dev/null +++ b/docs/usage/tour/services.md @@ -0,0 +1,76 @@ +--- +title: "Services" +linkTitle: "Services" +weight: 8 +description: > + Learn about services. +--- + +This declaration allows you to provide detached (headless) container for the duration of a pipeline. + +Services are always ran, in parallel alongside the ephemeral steps in the pipeline. They are extremely useful when your testing requires additional services such as a cache, database or queue. + +Services are always created at the beginning of a pipeline in the order they are defined. + +The `name:` field of the service defines what the hostname of the service will for available communicate to other tasks the pipeline. + +However, there are times when you need more control over when a service is created. Perhaps you are dealing with a service that has start up dependencies and service A needs something to start up before service B is started. + +**See it in action with examples!** + +* [Mongo](/docs/usage/examples/mongo/) +* [Postgres](/docs/usage/examples/postgres/) +* [Redis](/docs/usage/examples/redis/) + + + +```yaml +services: + # Starting a set of services at the beginning of + # pipeline execution + - name: cache + image: redis + - name: database + image: mongo +``` + +```yaml +version: "1" +services: + # Starting a set of services at the beginning of + # pipeline execution + - name: cache + image: redis + +steps: + - name: ping cache + image: redis + commands: + - redis-cli -h cache ping + + # Now that we know redis is started we execute another + # service directly in the steps workflow + - name: database + image: postgres + detach: true +``` + +```sh +$ vela exec pipeline +... +[service: cache] 1:C 02 Feb 2021 21:24:10.600 # oO0OoO0OoO0Oo Redis is starting oO0OoO0OoO0Oo +[service: cache] 1:C 02 Feb 2021 21:24:10.600 # Redis version=6.0.10, bits=64, commit=00000000, modified=0, pid=1, just started +[service: cache] 1:C 02 Feb 2021 21:24:10.600 # Warning: no config file specified, using the default config. In order to specify a config file use redis-server /path/to/redis.conf +[service: cache] 1:M 02 Feb 2021 21:24:10.602 * Running mode=standalone, port=6379. +[service: cache] 1:M 02 Feb 2021 21:24:10.603 # WARNING: The TCP backlog setting of 511 cannot be enforced because /proc/sys/net/core/somaxconn is set to the lower value of 128. +[service: cache] 1:M 02 Feb 2021 21:24:10.603 # Server initialized +[service: cache] 1:M 02 Feb 2021 21:24:10.603 * Ready to accept connections +[stage: ][step: ping cache] $ redis-cli -h cache ping +[stage: ][step: ping cache] PONG +``` + + + +**Key references:** + +[`name:`](/docs/reference/yaml/services/#the-name-key), [`image:`](/docs/reference/yaml/services/#the-image-key), [`detach:`](/docs/reference/yaml/steps/#the-detach-key), diff --git a/docs/usage/tour/stages.md b/docs/usage/tour/stages.md new file mode 100644 index 0000000..0b1565c --- /dev/null +++ b/docs/usage/tour/stages.md @@ -0,0 +1,82 @@ +--- +title: "Stages" +linkTitle: "Stages" +weight: 10 +description: > + Learn about stages pipelines. +--- + +A stages pipelines are designed to parallelize one-to-many sets of step tasks. + +By design all of the stages will run at the same time unless the user uses a `needs:` YAML key to control the flow of stage executions (see example). + +Stages will also stop executing their steps if the build fails as a whole, by default. In other words, if stage 1 fails, the steps that have yet to execute in stage 2 will be skipped. The user can declare `independent: true` for any stage to change this behavior. + +These pipelines do not have a minimum defined length and will always execute steps within a stage in the order defined. Stages always run on the same host so it's important to take into consideration the size of the worker running your builds. + +In this pipeline both stages trigger at the same time. + +Both steps are pulling a [Alpine Linux](https://alpinelinux.org/) image from [Docker Hub](https://hub.docker.com/) and executing echo statements. + +**See it in action with examples!** + +* [Go](/docs/usage/examples/go_modules/) +* [Rust](/docs/usage/examples/rust_cargo/) +* [Gradle](/docs/usage/examples/java_gradle/) +* [Maven](/docs/usage/examples/java_maven/) +* [Node](/docs/usage/examples/node/) + +You can learn more about stage orchestration [here](/docs/usage/stage_orchestration)! + + + +```yaml +version: "1" + +# In this pipeline, commands are executed inside the container as the Entrypoint. +# If any command returns a non-zero exit code, the pipeline fails and exits. +stages: + greeting: + steps: + - name: Greeting + image: alpine + commands: + - echo "Hello, World" + + welcome: + steps: + - name: Welcome + image: alpine + commands: + - echo "Welcome to the Vela docs" + + goodbye: + # will wait for greeting and welcome to finish + needs: [greeting, welcome] + steps: + - name: Goodbye + image: alpine + commands: + - echo "Goodbye, World" +``` + +:::note +Be aware that `needs:` references stages by their name, which can be overridden by the `name` key in the stage definition. +::: + +```sh +$ vela exec pipeline +... +[stage: greeting][step: Greeting] $ echo "Hello, World" +[stage: greeting][step: Greeting] Hello, World +[stage: welcome][step: Welcome] $ echo "Welcome to the Vela docs" +[stage: welcome][step: Welcome] Welcome to the Vela docs +[stage: goodbye][step: Goodbye] $ echo "Goodbye, World" +[stage: goodbye][step: Goodbye] Goodbye, World +``` + + + +**Key references:** + +[`name:`](/docs/reference/yaml/steps/#the-name-key), [`image:`](/docs/reference/yaml/steps/#the-image-key), [`commands:`](/docs/reference/yaml/steps/#the-commands-key), diff --git a/docs/usage/tour/status.md b/docs/usage/tour/status.md new file mode 100644 index 0000000..02992b4 --- /dev/null +++ b/docs/usage/tour/status.md @@ -0,0 +1,41 @@ +--- +title: "Status" +linkTitle: "Status" +weight: 12 +description: > + Learn about Vela statuses. +--- + +Vela will always publish build statuses to the source control management system. These statuses correspond with the webhook event that triggered the build. + +These statuses can be used to define various branch protection policies. + +Vela also supports up to 10 step-level statuses. These statuses will reflect the success or failure of the _step_ rather than the build. The name of this status will match the value of the `report_as` key. + + + +```yaml +# In this pipeline, the status of the build overall will publish +# to the source control management system (SCM). +# +# The step "Test Suite" will publish to the +# SCM separately as `//testing`. + +- name: Welcome + image: alpine + commands: + - echo "Welcome to the Vela docs" + +- name: Test Suite + image: golang:latest + report_as: testing + commands: + - go test +``` + + + +**Key references:** + +[`name:`](/docs/reference/yaml/steps/#the-name-key), [`image:`](/docs/reference/yaml/steps/#the-image-key), [`commands:`](/docs/reference/yaml/steps/#the-commands-key), [`report_as:`](/docs/reference/yaml/steps/#the-report_as-key) + diff --git a/docs/usage/tour/step.md b/docs/usage/tour/step.md new file mode 100644 index 0000000..38d445b --- /dev/null +++ b/docs/usage/tour/step.md @@ -0,0 +1,43 @@ +--- +title: "Step" +linkTitle: "Step" +weight: 1 +description: > + Learn about step. +--- + +A step declaration allows you to provide execution instructions for a pipeline. + +The following step is displaying an example of a minimal configuration for executing a simple echo linux command. + +The `name:` key is the unique identifier for the step throughout the lifecycle of the execution. + +When `commands:` are provided they are converted to a shell script and executed as the Docker entrypoint for the container. + + + +```yaml +# In this step, commands are executed inside the container as the Entrypoint. +# If any command returns a non-zero exit code, the step fails and exits. +- name: Welcome + image: alpine + commands: + - echo "Welcome to the Vela docs" +``` + +```sh +#!/bin/sh + +set -e + +echo "Welcome to the Vela docs" + +docker run --entrypoint=build.sh alpine:latest +``` + + + +**Key references:** + +[`name:`](/docs/reference/yaml/steps/#the-name-key), [`image:`](/docs/reference/yaml/steps/#the-image-key), [`commands:`](/docs/reference/yaml/steps/#the-commands-key), + diff --git a/docs/usage/tour/steps.md b/docs/usage/tour/steps.md new file mode 100644 index 0000000..b45f842 --- /dev/null +++ b/docs/usage/tour/steps.md @@ -0,0 +1,57 @@ +--- +title: "Steps" +linkTitle: "Steps" +weight: 9 +description: > + Learn about steps pipelines. +--- + +A steps pipeline is designed to run a sequential set of tasks. + +These pipelines do not have a minimum defined length and steps will always execute in the order defined. + +In this pipeline each step is shown with the minimum required YAML keys to execute a step. + +Both steps are pulling a [Alpine Linux](https://alpinelinux.org/) image from [Docker Hub](https://hub.docker.com/) and executing echo statements. + +**See it in action with examples!** + +* [Go](/docs/usage/examples/go_modules/) +* [Rust](/docs/usage/examples/rust_cargo/) +* [Gradle](/docs/usage/examples/java_gradle/) +* [Maven](/docs/usage/examples/java_maven/) +* [Node](/docs/usage/examples/node/) + + + +```yaml +version: "1" + +# In this pipeline, commands are executed inside the container as the Entrypoint. +# If any command returns a non-zero exit code, the pipeline fails and exits. +steps: + + - name: Greeting + image: alpine + commands: + - echo "Hello, World" + + - name: Welcome + image: alpine + commands: + - echo "Welcome to the Vela docs" +``` + +```sh +$ vela exec pipeline +... +[stage: ][step: Greeting] $ echo "Hello, World" +[stage: ][step: Greeting] Hello, World +[stage: ][step: Welcome] $ echo "Welcome to the Vela docs" +[stage: ][step: Welcome] Welcome to the Vela docs +``` + + +**Key references:** + +[`name:`](/docs/reference/yaml/steps/#the-name-key), [`image:`](/docs/reference/yaml/steps/#the-image-key), [`commands:`](/docs/reference/yaml/steps/#the-commands-key), diff --git a/docs/usage/tour/templates.md b/docs/usage/tour/templates.md new file mode 100644 index 0000000..a3ecb5d --- /dev/null +++ b/docs/usage/tour/templates.md @@ -0,0 +1,47 @@ +--- +title: "Templates" +linkTitle: "Templates" +weight: 11 +description: > + Learn about template pipelines. +--- + +Templates help to create reusable workflows in order to make grouping tasks like building and deploying code. + +Templates can solve duplicative tasks in a single workflow or be leveraged by any number of pipelines to make reusable tasks across multiple workflows. + +In this pipeline each step is shown with the minimum required YAML keys to execute a step. + +Both steps are pulling a [Alpine Linux](https://alpinelinux.org/) image from [Docker Hub](https://hub.docker.com/) and executing echo statements. + +**Expand your knowledge with a [deep dive](/docs/templates/)!** + + + +```yaml +version: "1" + +templates: + - name: sample + source: github.com///path/to/file/