From 1b0b4b89369223a1bb230810843730f656ceeb41 Mon Sep 17 00:00:00 2001 From: Jonathan Yu Date: Tue, 30 Mar 2021 01:34:42 +0000 Subject: [PATCH] chore: rename instances of Coder Enterprise to Coder We rebranded the product from Coder Enterprise to Coder; this change updates the text accordingly. Some references (such as URLs and variable names) have not been changed. --- README.md | 2 +- coder-sdk/README.md | 2 +- coder-sdk/config.go | 14 +++++++------- coder-sdk/doc.go | 2 +- coder-sdk/interface.go | 6 +++--- coder-sdk/org.go | 2 +- coder-sdk/tokens.go | 4 ++-- coder-sdk/users.go | 2 +- docs/coder.md | 2 +- docs/coder_completion.md | 2 +- docs/coder_config-ssh.md | 6 +++--- docs/coder_envs.md | 2 +- docs/coder_images.md | 2 +- docs/coder_login.md | 4 ++-- docs/coder_logout.md | 2 +- docs/coder_ssh.md | 2 +- docs/coder_sync.md | 2 +- docs/coder_tokens.md | 2 +- docs/coder_urls.md | 2 +- docs/coder_users.md | 2 +- internal/cmd/ceapi.go | 2 +- internal/cmd/cmd.go | 2 +- internal/cmd/configssh.go | 10 +++++----- internal/cmd/login.go | 2 +- internal/sync/sync.go | 2 +- 25 files changed, 41 insertions(+), 41 deletions(-) diff --git a/README.md b/README.md index 11e09fa5..9757c3ec 100644 --- a/README.md +++ b/README.md @@ -5,7 +5,7 @@ ![build](https://github.com/cdr/coder-cli/workflows/build/badge.svg) [![Go Report Card](https://goreportcard.com/badge/cdr.dev/coder-cli)](https://goreportcard.com/report/cdr.dev/coder-cli) -`coder` is a command line utility for Coder Enterprise. +`coder` is a command line utility for Coder. To report bugs and request features, please [open an issue](https://github.com/cdr/coder-cli/issues/new). diff --git a/coder-sdk/README.md b/coder-sdk/README.md index 1a0881db..75ffd8dd 100644 --- a/coder-sdk/README.md +++ b/coder-sdk/README.md @@ -1,6 +1,6 @@ # coder-sdk -`coder-sdk` is a Go client library for [Coder Enterprise](https://coder.com). +`coder-sdk` is a Go client library for [Coder](https://coder.com). It is not yet stable and therefore we do not recommend depending on the current state of its public APIs. ## Usage diff --git a/coder-sdk/config.go b/coder-sdk/config.go index e7c4c864..7012f90d 100644 --- a/coder-sdk/config.go +++ b/coder-sdk/config.go @@ -15,14 +15,14 @@ const ( AuthProviderOIDC AuthProviderType = "oidc" ) -// ConfigAuth describes the authentication configuration for a Coder Enterprise deployment. +// ConfigAuth describes the authentication configuration for a Coder deployment. type ConfigAuth struct { ProviderType *AuthProviderType `json:"provider_type"` OIDC *ConfigOIDC `json:"oidc"` SAML *ConfigSAML `json:"saml"` } -// ConfigOIDC describes the OIDC configuration for single-signon support in Coder Enterprise. +// ConfigOIDC describes the OIDC configuration for single-signon support in Coder. type ConfigOIDC struct { ClientID *string `json:"client_id"` ClientSecret *string `json:"client_secret"` @@ -38,26 +38,26 @@ type ConfigSAML struct { PublicKeyCertificate *string `json:"public_key_certificate"` } -// ConfigOAuthBitbucketServer describes the Bitbucket integration configuration for a Coder Enterprise deployment. +// ConfigOAuthBitbucketServer describes the Bitbucket integration configuration for a Coder deployment. type ConfigOAuthBitbucketServer struct { BaseURL string `json:"base_url" diff:"oauth.bitbucket_server.base_url"` } -// ConfigOAuthGitHub describes the Github integration configuration for a Coder Enterprise deployment. +// ConfigOAuthGitHub describes the Github integration configuration for a Coder deployment. type ConfigOAuthGitHub struct { BaseURL string `json:"base_url"` ClientID string `json:"client_id"` ClientSecret string `json:"client_secret"` } -// ConfigOAuthGitLab describes the GitLab integration configuration for a Coder Enterprise deployment. +// ConfigOAuthGitLab describes the GitLab integration configuration for a Coder deployment. type ConfigOAuthGitLab struct { BaseURL string `json:"base_url"` ClientID string `json:"client_id" ` ClientSecret string `json:"client_secret"` } -// ConfigOAuth describes the aggregate git integration configuration for a Coder Enterprise deployment. +// ConfigOAuth describes the aggregate git integration configuration for a Coder deployment. type ConfigOAuth struct { BitbucketServer ConfigOAuthBitbucketServer `json:"bitbucket_server"` GitHub ConfigOAuthGitHub `json:"github"` @@ -96,7 +96,7 @@ type configSetupMode struct { SetupMode bool `json:"setup_mode"` } -// SiteSetupModeEnabled fetches the current setup_mode state of a Coder Enterprise deployment. +// SiteSetupModeEnabled fetches the current setup_mode state of a Coder deployment. func (c *DefaultClient) SiteSetupModeEnabled(ctx context.Context) (bool, error) { var conf configSetupMode if err := c.requestBody(ctx, http.MethodGet, "/api/private/config/setup-mode", nil, &conf); err != nil { diff --git a/coder-sdk/doc.go b/coder-sdk/doc.go index b1fa97ea..5fe3bd46 100644 --- a/coder-sdk/doc.go +++ b/coder-sdk/doc.go @@ -1,2 +1,2 @@ -// Package coder provides simple APIs for integrating Go applications with Coder Enterprise. +// Package coder provides simple APIs for integrating Go applications with Coder. package coder diff --git a/coder-sdk/interface.go b/coder-sdk/interface.go index e3cc9eb4..93043ee7 100644 --- a/coder-sdk/interface.go +++ b/coder-sdk/interface.go @@ -53,7 +53,7 @@ type Client interface { // PutSiteConfigOAuth sets the sitewide git provider OAuth configuration. PutSiteConfigOAuth(ctx context.Context, req ConfigOAuth) error - // SiteSetupModeEnabled fetches the current setup_mode state of a Coder Enterprise deployment. + // SiteSetupModeEnabled fetches the current setup_mode state of a Coder deployment. SiteSetupModeEnabled(ctx context.Context) (bool, error) // SiteConfigExtensionMarketplace fetches the extension marketplace configuration. @@ -160,7 +160,7 @@ type Client interface { // UpdateOrganization applys a partial update of an Organization resource. UpdateOrganization(ctx context.Context, orgID string, req UpdateOrganizationReq) error - // CreateOrganization creates a new Organization in Coder Enterprise. + // CreateOrganization creates a new Organization in Coder. CreateOrganization(ctx context.Context, req CreateOrganizationReq) error // DeleteOrganization deletes an organization. @@ -190,7 +190,7 @@ type Client interface { // ImageTagByID fetch an image tag by ID. ImageTagByID(ctx context.Context, imageID, tagID string) (*ImageTag, error) - // CreateAPIToken creates a new APIToken for making authenticated requests to Coder Enterprise. + // CreateAPIToken creates a new APIToken for making authenticated requests to Coder. CreateAPIToken(ctx context.Context, userID string, req CreateAPITokenReq) (string, error) // APITokens fetches all APITokens owned by the given user. diff --git a/coder-sdk/org.go b/coder-sdk/org.go index 2ecb8d2a..92718dcd 100644 --- a/coder-sdk/org.go +++ b/coder-sdk/org.go @@ -90,7 +90,7 @@ type CreateOrganizationReq struct { MemoryProvisioningRate float32 `json:"memory_provisioning_rate"` } -// CreateOrganization creates a new Organization in Coder Enterprise. +// CreateOrganization creates a new Organization in Coder. func (c *DefaultClient) CreateOrganization(ctx context.Context, req CreateOrganizationReq) error { return c.requestBody(ctx, http.MethodPost, "/api/v0/orgs", req, nil) } diff --git a/coder-sdk/tokens.go b/coder-sdk/tokens.go index b707951d..dc12a173 100644 --- a/coder-sdk/tokens.go +++ b/coder-sdk/tokens.go @@ -6,7 +6,7 @@ import ( "time" ) -// APIToken describes a Coder Enterprise APIToken resource for use in API requests. +// APIToken describes a Coder APIToken resource for use in API requests. type APIToken struct { ID string `json:"id"` Name string `json:"name"` @@ -24,7 +24,7 @@ type createAPITokenResp struct { Key string `json:"key"` } -// CreateAPIToken creates a new APIToken for making authenticated requests to Coder Enterprise. +// CreateAPIToken creates a new APIToken for making authenticated requests to Coder. func (c *DefaultClient) CreateAPIToken(ctx context.Context, userID string, req CreateAPITokenReq) (token string, _ error) { var resp createAPITokenResp err := c.requestBody(ctx, http.MethodPost, "/api/v0/api-keys/"+userID, req, &resp) diff --git a/coder-sdk/users.go b/coder-sdk/users.go index 64b1fe51..8b02f5f1 100644 --- a/coder-sdk/users.go +++ b/coder-sdk/users.go @@ -20,7 +20,7 @@ type User struct { UpdatedAt time.Time `json:"updated_at" table:"-"` } -// Role defines a Coder Enterprise permissions role group. +// Role defines a Coder permissions role group. type Role string // Site Roles. diff --git a/docs/coder.md b/docs/coder.md index 87c28c19..bd37b0bd 100644 --- a/docs/coder.md +++ b/docs/coder.md @@ -1,6 +1,6 @@ ## coder -coder provides a CLI for working with an existing Coder Enterprise installation +coder provides a CLI for working with an existing Coder installation ### Options diff --git a/docs/coder_completion.md b/docs/coder_completion.md index 505fb8ca..7478c155 100644 --- a/docs/coder_completion.md +++ b/docs/coder_completion.md @@ -66,5 +66,5 @@ MacOS: ### SEE ALSO -* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation +* [coder](coder.md) - coder provides a CLI for working with an existing Coder installation diff --git a/docs/coder_config-ssh.md b/docs/coder_config-ssh.md index 8e076fca..8ac849cf 100644 --- a/docs/coder_config-ssh.md +++ b/docs/coder_config-ssh.md @@ -13,9 +13,9 @@ coder config-ssh [flags] ### Options ``` - --filepath string overide the default path of your ssh config file (default "~/.ssh/config") + --filepath string override the default path of your ssh config file (default "~/.ssh/config") -h, --help help for config-ssh - --remove remove the auto-generated Coder Enterprise ssh config + --remove remove the auto-generated Coder ssh config ``` ### Options inherited from parent commands @@ -26,5 +26,5 @@ coder config-ssh [flags] ### SEE ALSO -* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation +* [coder](coder.md) - coder provides a CLI for working with an existing Coder installation diff --git a/docs/coder_envs.md b/docs/coder_envs.md index 82897598..8a8f172c 100644 --- a/docs/coder_envs.md +++ b/docs/coder_envs.md @@ -20,7 +20,7 @@ Perform operations on the Coder environments owned by the active user. ### SEE ALSO -* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation +* [coder](coder.md) - coder provides a CLI for working with an existing Coder installation * [coder envs create](coder_envs_create.md) - create a new environment. * [coder envs edit](coder_envs_edit.md) - edit an existing environment and initiate a rebuild. * [coder envs ls](coder_envs_ls.md) - list all environments owned by the active user diff --git a/docs/coder_images.md b/docs/coder_images.md index 386041c7..78c875ed 100644 --- a/docs/coder_images.md +++ b/docs/coder_images.md @@ -21,6 +21,6 @@ Manage existing images and/or import new ones. ### SEE ALSO -* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation +* [coder](coder.md) - coder provides a CLI for working with an existing Coder installation * [coder images ls](coder_images_ls.md) - list all images available to the active user diff --git a/docs/coder_login.md b/docs/coder_login.md index 04bf6d8e..ff20bf7e 100644 --- a/docs/coder_login.md +++ b/docs/coder_login.md @@ -3,7 +3,7 @@ Authenticate this client for future operations ``` -coder login [Coder Enterprise URL eg. https://my.coder.domain/] [flags] +coder login [Coder URL eg. https://my.coder.domain/] [flags] ``` ### Options @@ -20,5 +20,5 @@ coder login [Coder Enterprise URL eg. https://my.coder.domain/] [flags] ### SEE ALSO -* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation +* [coder](coder.md) - coder provides a CLI for working with an existing Coder installation diff --git a/docs/coder_logout.md b/docs/coder_logout.md index 60029185..cfb1f4c4 100644 --- a/docs/coder_logout.md +++ b/docs/coder_logout.md @@ -20,5 +20,5 @@ coder logout [flags] ### SEE ALSO -* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation +* [coder](coder.md) - coder provides a CLI for working with an existing Coder installation diff --git a/docs/coder_ssh.md b/docs/coder_ssh.md index 3ff31eb8..656b66fd 100644 --- a/docs/coder_ssh.md +++ b/docs/coder_ssh.md @@ -27,5 +27,5 @@ coder ssh my-dev pwd ### SEE ALSO -* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation +* [coder](coder.md) - coder provides a CLI for working with an existing Coder installation diff --git a/docs/coder_sync.md b/docs/coder_sync.md index 428323e1..b872fab4 100644 --- a/docs/coder_sync.md +++ b/docs/coder_sync.md @@ -21,5 +21,5 @@ coder sync [local directory] [:] [flags] ### SEE ALSO -* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation +* [coder](coder.md) - coder provides a CLI for working with an existing Coder installation diff --git a/docs/coder_tokens.md b/docs/coder_tokens.md index 9f347277..62bf7511 100644 --- a/docs/coder_tokens.md +++ b/docs/coder_tokens.md @@ -21,7 +21,7 @@ Statically authenticate using the token value with the `CODER_TOKEN` and `CODER_ ### SEE ALSO -* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation +* [coder](coder.md) - coder provides a CLI for working with an existing Coder installation * [coder tokens create](coder_tokens_create.md) - create generates a new API token and prints it to stdout * [coder tokens ls](coder_tokens_ls.md) - show the user's active API tokens * [coder tokens regen](coder_tokens_regen.md) - regenerate an API token by its unique ID and print the new token to stdout diff --git a/docs/coder_urls.md b/docs/coder_urls.md index 4e2921fd..39cddf89 100644 --- a/docs/coder_urls.md +++ b/docs/coder_urls.md @@ -16,7 +16,7 @@ Interact with environment DevURLs ### SEE ALSO -* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation +* [coder](coder.md) - coder provides a CLI for working with an existing Coder installation * [coder urls create](coder_urls_create.md) - Create a new devurl for an environment * [coder urls ls](coder_urls_ls.md) - List all DevURLs for an environment * [coder urls rm](coder_urls_rm.md) - Remove a dev url diff --git a/docs/coder_users.md b/docs/coder_users.md index 2eaee7de..2bfadc7c 100644 --- a/docs/coder_users.md +++ b/docs/coder_users.md @@ -16,6 +16,6 @@ Interact with Coder user accounts ### SEE ALSO -* [coder](coder.md) - coder provides a CLI for working with an existing Coder Enterprise installation +* [coder](coder.md) - coder provides a CLI for working with an existing Coder installation * [coder users ls](coder_users_ls.md) - list all user accounts diff --git a/internal/cmd/ceapi.go b/internal/cmd/ceapi.go index ddba0a62..2e7b031d 100644 --- a/internal/cmd/ceapi.go +++ b/internal/cmd/ceapi.go @@ -12,7 +12,7 @@ import ( "cdr.dev/coder-cli/pkg/clog" ) -// Helpers for working with the Coder Enterprise API. +// Helpers for working with the Coder API. // lookupUserOrgs gets a list of orgs the user is apart of. func lookupUserOrgs(user *coder.User, orgs []coder.Organization) []coder.Organization { diff --git a/internal/cmd/cmd.go b/internal/cmd/cmd.go index e9af2625..888fd84c 100644 --- a/internal/cmd/cmd.go +++ b/internal/cmd/cmd.go @@ -15,7 +15,7 @@ var verbose bool = false func Make() *cobra.Command { app := &cobra.Command{ Use: "coder", - Short: "coder provides a CLI for working with an existing Coder Enterprise installation", + Short: "coder provides a CLI for working with an existing Coder installation", SilenceErrors: true, SilenceUsage: true, DisableAutoGenTag: true, diff --git a/internal/cmd/configssh.go b/internal/cmd/configssh.go index c0b39ba9..9bfb0cd4 100644 --- a/internal/cmd/configssh.go +++ b/internal/cmd/configssh.go @@ -22,7 +22,7 @@ import ( const sshStartToken = "# ------------START-CODER-ENTERPRISE-----------" const sshStartMessage = `# The following has been auto-generated by "coder config-ssh" -# to make accessing your Coder Enterprise environments easier. +# to make accessing your Coder environments easier. # # To remove this blob, run: # @@ -43,8 +43,8 @@ func configSSHCmd() *cobra.Command { Long: "Inject the proper OpenSSH configuration into your local SSH config file.", RunE: configSSH(&configpath, &remove), } - cmd.Flags().StringVar(&configpath, "filepath", filepath.Join("~", ".ssh", "config"), "overide the default path of your ssh config file") - cmd.Flags().BoolVar(&remove, "remove", false, "remove the auto-generated Coder Enterprise ssh config") + cmd.Flags().StringVar(&configpath, "filepath", filepath.Join("~", ".ssh", "config"), "override the default path of your ssh config file") + cmd.Flags().BoolVar(&remove, "remove", false, "remove the auto-generated Coder ssh config") return cmd } @@ -74,7 +74,7 @@ func configSSH(configpath *string, remove *bool) func(cmd *cobra.Command, _ []st currentConfig, didRemoveConfig := removeOldConfig(currentConfig) if *remove { if !didRemoveConfig { - return xerrors.Errorf("the Coder Enterprise ssh configuration section could not be safely deleted or does not exist") + return xerrors.Errorf("the Coder ssh configuration section could not be safely deleted or does not exist") } err = writeStr(*configpath, currentConfig) @@ -110,7 +110,7 @@ func configSSH(configpath *string, remove *bool) func(cmd *cobra.Command, _ []st } if !sshAvailable(envsWithProviders) { - return xerrors.New("SSH is disabled or not available for any environments in your Coder Enterprise deployment.") + return xerrors.New("SSH is disabled or not available for any environments in your Coder deployment.") } newConfig := makeNewConfigs(user.Username, envsWithProviders, privateKeyFilepath) diff --git a/internal/cmd/login.go b/internal/cmd/login.go index 691178bf..27f4584c 100644 --- a/internal/cmd/login.go +++ b/internal/cmd/login.go @@ -21,7 +21,7 @@ import ( func loginCmd() *cobra.Command { return &cobra.Command{ - Use: "login [Coder Enterprise URL eg. https://my.coder.domain/]", + Use: "login [Coder URL eg. https://my.coder.domain/]", Short: "Authenticate this client for future operations", Args: xcobra.ExactArgs(1), RunE: func(cmd *cobra.Command, args []string) error { diff --git a/internal/sync/sync.go b/internal/sync/sync.go index cc6d22ea..1d356f0f 100644 --- a/internal/sync/sync.go +++ b/internal/sync/sync.go @@ -1,4 +1,4 @@ -// Package sync contains logic for establishing a file sync between a local machine and a Coder Enterprise environment. +// Package sync contains logic for establishing a file sync between a local machine and a Coder environment. package sync import (