Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: ran update link fix script #19

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
The table of contents is too big for display.
Diff view
Diff view
  •  
  •  
  •  
8 changes: 4 additions & 4 deletions docs/installation/server/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down Expand Up @@ -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/scm.md) for instructions on creating the OAuth application.

### Step 7: Start the Server

Expand Down Expand Up @@ -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.md).
:::

### Step 8: Verify the Server Logs
Expand All @@ -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.
2 changes: 1 addition & 1 deletion docs/installation/ui/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/installation/ui/ui.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.
2 changes: 1 addition & 1 deletion docs/installation/worker/kubernetes.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.md).
:::


Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/admin/admin.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
:::
2 changes: 1 addition & 1 deletion docs/reference/api/admin/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/admin/build_queue.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/admin/clean.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/admin/hook.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/admin/repo.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/admin/secret.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/admin/service.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/admin/settings/restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/admin/settings/settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
:::
2 changes: 1 addition & 1 deletion docs/reference/api/admin/settings/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/admin/settings/view.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/admin/step.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/admin/user.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/admin/worker.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/build/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/build/build.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
:::
2 changes: 1 addition & 1 deletion docs/reference/api/build/cancel.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/build/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/build/logs.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/build/remove.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/build/restart.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/build/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/reference/api/build/view.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/dashboard/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/dashboard/dashboard.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
:::
2 changes: 1 addition & 1 deletion docs/reference/api/dashboard/delete.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/dashboard/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/dashboard/list.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/dashboard/update.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/deployment/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/deployment/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
:::
2 changes: 1 addition & 1 deletion docs/reference/api/deployment/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/deployment/view.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/hook/add.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/api/hook/get.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Loading
Loading