Skip to content

Commit

Permalink
docs: better command reference titles (argoproj#15567)
Browse files Browse the repository at this point in the history
Signed-off-by: Michael Crenshaw <350466+crenshaw-dev@users.noreply.github.com>
  • Loading branch information
crenshaw-dev committed Sep 19, 2023
1 parent d58d1d3 commit 80e2e8c
Show file tree
Hide file tree
Showing 157 changed files with 329 additions and 5 deletions.
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd-application-controller` Command Reference

## argocd-application-controller

Run ArgoCD Application Controller
Expand Down
2 changes: 2 additions & 0 deletions docs/operator-manual/server-commands/argocd-dex.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd-dex` Command Reference

## argocd-dex

argocd-dex tools used by Argo CD
Expand Down
2 changes: 2 additions & 0 deletions docs/operator-manual/server-commands/argocd-dex_gendexcfg.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd-dex gendexcfg` Command Reference

## argocd-dex gendexcfg

Generates a dex config from Argo CD settings
Expand Down
2 changes: 2 additions & 0 deletions docs/operator-manual/server-commands/argocd-dex_rundex.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/operator-manual/server-commands/argocd-repo-server.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd-repo-server` Command Reference

## argocd-repo-server

Run ArgoCD Repository Server
Expand Down
2 changes: 2 additions & 0 deletions docs/operator-manual/server-commands/argocd-server.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd-server` Command Reference

## argocd-server

Run the ArgoCD API server
Expand Down
2 changes: 2 additions & 0 deletions docs/operator-manual/server-commands/argocd-server_version.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd-server version` Command Reference

## argocd-server version

Print version information
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd` Command Reference

## argocd

argocd controls a Argo CD server
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_account.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd account` Command Reference

## argocd account

Manage account settings
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_account_bcrypt.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd account bcrypt` Command Reference

## argocd account bcrypt

Generate bcrypt hash for the admin password
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_account_can-i.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd account can-i` Command Reference

## argocd account can-i

Can I
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_account_delete-token.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd account delete-token` Command Reference

## argocd account delete-token

Deletes account token
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_account_generate-token.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd account generate-token` Command Reference

## argocd account generate-token

Generate account token
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_account_get-user-info.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd account get-user-info` Command Reference

## argocd account get-user-info

Get user info
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_account_get.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd account get` Command Reference

## argocd account get

Get account details
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_account_list.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd account list` Command Reference

## argocd account list

List accounts
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_account_update-password.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd account update-password` Command Reference

## argocd account update-password

Update an account's password
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_app.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin app` Command Reference

## argocd admin app

Manage applications configuration
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_app_generate-spec.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin app generate-spec` Command Reference

## argocd admin app generate-spec

Generate declarative config for an application
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_cluster.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin cluster` Command Reference

## argocd admin cluster

Manage clusters configuration
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin cluster generate-spec` Command Reference

## argocd admin cluster generate-spec

Generate declarative config for a cluster
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_cluster_kubeconfig.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin cluster kubeconfig` Command Reference

## argocd admin cluster kubeconfig

Generates kubeconfig for the specified cluster
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_cluster_namespaces.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin cluster namespaces` Command Reference

## argocd admin cluster namespaces

Print information namespaces which Argo CD manages in each cluster.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_cluster_shards.md
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_cluster_stats.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin cluster stats` Command Reference

## argocd admin cluster stats

Prints information cluster statistics and inferred shard number
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_dashboard.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin dashboard` Command Reference

## argocd admin dashboard

Starts Argo CD Web UI locally
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_export.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin export` Command Reference

## argocd admin export

Export all Argo CD data to stdout (default) or a file
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_import.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin import` Command Reference

## argocd admin import

Import Argo CD data from stdin (specify `-') or a file
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_initial-password.md
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_notifications.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin notifications` Command Reference

## argocd admin notifications

Set of CLI commands that helps manage notifications settings
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin notifications template` Command Reference

## argocd admin notifications template

Notification templates related commands
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin notifications template get` Command Reference

## argocd admin notifications template get

Prints information about configured templates
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin notifications trigger` Command Reference

## argocd admin notifications trigger

Notification triggers related commands
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin notifications trigger get` Command Reference

## argocd admin notifications trigger get

Prints information about configured triggers
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin notifications trigger run` Command Reference

## argocd admin notifications trigger run

Evaluates specified trigger condition and prints the result
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_proj.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin proj` Command Reference

## argocd admin proj

Manage projects configuration
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_proj_generate-spec.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin proj generate-spec` Command Reference

## argocd admin proj generate-spec

Generate declarative config for a project
Expand Down
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_repo.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin repo` Command Reference

## argocd admin repo

Manage repositories configuration
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_repo_generate-spec.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin repo generate-spec` Command Reference

## argocd admin repo generate-spec

Generate declarative config for a repo
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_settings.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin settings` Command Reference

## argocd admin settings

Provides set of commands for settings validation and troubleshooting
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_settings_rbac.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin settings rbac` Command Reference

## argocd admin settings rbac

Validate and test RBAC configuration
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_settings_rbac_can.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin settings rbac can` Command Reference

## argocd admin settings rbac can

Check RBAC permissions for a role or subject
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin settings rbac validate` Command Reference

## argocd admin settings rbac validate

Validate RBAC policy
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin settings resource-overrides` Command Reference

## argocd admin settings resource-overrides

Troubleshoot resource overrides
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin settings resource-overrides health` Command Reference

## argocd admin settings resource-overrides health

Assess resource health
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -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
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin settings resource-overrides list-actions` Command Reference

## argocd admin settings resource-overrides list-actions

List available resource actions
Expand Down
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin settings resource-overrides run-action` Command Reference

## argocd admin settings resource-overrides run-action

Executes resource action
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_admin_settings_validate.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd admin settings validate` Command Reference

## argocd admin settings validate

Validate settings
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_app.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd app` Command Reference

## argocd app

Manage applications
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_app_actions.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd app actions` Command Reference

## argocd app actions

Manage Resource actions
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_app_actions_list.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd app actions list` Command Reference

## argocd app actions list

Lists available actions on a resource
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_app_actions_run.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd app actions run` Command Reference

## argocd app actions run

Runs an available action on resource(s)
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_app_create.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd app create` Command Reference

## argocd app create

Create an application
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_app_delete-resource.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd app delete-resource` Command Reference

## argocd app delete-resource

Delete resource in an application
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_app_delete.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd app delete` Command Reference

## argocd app delete

Delete an application
Expand Down
2 changes: 2 additions & 0 deletions docs/user-guide/commands/argocd_app_diff.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
# `argocd app diff` Command Reference

## argocd app diff

Perform a diff against the target and live state.
Expand Down
Loading

0 comments on commit 80e2e8c

Please sign in to comment.