Add DO NOT EDIT disclaimer

ammario · ammario · commit 6e55629f704c · 2023-02-22T21:25:52.000Z
diff --git a/docs/cli.md b/docs/cli.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder
 
 
diff --git a/docs/cli/coder_agent.md b/docs/cli/coder_agent.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder agent
 
 
diff --git a/docs/cli/coder_config-ssh.md b/docs/cli/coder_config-ssh.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder config-ssh
 
 Add an SSH Host entry for your workspaces "ssh coder.workspace"
diff --git a/docs/cli/coder_create.md b/docs/cli/coder_create.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder create
 
 Create a workspace
diff --git a/docs/cli/coder_delete.md b/docs/cli/coder_delete.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder delete
 
 Delete a workspace
diff --git a/docs/cli/coder_dotfiles.md b/docs/cli/coder_dotfiles.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder dotfiles
 
 Checkout and install a dotfiles repository from a Git URL
diff --git a/docs/cli/coder_gitssh.md b/docs/cli/coder_gitssh.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder gitssh
 
 Wraps the "ssh" command and uses the coder gitssh key for authentication
diff --git a/docs/cli/coder_list.md b/docs/cli/coder_list.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder list
 
 List workspaces
diff --git a/docs/cli/coder_login.md b/docs/cli/coder_login.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder login
 
 Authenticate with Coder deployment
diff --git a/docs/cli/coder_logout.md b/docs/cli/coder_logout.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder logout
 
 Unauthenticate your local session
diff --git a/docs/cli/coder_parameters.md b/docs/cli/coder_parameters.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder parameters
 
 List parameters for a given scope
diff --git a/docs/cli/coder_parameters_list.md b/docs/cli/coder_parameters_list.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder parameters list
 
 
diff --git a/docs/cli/coder_ping.md b/docs/cli/coder_ping.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder ping
 
 Ping a workspace
diff --git a/docs/cli/coder_port-forward.md b/docs/cli/coder_port-forward.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder port-forward
 
 Forward ports from machine to a workspace
diff --git a/docs/cli/coder_publickey.md b/docs/cli/coder_publickey.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder publickey
 
 Output your Coder public key used for Git operations
diff --git a/docs/cli/coder_rename.md b/docs/cli/coder_rename.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder rename
 
 Rename a workspace
diff --git a/docs/cli/coder_reset-password.md b/docs/cli/coder_reset-password.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder reset-password
 
 Directly connect to the database to reset a user's password
diff --git a/docs/cli/coder_restart.md b/docs/cli/coder_restart.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder restart
 
 Restart a workspace
diff --git a/docs/cli/coder_scaletest.md b/docs/cli/coder_scaletest.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder scaletest
 
 Run a scale test against the Coder API
diff --git a/docs/cli/coder_scaletest_cleanup.md b/docs/cli/coder_scaletest_cleanup.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder scaletest cleanup
 
 Cleanup any orphaned scaletest resources
diff --git a/docs/cli/coder_scaletest_create-workspaces.md b/docs/cli/coder_scaletest_create-workspaces.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder scaletest create-workspaces
 
 Creates many workspaces and waits for them to be ready
diff --git a/docs/cli/coder_schedule.md b/docs/cli/coder_schedule.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder schedule
 
 Schedule automated start and stop times for workspaces
diff --git a/docs/cli/coder_schedule_override-stop.md b/docs/cli/coder_schedule_override-stop.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder schedule override-stop
 
 Edit stop time of active workspace
diff --git a/docs/cli/coder_schedule_show.md b/docs/cli/coder_schedule_show.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder schedule show
 
 Show workspace schedule
diff --git a/docs/cli/coder_schedule_start.md b/docs/cli/coder_schedule_start.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder schedule start
 
 Edit workspace start schedule
diff --git a/docs/cli/coder_schedule_stop.md b/docs/cli/coder_schedule_stop.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder schedule stop
 
 Edit workspace stop schedule
diff --git a/docs/cli/coder_server.md b/docs/cli/coder_server.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder server
 
 Start a Coder server
diff --git a/docs/cli/coder_server_create-admin-user.md b/docs/cli/coder_server_create-admin-user.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder server create-admin-user
 
 Create a new admin user with the given username, email and password and adds it to every organization.
diff --git a/docs/cli/coder_server_postgres-builtin-serve.md b/docs/cli/coder_server_postgres-builtin-serve.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder server postgres-builtin-serve
 
 Run the built-in PostgreSQL deployment.
diff --git a/docs/cli/coder_server_postgres-builtin-url.md b/docs/cli/coder_server_postgres-builtin-url.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder server postgres-builtin-url
 
 Output the connection URL for the built-in PostgreSQL deployment.
diff --git a/docs/cli/coder_show.md b/docs/cli/coder_show.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder show
 
 Display details of a workspace's resources and agents
diff --git a/docs/cli/coder_speedtest.md b/docs/cli/coder_speedtest.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder speedtest
 
 Run upload and download tests from your machine to a workspace
diff --git a/docs/cli/coder_ssh.md b/docs/cli/coder_ssh.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder ssh
 
 Start a shell into a workspace
diff --git a/docs/cli/coder_start.md b/docs/cli/coder_start.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder start
 
 Start a workspace
diff --git a/docs/cli/coder_state.md b/docs/cli/coder_state.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder state
 
 Manually manage Terraform state to fix broken workspaces
diff --git a/docs/cli/coder_state_pull.md b/docs/cli/coder_state_pull.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder state pull
 
 
diff --git a/docs/cli/coder_state_push.md b/docs/cli/coder_state_push.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder state push
 
 
diff --git a/docs/cli/coder_stop.md b/docs/cli/coder_stop.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder stop
 
 Stop a workspace
diff --git a/docs/cli/coder_templates.md b/docs/cli/coder_templates.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder templates
 
 Manage templates
diff --git a/docs/cli/coder_templates_create.md b/docs/cli/coder_templates_create.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder templates create
 
 Create a template from the current directory or as specified by flag
diff --git a/docs/cli/coder_templates_delete.md b/docs/cli/coder_templates_delete.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder templates delete
 
 Delete templates
diff --git a/docs/cli/coder_templates_edit.md b/docs/cli/coder_templates_edit.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder templates edit
 
 Edit the metadata of a template by name.
diff --git a/docs/cli/coder_templates_init.md b/docs/cli/coder_templates_init.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder templates init
 
 Get started with a templated template.
diff --git a/docs/cli/coder_templates_list.md b/docs/cli/coder_templates_list.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder templates list
 
 List all the templates available for the organization
diff --git a/docs/cli/coder_templates_plan.md b/docs/cli/coder_templates_plan.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder templates plan
 
 Plan a template push from the current directory
diff --git a/docs/cli/coder_templates_pull.md b/docs/cli/coder_templates_pull.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder templates pull
 
 Download the latest version of a template to a path.
diff --git a/docs/cli/coder_templates_push.md b/docs/cli/coder_templates_push.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder templates push
 
 Push a new template version from the current directory or as specified by flag
diff --git a/docs/cli/coder_templates_versions.md b/docs/cli/coder_templates_versions.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder templates versions
 
 Manage different versions of the specified template
diff --git a/docs/cli/coder_templates_versions_list.md b/docs/cli/coder_templates_versions_list.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder templates versions list
 
 List all the versions of the specified template
diff --git a/docs/cli/coder_tokens.md b/docs/cli/coder_tokens.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder tokens
 
 Manage personal access tokens
diff --git a/docs/cli/coder_tokens_create.md b/docs/cli/coder_tokens_create.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder tokens create
 
 Create a tokens
diff --git a/docs/cli/coder_tokens_list.md b/docs/cli/coder_tokens_list.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder tokens list
 
 List tokens
diff --git a/docs/cli/coder_tokens_remove.md b/docs/cli/coder_tokens_remove.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder tokens remove
 
 Delete a token
diff --git a/docs/cli/coder_update.md b/docs/cli/coder_update.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder update
 
 Update a workspace
diff --git a/docs/cli/coder_users.md b/docs/cli/coder_users.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder users
 
 Manage users
diff --git a/docs/cli/coder_users_activate.md b/docs/cli/coder_users_activate.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder users activate
 
 Update a user's status to 'active'. Active users can fully interact with the platform
diff --git a/docs/cli/coder_users_create.md b/docs/cli/coder_users_create.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder users create
 
 
diff --git a/docs/cli/coder_users_list.md b/docs/cli/coder_users_list.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder users list
 
 
diff --git a/docs/cli/coder_users_show.md b/docs/cli/coder_users_show.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder users show
 
 Show a single user. Use 'me' to indicate the currently authenticated user.
diff --git a/docs/cli/coder_users_suspend.md b/docs/cli/coder_users_suspend.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder users suspend
 
 Update a user's status to 'suspended'. A suspended user cannot log into the platform
diff --git a/docs/cli/coder_version.md b/docs/cli/coder_version.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder version
 
 Show coder version
diff --git a/docs/cli/coder_vscodessh.md b/docs/cli/coder_vscodessh.md
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # coder vscodessh
 
 
diff --git a/scripts/clidocgen/command.tpl b/scripts/clidocgen/command.tpl
@@ -1,3 +1,4 @@
+<!-- DO NOT EDIT | GENERATED CONTENT -->
 # {{ .Name }}
 
 {{ .Cmd.Short }}

Original file line number	Diff line number	Diff line change
`@@ -1,3 +1,4 @@`
	`1`	`+<!-- DO NOT EDIT \| GENERATED CONTENT -->`
`1`	`2`	`# {{ .Name }}`
`2`	`3`
`3`	`4`	`{{ .Cmd.Short }}`