From 4843bd659af9eb9eb8ea337fb8df66a477994e62 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Tue, 21 Jun 2022 07:40:17 -0500 Subject: [PATCH 1/2] chore: fix broken links and formatting issues --- docs/README.md | 2 +- docs/ides.md | 2 +- docs/ides/configuring-web-ides.md | 2 +- docs/install.md | 2 +- docs/postgres.md | 4 ++-- docs/templates.md | 4 +--- docs/workspaces.md | 2 +- 7 files changed, 8 insertions(+), 10 deletions(-) diff --git a/docs/README.md b/docs/README.md index b20d024947a17..d6dfcb9699503 100644 --- a/docs/README.md +++ b/docs/README.md @@ -74,7 +74,7 @@ layer of infrastructure control. This additional layer allows admins to: - Enable persistent workspaces, which are like local machines, but faster and hosted by a cloud service -Coder includes [production-ready templates](../examples/templates) for use with AWS EC2, +Coder includes [production-ready templates](../examples/templates/README.md) for use with AWS EC2, Azure, Google Cloud, Kubernetes, and more. ## What Coder is _not_ diff --git a/docs/ides.md b/docs/ides.md index b14f478aa5d9b..cd92df3efafbb 100644 --- a/docs/ides.md +++ b/docs/ides.md @@ -61,4 +61,4 @@ Code, connected to your Coder workspace for compute, etc. ## Web IDEs (Jupyter, code-server, Jetbrains Projector) -Web IDEs (code-server, JetBrains Projector, VNC, etc.) are defined in the template. See [configuring IDEs](./templates/configuring-ides.md). +Web IDEs (code-server, JetBrains Projector, VNC, etc.) are defined in the template. See [configuring IDEs](./ides/configuring-web-ides.md). diff --git a/docs/ides/configuring-web-ides.md b/docs/ides/configuring-web-ides.md index d399e27d8cf5d..eb4cb731e9663 100644 --- a/docs/ides/configuring-web-ides.md +++ b/docs/ides/configuring-web-ides.md @@ -102,7 +102,7 @@ Workspace requirements: Installation instructions will vary depending on your workspace's operating system, platform, and build system. -As a starting point, see the [jetbrains-container](https://github.com/bpmct/coder-templates/tree/main/jetbrains-container) community template. It builds & provisions a Dockerized workspaces for the following IDEs: +As a starting point, see the [projector-container](https://github.com/bpmct/coder-templates/tree/main/projector-container) community template. It builds & provisions a Dockerized workspaces for the following IDEs: - CLion - pyCharm diff --git a/docs/install.md b/docs/install.md index 6525cc7497d54..e7a9b0a66871d 100644 --- a/docs/install.md +++ b/docs/install.md @@ -46,7 +46,7 @@ journalctl -u coder.service -b Before proceeding, please ensure that you have both Docker and the [latest version of Coder](https://github.com/coder/coder/releases) installed. -> See our [docker-compose](../docker-compose.yaml) file +> See our [docker-compose](https://github.com/coder/coder/blob/93b78755a6d48191cc53c82654e249f25fc00ce9/docker-compose.yaml) file > for additional information. 1. Clone the `coder` repository: diff --git a/docs/postgres.md b/docs/postgres.md index a167af41936e3..39ee8d52d8eb6 100644 --- a/docs/postgres.md +++ b/docs/postgres.md @@ -91,5 +91,5 @@ CODER_PG_CONNECTION_URL="postgres://@0.0.0.0/?ss coder server -a 0.0.0.0:3000 --verbose ``` -> If you [installed Coder manually](install.md), you can add the `CODER_PG_CONNECTION_URL` -variable to `/etc/coder.d/coder.env`. +> If you [installed Coder manually](install.md), you can add the +> `CODER_PG_CONNECTION_URL` variable to `/etc/coder.d/coder.env`. diff --git a/docs/templates.md b/docs/templates.md index 9f0fc845ac31f..522b05bbf3ae2 100644 --- a/docs/templates.md +++ b/docs/templates.md @@ -43,6 +43,4 @@ credentials. --- -Next: [Workspaces](./workspaces.md) - -Next: [Authentication & Secrets](./authentication.md) +Next: [Authentication & Secrets](templates/authentication.md) and [Workspaces](./workspaces.md) diff --git a/docs/workspaces.md b/docs/workspaces.md index a445cd6d1fd53..43583f49763f5 100644 --- a/docs/workspaces.md +++ b/docs/workspaces.md @@ -33,7 +33,7 @@ resources](./templates.md#persistent-and-ephemeral-resources). > ⚠️ To avoid data loss, refer to your template documentation for information on > where to store files, install software, etc., so that they persist. Default -> templates are documented in [../examples/templates](../examples/templates/). +> templates are documented in [../examples/templates](../examples/templates/README.md). > > You can use `coder show ` to see which resources are > persistent and which are ephemeral. From d602ca190af7f4ff71b362ad8921698a34228667 Mon Sep 17 00:00:00 2001 From: Katie Horne Date: Tue, 21 Jun 2022 08:02:31 -0500 Subject: [PATCH 2/2] chore: update version number --- docs/manifest.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/manifest.json b/docs/manifest.json index 0dc88d2e969fe..c2cd73c15bba6 100644 --- a/docs/manifest.json +++ b/docs/manifest.json @@ -1,6 +1,6 @@ { "versions": [ - "0.6.6" + "0.7.3" ], "routes": [ {