Skip to content

chore(docs): correct broken links in restructure #14989

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

Merged
merged 7 commits into from
Oct 5, 2024
Merged
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
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 9 additions & 6 deletions docs/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,20 +247,23 @@ be applied selectively or to discourage anyone from contributing.

## Releases

Coder releases are initiated via [`./scripts/release.sh`](../scripts/release.sh)
Coder releases are initiated via
[`./scripts/release.sh`](https://github.com/coder/coder/blob/main/scripts/release.sh)
and automated via GitHub Actions. Specifically, the
[`release.yaml`](../.github/workflows/release.yaml) workflow. They are created
based on the current [`main`](https://github.com/coder/coder/tree/main) branch.
[`release.yaml`](https://github.com/coder/coder/blob/main/.github/workflows/release.yaml)
workflow. They are created based on the current
[`main`](https://github.com/coder/coder/tree/main) branch.

The release notes for a release are automatically generated from commit titles
and metadata from PRs that are merged into `main`.

### Creating a release

The creation of a release is initiated via
[`./scripts/release.sh`](../scripts/release.sh). This script will show a preview
of the release that will be created, and if you choose to continue, create and
push the tag which will trigger the creation of the release via GitHub Actions.
[`./scripts/release.sh`](https://github.com/coder/coder/blob/main/scripts/release.sh).
This script will show a preview of the release that will be created, and if you
choose to continue, create and push the tag which will trigger the creation of
the release via GitHub Actions.

See `./scripts/release.sh --help` for more information.

Expand Down
3 changes: 2 additions & 1 deletion docs/admin/infrastructure/validated-architectures/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -324,7 +324,8 @@ could affect workspace users experience once the platform is live.

### Helm Chart Configuration

1. Reference our [Helm chart values file](../../../../helm/coder/values.yaml)
1. Reference our
[Helm chart values file](https://github.com/coder/coder/blob/main/helm/coder/values.yaml)
and identify the required values for deployment.
1. Create a `values.yaml` and add it to your version control system.
1. Determine the necessary environment variables. Here is the
Expand Down
2 changes: 1 addition & 1 deletion docs/admin/security/secrets.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

<blockquote class="info">
This article explains how to use secrets in a workspace. To authenticate the
workspace provisioner, see <a href="/admin/auth">this</a>.
workspace provisioner, see <a href="../users">this</a>.
</blockquote>

Coder is open-minded about how you get your secrets into your workspaces.
Expand Down
6 changes: 1 addition & 5 deletions docs/admin/setup/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,11 +59,7 @@ If you are providing TLS certificates directly to the Coder server, either

The Coder server can directly use TLS certificates with `CODER_TLS_ENABLE` and
accompanying configuration flags. However, Coder can also run behind a
reverse-proxy to terminate TLS certificates from LetsEncrypt, for example.

- [Apache](./web-server/apache/index.md)
- [Caddy](./web-server/caddy/index.md)
- [NGINX](./web-server/nginx/index.md)
reverse-proxy to terminate TLS certificates from LetsEncrypt.

### Kubernetes TLS configuration

Expand Down
2 changes: 1 addition & 1 deletion docs/admin/templates/extending-templates/modules.md
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ In offline and restricted deploymnets, there are 2 ways to fetch modules.

### Artifactory

Air gapped users can clone the [coder/modules](htpps://github.com/coder/modules)
Air gapped users can clone the [coder/modules](https://github.com/coder/modules)
repo and publish a
[local terraform module repository](https://jfrog.com/help/r/jfrog-artifactory-documentation/set-up-a-terraform-module/provider-registry)
to resolve modules via [Artifactory](https://jfrog.com/artifactory/).
Expand Down
2 changes: 1 addition & 1 deletion docs/install/cloud/ec2.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ creating VM-based workspaces.

![Modify IAM role](../../images/platforms/aws/aws-linux.png)

## Next steps
### Next steps

- [IDEs with Coder](../../user-guides/workspace-access/index.md)
- [Writing custom templates for Coder](../../admin/templates/index.md)
Expand Down
4 changes: 2 additions & 2 deletions docs/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,7 +62,7 @@ To log in to an existing Coder deployment:
coder login https://coder.example.com
```

## Next up
## Next steps

- [Create your first template](../start/first-template.md)
- [Set up your first deployment](../start/coder-tour.md)
- [Expose your control plane to other users](../admin/setup/index.md)
2 changes: 1 addition & 1 deletion docs/install/kubernetes.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# Install Coder on Kubernetes

You can install Coder on Kubernetes using Helm. We run on most Kubernetes
distributions, including [OpenShift](./other/openshift.md).
distributions, including [OpenShift](./other.md).

## Requirements

Expand Down
2 changes: 1 addition & 1 deletion docs/install/offline.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ environments. However, some changes to your configuration are necessary.
| DERP | By default, Coder's built-in DERP relay can be used, or [Tailscale's public relays](../admin/networking/index.md#relayed-connections). | By default, Coder's built-in DERP relay can be used, or [custom relays](../admin/networking/index.md#custom-relays). |
| PostgreSQL | If no [PostgreSQL connection URL](../reference/cli/server.md#--postgres-url) is specified, Coder will download Postgres from [repo1.maven.org](https://repo1.maven.org) | An external database is required, you must specify a [PostgreSQL connection URL](../reference/cli/server.md#--postgres-url) |
| Telemetry | Telemetry is on by default, and [can be disabled](../reference/cli/server.md#--telemetry) | Telemetry [can be disabled](../reference/cli/server.md#--telemetry) |
| Update check | By default, Coder checks for updates from [GitHub releases](https:/github.com/coder/coder/releases) | Update checks [can be disabled](../reference/cli/server.md#--update-check) |
| Update check | By default, Coder checks for updates from [GitHub releases](https://github.com/coder/coder/releases) | Update checks [can be disabled](../reference/cli/server.md#--update-check) |

## Offline container images

Expand Down
7 changes: 6 additions & 1 deletion docs/manifest.json
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
"title": "Releases",
"description": "Learn about the Coder release channels and schedule",
"path": "./install/releases.md",
"icon_path": "./images/icons/trash.svg"
"icon_path": "./images/icons/star.svg"
}
]
},
Expand Down Expand Up @@ -145,6 +145,11 @@
"title": "Filebrowser",
"description": "Access your workspace files",
"path": "./user-guides/workspace-access/filebrowser.md"
},
{
"title": "Web IDEs and Coder Apps",
"description": "Access your workspace with IDEs in the browser",
"path": "./user-guides/workspace-access/web-ides.md"
}
]
},
Expand Down
2 changes: 1 addition & 1 deletion docs/user-guides/workspace-access/jetbrains.md
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,7 @@ manually setting up an SSH connection.

![Gateway Connect to Coder](../../images/gateway/plugin-connect-to-coder.png)

1. Enter your Coder deployment'ssetup/index.md
1. Enter your Coder deployment's
[Access Url](../../admin/setup/index.md#access-url) and click **Connect**.

Gateway opens your Coder deployment's `cli-auth` page with a session token.
Expand Down
Loading