docs: better command reference titles (argoproj#15567) (argoproj#15568)

Signed-off-by: Michael Crenshaw <[email protected]>
lukaszgyg · Jan 12, 2024 · c98048e · c98048e
1 parent 710b4c8
commit c98048e
Show file tree

Hide file tree

Showing 157 changed files with 329 additions and 5 deletions.
diff --git a/docs/operator-manual/server-commands/argocd-application-controller.md b/docs/operator-manual/server-commands/argocd-application-controller.md
@@ -1,3 +1,5 @@
+# `argocd-application-controller` Command Reference
+
 ## argocd-application-controller
 
 Run ArgoCD Application Controller

diff --git a/docs/operator-manual/server-commands/argocd-dex.md b/docs/operator-manual/server-commands/argocd-dex.md
@@ -1,3 +1,5 @@
+# `argocd-dex` Command Reference
+
 ## argocd-dex
 
 argocd-dex tools used by Argo CD

diff --git a/docs/operator-manual/server-commands/argocd-dex_gendexcfg.md b/docs/operator-manual/server-commands/argocd-dex_gendexcfg.md
@@ -1,3 +1,5 @@
+# `argocd-dex gendexcfg` Command Reference
+
 ## argocd-dex gendexcfg
 
 Generates a dex config from Argo CD settings

diff --git a/docs/operator-manual/server-commands/argocd-dex_rundex.md b/docs/operator-manual/server-commands/argocd-dex_rundex.md
@@ -1,3 +1,5 @@
+# `argocd-dex rundex` Command Reference
+
 ## argocd-dex rundex
 
 Runs dex generating a config using settings from the Argo CD configmap and secret

diff --git a/docs/operator-manual/server-commands/argocd-repo-server.md b/docs/operator-manual/server-commands/argocd-repo-server.md
@@ -1,3 +1,5 @@
+# `argocd-repo-server` Command Reference
+
 ## argocd-repo-server
 
 Run ArgoCD Repository Server

diff --git a/docs/operator-manual/server-commands/argocd-server.md b/docs/operator-manual/server-commands/argocd-server.md
@@ -1,3 +1,5 @@
+# `argocd-server` Command Reference
+
 ## argocd-server
 
 Run the ArgoCD API server

diff --git a/docs/operator-manual/server-commands/argocd-server_version.md b/docs/operator-manual/server-commands/argocd-server_version.md
@@ -1,3 +1,5 @@
+# `argocd-server version` Command Reference
+
 ## argocd-server version
 
 Print version information

diff --git a/docs/user-guide/commands/argocd.md b/docs/user-guide/commands/argocd.md
@@ -1,3 +1,5 @@
+# `argocd` Command Reference
+
 ## argocd
 
 argocd controls a Argo CD server

diff --git a/docs/user-guide/commands/argocd_account.md b/docs/user-guide/commands/argocd_account.md
@@ -1,3 +1,5 @@
+# `argocd account` Command Reference
+
 ## argocd account
 
 Manage account settings

diff --git a/docs/user-guide/commands/argocd_account_bcrypt.md b/docs/user-guide/commands/argocd_account_bcrypt.md
@@ -1,3 +1,5 @@
+# `argocd account bcrypt` Command Reference
+
 ## argocd account bcrypt
 
 Generate bcrypt hash for the admin password

diff --git a/docs/user-guide/commands/argocd_account_can-i.md b/docs/user-guide/commands/argocd_account_can-i.md
@@ -1,3 +1,5 @@
+# `argocd account can-i` Command Reference
+
 ## argocd account can-i
 
 Can I

diff --git a/docs/user-guide/commands/argocd_account_delete-token.md b/docs/user-guide/commands/argocd_account_delete-token.md
@@ -1,3 +1,5 @@
+# `argocd account delete-token` Command Reference
+
 ## argocd account delete-token
 
 Deletes account token

diff --git a/docs/user-guide/commands/argocd_account_generate-token.md b/docs/user-guide/commands/argocd_account_generate-token.md
@@ -1,3 +1,5 @@
+# `argocd account generate-token` Command Reference
+
 ## argocd account generate-token
 
 Generate account token

diff --git a/docs/user-guide/commands/argocd_account_get-user-info.md b/docs/user-guide/commands/argocd_account_get-user-info.md
@@ -1,3 +1,5 @@
+# `argocd account get-user-info` Command Reference
+
 ## argocd account get-user-info
 
 Get user info

diff --git a/docs/user-guide/commands/argocd_account_get.md b/docs/user-guide/commands/argocd_account_get.md
@@ -1,3 +1,5 @@
+# `argocd account get` Command Reference
+
 ## argocd account get
 
 Get account details

diff --git a/docs/user-guide/commands/argocd_account_list.md b/docs/user-guide/commands/argocd_account_list.md
@@ -1,3 +1,5 @@
+# `argocd account list` Command Reference
+
 ## argocd account list
 
 List accounts

diff --git a/docs/user-guide/commands/argocd_account_update-password.md b/docs/user-guide/commands/argocd_account_update-password.md
@@ -1,3 +1,5 @@
+# `argocd account update-password` Command Reference
+
 ## argocd account update-password
 
 Update an account's password

diff --git a/docs/user-guide/commands/argocd_admin.md b/docs/user-guide/commands/argocd_admin.md
@@ -1,3 +1,5 @@
+# `argocd admin` Command Reference
+
 ## argocd admin
 
 Contains a set of commands useful for Argo CD administrators and requires direct Kubernetes access

diff --git a/docs/user-guide/commands/argocd_admin_app.md b/docs/user-guide/commands/argocd_admin_app.md
@@ -1,3 +1,5 @@
+# `argocd admin app` Command Reference
+
 ## argocd admin app
 
 Manage applications configuration

diff --git a/docs/user-guide/commands/argocd_admin_app_diff-reconcile-results.md b/docs/user-guide/commands/argocd_admin_app_diff-reconcile-results.md
@@ -1,3 +1,5 @@
+# `argocd admin app diff-reconcile-results` Command Reference
+
 ## argocd admin app diff-reconcile-results
 
 Compare results of two reconciliations and print diff.

diff --git a/docs/user-guide/commands/argocd_admin_app_generate-spec.md b/docs/user-guide/commands/argocd_admin_app_generate-spec.md
@@ -1,3 +1,5 @@
+# `argocd admin app generate-spec` Command Reference
+
 ## argocd admin app generate-spec
 
 Generate declarative config for an application

diff --git a/docs/user-guide/commands/argocd_admin_app_get-reconcile-results.md b/docs/user-guide/commands/argocd_admin_app_get-reconcile-results.md
@@ -1,3 +1,5 @@
+# `argocd admin app get-reconcile-results` Command Reference
+
 ## argocd admin app get-reconcile-results
 
 Reconcile all applications and stores reconciliation summary in the specified file.

diff --git a/docs/user-guide/commands/argocd_admin_cluster.md b/docs/user-guide/commands/argocd_admin_cluster.md
@@ -1,3 +1,5 @@
+# `argocd admin cluster` Command Reference
+
 ## argocd admin cluster
 
 Manage clusters configuration

diff --git a/docs/user-guide/commands/argocd_admin_cluster_generate-spec.md b/docs/user-guide/commands/argocd_admin_cluster_generate-spec.md
@@ -1,3 +1,5 @@
+# `argocd admin cluster generate-spec` Command Reference
+
 ## argocd admin cluster generate-spec
 
 Generate declarative config for a cluster

diff --git a/docs/user-guide/commands/argocd_admin_cluster_kubeconfig.md b/docs/user-guide/commands/argocd_admin_cluster_kubeconfig.md
@@ -1,3 +1,5 @@
+# `argocd admin cluster kubeconfig` Command Reference
+
 ## argocd admin cluster kubeconfig
 
 Generates kubeconfig for the specified cluster

diff --git a/docs/user-guide/commands/argocd_admin_cluster_namespaces.md b/docs/user-guide/commands/argocd_admin_cluster_namespaces.md
@@ -1,3 +1,5 @@
+# `argocd admin cluster namespaces` Command Reference
+
 ## argocd admin cluster namespaces
 
 Print information namespaces which Argo CD manages in each cluster.

diff --git a/.../user-guide/commands/argocd_admin_cluster_namespaces_disable-namespaced-mode.md b/.../user-guide/commands/argocd_admin_cluster_namespaces_disable-namespaced-mode.md
@@ -1,3 +1,5 @@
+# `argocd admin cluster namespaces disable-namespaced-mode` Command Reference
+
 ## argocd admin cluster namespaces disable-namespaced-mode
 
 Disable namespaced mode for clusters which name matches to the specified pattern.

diff --git a/docs/user-guide/commands/argocd_admin_cluster_namespaces_enable-namespaced-mode.md b/docs/user-guide/commands/argocd_admin_cluster_namespaces_enable-namespaced-mode.md
@@ -1,3 +1,5 @@
+# `argocd admin cluster namespaces enable-namespaced-mode` Command Reference
+
 ## argocd admin cluster namespaces enable-namespaced-mode
 
 Enable namespaced mode for clusters which name matches to the specified pattern.

diff --git a/docs/user-guide/commands/argocd_admin_cluster_shards.md b/docs/user-guide/commands/argocd_admin_cluster_shards.md
@@ -1,3 +1,5 @@
+# `argocd admin cluster shards` Command Reference
+
 ## argocd admin cluster shards
 
 Print information about each controller shard and portion of Kubernetes resources it is responsible for.

diff --git a/docs/user-guide/commands/argocd_admin_cluster_stats.md b/docs/user-guide/commands/argocd_admin_cluster_stats.md
@@ -1,3 +1,5 @@
+# `argocd admin cluster stats` Command Reference
+
 ## argocd admin cluster stats
 
 Prints information cluster statistics and inferred shard number

diff --git a/docs/user-guide/commands/argocd_admin_dashboard.md b/docs/user-guide/commands/argocd_admin_dashboard.md
@@ -1,3 +1,5 @@
+# `argocd admin dashboard` Command Reference
+
 ## argocd admin dashboard
 
 Starts Argo CD Web UI locally

diff --git a/docs/user-guide/commands/argocd_admin_export.md b/docs/user-guide/commands/argocd_admin_export.md
@@ -1,3 +1,5 @@
+# `argocd admin export` Command Reference
+
 ## argocd admin export
 
 Export all Argo CD data to stdout (default) or a file

diff --git a/docs/user-guide/commands/argocd_admin_import.md b/docs/user-guide/commands/argocd_admin_import.md
@@ -1,3 +1,5 @@
+# `argocd admin import` Command Reference
+
 ## argocd admin import
 
 Import Argo CD data from stdin (specify `-') or a file

diff --git a/docs/user-guide/commands/argocd_admin_initial-password.md b/docs/user-guide/commands/argocd_admin_initial-password.md
@@ -1,3 +1,5 @@
+# `argocd admin initial-password` Command Reference
+
 ## argocd admin initial-password
 
 Prints initial password to log in to Argo CD for the first time

diff --git a/docs/user-guide/commands/argocd_admin_notifications.md b/docs/user-guide/commands/argocd_admin_notifications.md
@@ -1,3 +1,5 @@
+# `argocd admin notifications` Command Reference
+
 ## argocd admin notifications
 
 Set of CLI commands that helps manage notifications settings

diff --git a/docs/user-guide/commands/argocd_admin_notifications_template.md b/docs/user-guide/commands/argocd_admin_notifications_template.md
@@ -1,3 +1,5 @@
+# `argocd admin notifications template` Command Reference
+
 ## argocd admin notifications template
 
 Notification templates related commands

diff --git a/docs/user-guide/commands/argocd_admin_notifications_template_get.md b/docs/user-guide/commands/argocd_admin_notifications_template_get.md
@@ -1,3 +1,5 @@
+# `argocd admin notifications template get` Command Reference
+
 ## argocd admin notifications template get
 
 Prints information about configured templates

diff --git a/docs/user-guide/commands/argocd_admin_notifications_template_notify.md b/docs/user-guide/commands/argocd_admin_notifications_template_notify.md
@@ -1,3 +1,5 @@
+# `argocd admin notifications template notify` Command Reference
+
 ## argocd admin notifications template notify
 
 Generates notification using the specified template and send it to specified recipients

diff --git a/docs/user-guide/commands/argocd_admin_notifications_trigger.md b/docs/user-guide/commands/argocd_admin_notifications_trigger.md
@@ -1,3 +1,5 @@
+# `argocd admin notifications trigger` Command Reference
+
 ## argocd admin notifications trigger
 
 Notification triggers related commands

diff --git a/docs/user-guide/commands/argocd_admin_notifications_trigger_get.md b/docs/user-guide/commands/argocd_admin_notifications_trigger_get.md
@@ -1,3 +1,5 @@
+# `argocd admin notifications trigger get` Command Reference
+
 ## argocd admin notifications trigger get
 
 Prints information about configured triggers

diff --git a/docs/user-guide/commands/argocd_admin_notifications_trigger_run.md b/docs/user-guide/commands/argocd_admin_notifications_trigger_run.md
@@ -1,3 +1,5 @@
+# `argocd admin notifications trigger run` Command Reference
+
 ## argocd admin notifications trigger run
 
 Evaluates specified trigger condition and prints the result

diff --git a/docs/user-guide/commands/argocd_admin_proj.md b/docs/user-guide/commands/argocd_admin_proj.md
@@ -1,3 +1,5 @@
+# `argocd admin proj` Command Reference
+
 ## argocd admin proj
 
 Manage projects configuration

diff --git a/docs/user-guide/commands/argocd_admin_proj_generate-allow-list.md b/docs/user-guide/commands/argocd_admin_proj_generate-allow-list.md
@@ -1,3 +1,5 @@
+# `argocd admin proj generate-allow-list` Command Reference
+
 ## argocd admin proj generate-allow-list
 
 Generates project allow list from the specified clusterRole file

diff --git a/docs/user-guide/commands/argocd_admin_proj_generate-spec.md b/docs/user-guide/commands/argocd_admin_proj_generate-spec.md
@@ -1,3 +1,5 @@
+# `argocd admin proj generate-spec` Command Reference
+
 ## argocd admin proj generate-spec
 
 Generate declarative config for a project

diff --git a/docs/user-guide/commands/argocd_admin_proj_update-role-policy.md b/docs/user-guide/commands/argocd_admin_proj_update-role-policy.md
@@ -1,3 +1,5 @@
+# `argocd admin proj update-role-policy` Command Reference
+
 ## argocd admin proj update-role-policy
 
 Implement bulk project role update. Useful to back-fill existing project policies or remove obsolete actions.

diff --git a/docs/user-guide/commands/argocd_admin_repo.md b/docs/user-guide/commands/argocd_admin_repo.md
@@ -1,3 +1,5 @@
+# `argocd admin repo` Command Reference
+
 ## argocd admin repo
 
 Manage repositories configuration

diff --git a/docs/user-guide/commands/argocd_admin_repo_generate-spec.md b/docs/user-guide/commands/argocd_admin_repo_generate-spec.md
@@ -1,3 +1,5 @@
+# `argocd admin repo generate-spec` Command Reference
+
 ## argocd admin repo generate-spec
 
 Generate declarative config for a repo

diff --git a/docs/user-guide/commands/argocd_admin_settings.md b/docs/user-guide/commands/argocd_admin_settings.md
@@ -1,3 +1,5 @@
+# `argocd admin settings` Command Reference
+
 ## argocd admin settings
 
 Provides set of commands for settings validation and troubleshooting

diff --git a/docs/user-guide/commands/argocd_admin_settings_rbac.md b/docs/user-guide/commands/argocd_admin_settings_rbac.md
@@ -1,3 +1,5 @@
+# `argocd admin settings rbac` Command Reference
+
 ## argocd admin settings rbac
 
 Validate and test RBAC configuration

diff --git a/docs/user-guide/commands/argocd_admin_settings_rbac_can.md b/docs/user-guide/commands/argocd_admin_settings_rbac_can.md
@@ -1,3 +1,5 @@
+# `argocd admin settings rbac can` Command Reference
+
 ## argocd admin settings rbac can
 
 Check RBAC permissions for a role or subject

diff --git a/docs/user-guide/commands/argocd_admin_settings_rbac_validate.md b/docs/user-guide/commands/argocd_admin_settings_rbac_validate.md
@@ -1,3 +1,5 @@
+# `argocd admin settings rbac validate` Command Reference
+
 ## argocd admin settings rbac validate
 
 Validate RBAC policy

diff --git a/docs/user-guide/commands/argocd_admin_settings_resource-overrides.md b/docs/user-guide/commands/argocd_admin_settings_resource-overrides.md
@@ -1,3 +1,5 @@
+# `argocd admin settings resource-overrides` Command Reference
+
 ## argocd admin settings resource-overrides
 
 Troubleshoot resource overrides

diff --git a/docs/user-guide/commands/argocd_admin_settings_resource-overrides_health.md b/docs/user-guide/commands/argocd_admin_settings_resource-overrides_health.md
@@ -1,3 +1,5 @@
+# `argocd admin settings resource-overrides health` Command Reference
+
 ## argocd admin settings resource-overrides health
 
 Assess resource health

diff --git a/...r-guide/commands/argocd_admin_settings_resource-overrides_ignore-differences.md b/...r-guide/commands/argocd_admin_settings_resource-overrides_ignore-differences.md
@@ -1,3 +1,5 @@
+# `argocd admin settings resource-overrides ignore-differences` Command Reference
+
 ## argocd admin settings resource-overrides ignore-differences
 
 Renders fields excluded from diffing

diff --git a/...de/commands/argocd_admin_settings_resource-overrides_ignore-resource-updates.md b/...de/commands/argocd_admin_settings_resource-overrides_ignore-resource-updates.md
@@ -1,3 +1,5 @@
+# `argocd admin settings resource-overrides ignore-resource-updates` Command Reference
+
 ## argocd admin settings resource-overrides ignore-resource-updates
 
 Renders fields excluded from resource updates

diff --git a/docs/user-guide/commands/argocd_admin_settings_resource-overrides_list-actions.md b/docs/user-guide/commands/argocd_admin_settings_resource-overrides_list-actions.md
@@ -1,3 +1,5 @@
+# `argocd admin settings resource-overrides list-actions` Command Reference
+
 ## argocd admin settings resource-overrides list-actions
 
 List available resource actions

diff --git a/docs/user-guide/commands/argocd_admin_settings_resource-overrides_run-action.md b/docs/user-guide/commands/argocd_admin_settings_resource-overrides_run-action.md
@@ -1,3 +1,5 @@
+# `argocd admin settings resource-overrides run-action` Command Reference
+
 ## argocd admin settings resource-overrides run-action
 
 Executes resource action

diff --git a/docs/user-guide/commands/argocd_admin_settings_validate.md b/docs/user-guide/commands/argocd_admin_settings_validate.md
@@ -1,3 +1,5 @@
+# `argocd admin settings validate` Command Reference
+
 ## argocd admin settings validate
 
 Validate settings

diff --git a/docs/user-guide/commands/argocd_app.md b/docs/user-guide/commands/argocd_app.md
@@ -1,3 +1,5 @@
+# `argocd app` Command Reference
+
 ## argocd app
 
 Manage applications

diff --git a/docs/user-guide/commands/argocd_app_actions.md b/docs/user-guide/commands/argocd_app_actions.md
@@ -1,3 +1,5 @@
+# `argocd app actions` Command Reference
+
 ## argocd app actions
 
 Manage Resource actions

diff --git a/docs/user-guide/commands/argocd_app_actions_list.md b/docs/user-guide/commands/argocd_app_actions_list.md
@@ -1,3 +1,5 @@
+# `argocd app actions list` Command Reference
+
 ## argocd app actions list
 
 Lists available actions on a resource

diff --git a/docs/user-guide/commands/argocd_app_actions_run.md b/docs/user-guide/commands/argocd_app_actions_run.md
@@ -1,3 +1,5 @@
+# `argocd app actions run` Command Reference
+
 ## argocd app actions run
 
 Runs an available action on resource(s)

diff --git a/docs/user-guide/commands/argocd_app_create.md b/docs/user-guide/commands/argocd_app_create.md
@@ -1,3 +1,5 @@
+# `argocd app create` Command Reference
+
 ## argocd app create
 
 Create an application

diff --git a/docs/user-guide/commands/argocd_app_delete-resource.md b/docs/user-guide/commands/argocd_app_delete-resource.md
@@ -1,3 +1,5 @@
+# `argocd app delete-resource` Command Reference
+
 ## argocd app delete-resource
 
 Delete resource in an application

diff --git a/docs/user-guide/commands/argocd_app_delete.md b/docs/user-guide/commands/argocd_app_delete.md
@@ -1,3 +1,5 @@
+# `argocd app delete` Command Reference
+
 ## argocd app delete
 
 Delete an application

diff --git a/docs/user-guide/commands/argocd_app_diff.md b/docs/user-guide/commands/argocd_app_diff.md
@@ -1,3 +1,5 @@
+# `argocd app diff` Command Reference
+
 ## argocd app diff
 
 Perform a diff against the target and live state.