Merge pull request #20 from go-vela/fix-branch

fix: added some docs and did some cleanup

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=<shared_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.
+Please refer to [the worker installation docs](/docs/installation/worker/worker.md) for more information.

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

docs/installation/ui/ui.md

@@ -23,12 +23,12 @@ 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
 
 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.
+Please refer to [our Kubernetes deployment guide](/docs/installation/ui/kubernetes.md) to get started.

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).
 :::
 
 

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).
 :::

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

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

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

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

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

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

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

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

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).
 :::

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

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

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

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

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

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

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).
 :::

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

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

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

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

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

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

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

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

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).
 :::

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

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

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

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

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

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).
 :::

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

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

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

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