From 71ea454ecd24873dd062a53180cdba4c20581c5f Mon Sep 17 00:00:00 2001 From: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Date: Wed, 23 Oct 2024 18:23:55 +0000 Subject: [PATCH] re-case GitHub --- docs/admin/infrastructure/validated-architectures/index.md | 2 +- docs/admin/integrations/opentofu.md | 2 +- docs/changelogs/v2.1.5.md | 2 +- docs/install/releases.md | 4 ++-- docs/reference/api/schemas.md | 4 ++-- docs/tutorials/example-guide.md | 4 ++-- docs/tutorials/faqs.md | 6 +++--- docs/tutorials/index.md | 2 +- docs/user-guides/workspace-access/vscode.md | 4 ++-- 9 files changed, 15 insertions(+), 15 deletions(-) diff --git a/docs/admin/infrastructure/validated-architectures/index.md b/docs/admin/infrastructure/validated-architectures/index.md index 85cbe430cc566..f0baa7c632b98 100644 --- a/docs/admin/infrastructure/validated-architectures/index.md +++ b/docs/admin/infrastructure/validated-architectures/index.md @@ -340,7 +340,7 @@ could affect workspace users experience once the platform is live. 1. Maintain Coder templates using [version control](../../templates/managing-templates/change-management.md). 1. Consider implementing a GitOps workflow to automatically push new template - versions into Coder from git. For example, on Github, you can use the + versions into Coder from git. For example, on GitHub, you can use the [Setup Coder](https://github.com/marketplace/actions/setup-coder) action. 1. Evaluate enabling [automatic template updates](../../templates/managing-templates/index.md#template-update-policies-enterprise-premium) diff --git a/docs/admin/integrations/opentofu.md b/docs/admin/integrations/opentofu.md index 6268a228e5d03..1867f03e8e2ed 100644 --- a/docs/admin/integrations/opentofu.md +++ b/docs/admin/integrations/opentofu.md @@ -4,7 +4,7 @@ > ⚠️ This guide is a work in progress. We do not officially support using custom > Terraform binaries in your Coder deployment. To track progress on the work, -> see this related [Github Issue](https://github.com/coder/coder/issues/12009). +> see this related [GitHub Issue](https://github.com/coder/coder/issues/12009). Coder deployments support any custom Terraform binary, including [OpenTofu](https://opentofu.org/docs/) - an open source alternative to diff --git a/docs/changelogs/v2.1.5.md b/docs/changelogs/v2.1.5.md index bb73d31f9acff..f23eff4b67b25 100644 --- a/docs/changelogs/v2.1.5.md +++ b/docs/changelogs/v2.1.5.md @@ -36,7 +36,7 @@ (@spikecurtis) - Fix null pointer on external provisioner daemons with daily_cost (#9401) (@spikecurtis) -- Hide OIDC and Github auth settings when they are disabled (#9447) (@aslilac) +- Hide OIDC and GitHub auth settings when they are disabled (#9447) (@aslilac) - Generate username with uuid to prevent collision (#9496) (@kylecarbs) - Make 'NoRefresh' honor unlimited tokens in gitauth (#9472) (@Emyrk) - Dotfiles: add an exception for `.gitconfig` (#9515) (@matifali) diff --git a/docs/install/releases.md b/docs/install/releases.md index 261d8c43dc42c..51950f9d1edc6 100644 --- a/docs/install/releases.md +++ b/docs/install/releases.md @@ -1,7 +1,7 @@ # Releases Coder releases are cut directly from main in our -[Github](https://github.com/coder/coder) on the first Tuesday of each month. +[GitHub](https://github.com/coder/coder) on the first Tuesday of each month. We recommend enterprise customers test the compatibility of new releases with their infrastructure on a staging environment before upgrading a production @@ -38,7 +38,7 @@ only for security issues or CVEs. ## Installing stable When installing Coder, we generally advise specifying the desired version from -our Github [releases page](https://github.com/coder/coder/releases). +our GitHub [releases page](https://github.com/coder/coder/releases). You can also use our `install.sh` script with the `stable` flag to install the latest stable release: diff --git a/docs/reference/api/schemas.md b/docs/reference/api/schemas.md index ed3800b3a27cd..7ad95fba05092 100644 --- a/docs/reference/api/schemas.md +++ b/docs/reference/api/schemas.md @@ -3604,9 +3604,9 @@ CreateWorkspaceRequest provides options for creating a new workspace. Only one o | Name | Type | Required | Restrictions | Description | | -------- | ---------------------------------------------------------- | -------- | ------------ | ----------- | -| `github` | [codersdk.OAuth2GithubConfig](#codersdkoauth2githubconfig) | false | | | +| `github` | [codersdk.OAuth2GitHubConfig](#codersdkoauth2githubconfig) | false | | | -## codersdk.OAuth2GithubConfig +## codersdk.OAuth2GitHubConfig ```json { diff --git a/docs/tutorials/example-guide.md b/docs/tutorials/example-guide.md index b0a9de5e8dafd..f60ce6972710b 100644 --- a/docs/tutorials/example-guide.md +++ b/docs/tutorials/example-guide.md @@ -1,4 +1,4 @@ -# Guide Title (Only Visible in Github) +# Guide Title (Only Visible in GitHub)
@@ -28,7 +28,7 @@ Use relative imports in the markdown and store photos in ### Setting the author data At the top of this example you will find a small html snippet that nicely -renders the author's name and photo, while linking to their Github profile. +renders the author's name and photo, while linking to their GitHub profile. Before submitting your guide in a PR, replace `your_github_handle`, `your_github_profile_photo_url` and "Your Name". The entire `` element can be omitted. diff --git a/docs/tutorials/faqs.md b/docs/tutorials/faqs.md index 96dccf8047334..29eb86ea39b04 100644 --- a/docs/tutorials/faqs.md +++ b/docs/tutorials/faqs.md @@ -5,7 +5,7 @@ come from our community and enterprise customers, feel free to [contribute to this page](https://github.com/coder/coder/edit/main/docs/tutorials/faqs.md). For other community resources, see our -[Github discussions](https://github.com/coder/coder/discussions), or join our +[GitHub discussions](https://github.com/coder/coder/discussions), or join our [Discord server](https://discord.gg/coder). ### How do I add a Premium trial license? @@ -291,8 +291,8 @@ tar -cvh -C ./template_1 | coder templates -d - References: -- [Public Github Issue 6117](https://github.com/coder/coder/issues/6117) -- [Public Github Issue 5677](https://github.com/coder/coder/issues/5677) +- [Public GitHub Issue 6117](https://github.com/coder/coder/issues/6117) +- [Public GitHub Issue 5677](https://github.com/coder/coder/issues/5677) - [Coder docs: Templates/Change Management](../admin/templates/managing-templates/change-management.md) ### Can I run Coder in an air-gapped or offline mode? (no Internet)? diff --git a/docs/tutorials/index.md b/docs/tutorials/index.md index b849120f8497e..6a38fe2b1cb96 100644 --- a/docs/tutorials/index.md +++ b/docs/tutorials/index.md @@ -2,7 +2,7 @@ Here you can find a list of employee-written guides on Coder for OSS and Enterprise. These tutorials are hosted on our -[Github](https://github.com/coder/coder/) where you can leave feedback or +[GitHub](https://github.com/coder/coder/) where you can leave feedback or request new topics to be covered. diff --git a/docs/user-guides/workspace-access/vscode.md b/docs/user-guides/workspace-access/vscode.md index 54d3fcf9c0aad..dc3cac46be0e8 100644 --- a/docs/user-guides/workspace-access/vscode.md +++ b/docs/user-guides/workspace-access/vscode.md @@ -99,7 +99,7 @@ Web or using the workspace's terminal. ```tf resource "coder_agent" "main" { ... - startup_script = "code-server --install-extension /vsix/Github.copilot.vsix" + startup_script = "code-server --install-extension /vsix/GitHub.copilot.vsix" } ``` @@ -130,7 +130,7 @@ Using the workspace's terminal or the terminal available inside `code-server`, you can install an extension whose files you've downloaded from a marketplace: ```console -/path/to/code-server --install-extension /vsix/Github.copilot.vsix +/path/to/code-server --install-extension /vsix/GitHub.copilot.vsix ``` ### Installing from a marketplace at the command line