From 1f93b80e09b943ab96906f4851a1a14a4d56579b Mon Sep 17 00:00:00 2001 From: Edward Angert Date: Fri, 1 Nov 2024 15:43:51 -0400 Subject: [PATCH] chore: fix docs/admin links and upgrade notice (#15043) - Update links to /docs/admin to match the new structure - TODO: remove the release string from the "upgrade available" instructions link - [x] https://github.com/coder/coder/blob/update-upgrade-config-links/cli/server.go#L646 ![2024-10-11_11-35-40](https://github.com/user-attachments/assets/fd95e821-d5ad-4c91-a38a-066046c7072c) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> --- cli/server.go | 2 +- cli/templatecreate.go | 2 +- cli/templateedit.go | 2 +- cli/testdata/coder_templates_create_--help.golden | 2 +- cli/testdata/coder_templates_edit_--help.golden | 2 +- docs/admin/templates/extending-templates/web-ides.md | 2 +- docs/reference/cli/templates_create.md | 2 +- docs/reference/cli/templates_edit.md | 2 +- install.sh | 2 +- site/src/api/queries/workspaces.ts | 2 +- 10 files changed, 10 insertions(+), 10 deletions(-) diff --git a/cli/server.go b/cli/server.go index c053d8dc7e..aa0a010eb0 100644 --- a/cli/server.go +++ b/cli/server.go @@ -813,7 +813,7 @@ func (r *RootCmd) Server(newAPI func(context.Context, *coderd.Options) (*coderd. } defer options.Telemetry.Close() } else { - logger.Warn(ctx, fmt.Sprintf(`telemetry disabled, unable to notify of security issues. Read more: %s/admin/telemetry`, vals.DocsURL.String())) + logger.Warn(ctx, fmt.Sprintf(`telemetry disabled, unable to notify of security issues. Read more: %s/admin/setup/telemetry`, vals.DocsURL.String())) } // This prevents the pprof import from being accidentally deleted. diff --git a/cli/templatecreate.go b/cli/templatecreate.go index beef006508..c45277bec5 100644 --- a/cli/templatecreate.go +++ b/cli/templatecreate.go @@ -237,7 +237,7 @@ func (r *RootCmd) templateCreate() *serpent.Command { }, { Flag: "require-active-version", - Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise for more details.", + Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise for more details.", Value: serpent.BoolOf(&requireActiveVersion), Default: "false", }, diff --git a/cli/templateedit.go b/cli/templateedit.go index 8d0ecf3e20..44d77ff448 100644 --- a/cli/templateedit.go +++ b/cli/templateedit.go @@ -290,7 +290,7 @@ func (r *RootCmd) templateEdit() *serpent.Command { }, { Flag: "require-active-version", - Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise for more details.", + Description: "Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise for more details.", Value: serpent.BoolOf(&requireActiveVersion), Default: "false", }, diff --git a/cli/testdata/coder_templates_create_--help.golden b/cli/testdata/coder_templates_create_--help.golden index 5cbd079355..80cccb24a5 100644 --- a/cli/testdata/coder_templates_create_--help.golden +++ b/cli/testdata/coder_templates_create_--help.golden @@ -55,7 +55,7 @@ OPTIONS: Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See - https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise + https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise for more details. --var string-array diff --git a/cli/testdata/coder_templates_edit_--help.golden b/cli/testdata/coder_templates_edit_--help.golden index eab60ac359..76dee16cf9 100644 --- a/cli/testdata/coder_templates_edit_--help.golden +++ b/cli/testdata/coder_templates_edit_--help.golden @@ -87,7 +87,7 @@ OPTIONS: Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See - https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise + https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise for more details. -y, --yes bool diff --git a/docs/admin/templates/extending-templates/web-ides.md b/docs/admin/templates/extending-templates/web-ides.md index fbfd2bab42..1ded4fbf34 100644 --- a/docs/admin/templates/extending-templates/web-ides.md +++ b/docs/admin/templates/extending-templates/web-ides.md @@ -255,7 +255,7 @@ resource "coder_app" "rstudio" { ``` If you cannot enable a -[wildcard subdomain](https://coder.com/docs/admin/configure#wildcard-access-url), +[wildcard subdomain](https://coder.com/docs/admin/setup#wildcard-access-url), you can configure the template to run RStudio on a path using an NGINX reverse proxy in the template. There is however [security risk](https://coder.com/docs/reference/cli/server#--dangerous-allow-path-app-sharing) diff --git a/docs/reference/cli/templates_create.md b/docs/reference/cli/templates_create.md index 9346948072..01b153ff29 100644 --- a/docs/reference/cli/templates_create.md +++ b/docs/reference/cli/templates_create.md @@ -95,7 +95,7 @@ Specify a duration workspaces may be in the dormant state prior to being deleted | Type | bool | | Default | false | -Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise for more details. +Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise for more details. ### -y, --yes diff --git a/docs/reference/cli/templates_edit.md b/docs/reference/cli/templates_edit.md index b9a613bdd8..81fdc04d1a 100644 --- a/docs/reference/cli/templates_edit.md +++ b/docs/reference/cli/templates_edit.md @@ -153,7 +153,7 @@ Allow users to customize the autostop TTL for workspaces on this template. This | Type | bool | | Default | false | -Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/templates/general-settings#require-automatic-updates-enterprise for more details. +Requires workspace builds to use the active template version. This setting does not apply to template admins. This is an enterprise-only feature. See https://coder.com/docs/admin/templates/managing-templates#require-automatic-updates-enterprise for more details. ### --private diff --git a/install.sh b/install.sh index 40753f2f99..e6a553eaac 100755 --- a/install.sh +++ b/install.sh @@ -216,7 +216,7 @@ To run a Coder server: # Or just run the server directly $ coder server - Configuring Coder: https://coder.com/docs/admin/configure + Configuring Coder: https://coder.com/docs/admin/setup To connect to a Coder deployment: diff --git a/site/src/api/queries/workspaces.ts b/site/src/api/queries/workspaces.ts index 87bdc158b8..ee390e542c 100644 --- a/site/src/api/queries/workspaces.ts +++ b/site/src/api/queries/workspaces.ts @@ -61,7 +61,7 @@ type AutoCreateWorkspaceOptions = { * If provided, the auto-create workspace feature will attempt to find a * matching workspace. If found, it will return the existing workspace instead * of creating a new one. Its value supports [advanced filtering queries for - * workspaces](https://coder.com/docs/workspaces#workspace-filtering). If + * workspaces](https://coder.com/docs/user-guides/workspace-management#workspace-filtering). If * multiple values are returned, the first one will be returned. */ match: string | null;