(DOCSP-36602) Ensures --file description links to related docs pages (#2680)

sarahsimpers · web-flow · commit e1fb778ab942 · 2024-02-28T14:49:53.000-05:00
diff --git a/docs/atlascli/command/atlas-alerts-settings-create.txt b/docs/atlascli/command/atlas-alerts-settings-create.txt
@@ -52,7 +52,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to the JSON configuration file that defines alert configuration settings.
+     - Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.
    * - -h, --help
      - 
      - false
diff --git a/docs/atlascli/command/atlas-alerts-settings-update.txt b/docs/atlascli/command/atlas-alerts-settings-update.txt
@@ -68,7 +68,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to the JSON configuration file that defines alert configuration settings.
+     - Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.
    * - -h, --help
      - 
      - false
diff --git a/docs/atlascli/command/atlas-backups-schedule-update.txt b/docs/atlascli/command/atlas-backups-schedule-update.txt
@@ -64,7 +64,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines backup schedule settings.
+     - Path to an optional JSON configuration file that defines backup schedule settings. To learn about the cloud backup configuration file for the Atlas CLI, see https://dochub.mongodb.org/core/cloud-backup-config-file.
 
        Mutually exclusive with --exportBucketId, --exportFrequencyType, --referenceHourOfDay, --referenceMinuteOfHour, --restoreWindowDays, --autoExport, --noAutoExport, --updateSnapshots, --noUpdateSnapshots, --useOrgAndGroupNamesInExportPrefix, --noUseOrgAndGroupNamesInExportPrefix, --policy.
    * - -h, --help
diff --git a/docs/atlascli/command/atlas-clusters-create.txt b/docs/atlascli/command/atlas-clusters-create.txt
@@ -79,7 +79,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines cluster settings. To learn more about configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli.
+     - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about cluster configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli.
 
        Mutually exclusive with --tier, --provider, --members, --region, --diskSizeGB, --mdbVersion, --biConnector, --type, --shards, --tag.
    * - -h, --help
diff --git a/docs/atlascli/command/atlas-clusters-onlineArchives-create.txt b/docs/atlascli/command/atlas-clusters-onlineArchives-create.txt
@@ -84,7 +84,7 @@ Options
    * - --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines online archive settings. To learn more about configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config.
+     - Path to an optional JSON configuration file that defines online archive settings. To learn more about online archive configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config.
 
        Mutually exclusive with --db, --collection, --dateField, --dateFormat, --archiveAfter, --expireAfterDays, --partition.
    * - -h, --help
diff --git a/docs/atlascli/command/atlas-clusters-onlineArchives-update.txt b/docs/atlascli/command/atlas-clusters-onlineArchives-update.txt
@@ -72,7 +72,7 @@ Options
    * - --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines online archive settings. To learn more about configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config.
+     - Path to an optional JSON configuration file that defines online archive settings. To learn more about online archive configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config.
 
        Mutually exclusive with --archiveAfter, --expireAfterDays.
    * - -h, --help
diff --git a/docs/atlascli/command/atlas-clusters-update.txt b/docs/atlascli/command/atlas-clusters-update.txt
@@ -79,7 +79,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines cluster settings. To learn more about configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli.
+     - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about cluster configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli.
 
        Mutually exclusive with --tier, --diskSizeGB, --enableTerminationProtection, --disableTerminationProtection, --tag.
    * - -h, --help
diff --git a/docs/atlascli/command/atlas-clusters-upgrade.txt b/docs/atlascli/command/atlas-clusters-upgrade.txt
@@ -76,7 +76,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines cluster settings. To learn more about configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli.
+     - Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about cluster configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli.
 
        Mutually exclusive with --tier, --diskSizeGB, --mdbVersion, --enableTerminationProtection, --disableTerminationProtection, --tag.
    * - -h, --help
diff --git a/docs/atlascli/command/atlas-dataFederation-create.txt b/docs/atlascli/command/atlas-dataFederation-create.txt
@@ -68,7 +68,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines data federation settings. To learn more about configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config.
+     - Path to an optional JSON configuration file that defines data federation settings. To learn more about data federation configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config.
 
        Mutually exclusive with --region, --awsRoleId, --awsTestS3Bucket.
    * - -h, --help
diff --git a/docs/atlascli/command/atlas-dataFederation-update.txt b/docs/atlascli/command/atlas-dataFederation-update.txt
@@ -68,7 +68,7 @@ Options
    * - -f, --file
      - string
      - false
-     - Path to an optional JSON configuration file that defines data federation settings. To learn more about configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config.
+     - Path to an optional JSON configuration file that defines data federation settings. To learn more about data federation configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config.
 
        Mutually exclusive with --region, --awsRoleId, --awsTestS3Bucket.
    * - -h, --help
diff --git a/internal/usage/usage.go b/internal/usage/usage.go
@@ -126,8 +126,8 @@ dbName and collection are required only for built-in roles.`
 	TeamRole                                  = "User role that applies to all members of the specified team for the associated project. Valid values include GROUP_CLUSTER_MANAGER, GROUP_DATA_ACCESS_ADMIN, GROUP_DATA_ACCESS_READ_ONLY, GROUP_DATA_ACCESS_READ_WRITE, GROUP_OWNER, and GROUP_READ_ONLY."
 	MaxDate                                   = "Maximum created date. This option returns events whose created date is less than or equal to the specified value."
 	MinDate                                   = "Minimum created date. This option returns events whose created date is greater than or equal to the specified value."
-	ClusterFilename                           = "Path to an optional JSON configuration file that defines cluster settings. To learn more about configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli."
-	BackupFilename                            = "Path to an optional JSON configuration file that defines backup schedule settings."
+	ClusterFilename                           = "Path to an optional JSON configuration file that defines cluster settings. To learn more about cluster configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/cluster-config-file-atlascli. To learn more about cluster configuration files for MongoCLI, see https://dochub.mongodb.org/core/mms-cluster-settings-file-mcli."
+	BackupFilename                            = "Path to an optional JSON configuration file that defines backup schedule settings. To learn about the cloud backup configuration file for the Atlas CLI, see https://dochub.mongodb.org/core/cloud-backup-config-file."
 	PoliciesFilename                          = "File name that identifies an optional file with a json policy configuration."
 	SearchFilename                            = "Name of the JSON index configuration file to use. To learn about the Atlas Search index configuration file, see https://dochub.mongodb.org/core/search-index-config-file-atlascli. To learn about the Atlas Search index syntax and options that you can define in your configuration file, see https://dochub.mongodb.org/core/index-definitions-fts."
 	SearchNodesFilename                       = "Name of the JSON index configuration file to use."
@@ -457,7 +457,7 @@ dbName and collection are required only for built-in roles.`
 	EnableWatchDefault                        = "Flag that indicates whether to watch the command until it completes its execution or the watch times out."
 	WatchTimeout                              = "Time in seconds until a watch times out. After a watch times out, the CLI no longer watches the command."
 	CompactResponse                           = "Flag that enables the compact array response structure for a json output. The --compact option returns array objects as top-level responses and allows backward compatibility for scripts based on previous CLI versions. Omitting the --compact option for a json output returns array objects within a 'results' sub-array. You must specify --output json to use this option."
-	DataFederationFile                        = "Path to an optional JSON configuration file that defines data federation settings. To learn more about configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config."
+	DataFederationFile                        = "Path to an optional JSON configuration file that defines data federation settings. To learn more about data federation configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-data-federation-config."
 	BackupCompliancePolicyFile                = "Path to a JSON configuration file that defines backup compliance policy settings."
 	DataFederationType                        = "Type of Federated Database Instances to return."
 	DataFederation                            = "Identifier of the Federated Database Instance."
@@ -471,13 +471,13 @@ dbName and collection are required only for built-in roles.`
 	DeploymentTypeSetup                       = "Type of deployment that you want to create. Valid values are ATLAS or LOCAL."
 	MongodPort                                = "Port that the MongoDB server listens to for client connections."
 	ConnectWith                               = "Method for connecting to the deployment. Valid values are mongosh, compass, and skip."
-	AlertConfigFilename                       = "Path to the JSON configuration file that defines alert configuration settings."
+	AlertConfigFilename                       = "Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli."
 	DeploymentName                            = "Name of the deployment."
 	LogName                                   = "Name of the log file (e.g. mongodb.gz|mongos.gz|mongosqld.gz|mongodb-audit-log.gz|mongos-audit-log.gz)."
 	LogHostName                               = "Name of the host that stores the log files that you want to download."
 	requiredForAtlas                          = "Required when creating organizations authenticated with API Keys."
 	Decompress                                = "Flag that indicates whether to decompress the log files."
-	OnlineArchiveFilename                     = "Path to an optional JSON configuration file that defines online archive settings. To learn more about configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config."
+	OnlineArchiveFilename                     = "Path to an optional JSON configuration file that defines online archive settings. To learn more about online archive configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/atlas-cli-json-online-archive-config."
 	BindIPAll                                 = "Flag that indicates whether the LOCAL deployment port binding should happen for all IPs or only for the localhost interface 127.0.0.1."
 	FrequencyType                             = "Frequency type associated with the backup policy: 'daily', 'hourly', 'monthly', 'weekly'."
 	FrequencyInterval                         = "Number that indicates the frequency interval for a set of snapshots. " +

Original file line number	Diff line number	Diff line change
`@@ -52,7 +52,7 @@ Options`
`52`	`52`	`* - -f, --file`
`53`	`53`	`- string`
`54`	`54`	`- false`
`55`		`- - Path to the JSON configuration file that defines alert configuration settings.`
	`55`	`+ - Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.`
`56`	`56`	`* - -h, --help`
`57`	`57`	`-`
`58`	`58`	`- false`
Original file line number	Diff line number	Diff line change
`@@ -68,7 +68,7 @@ Options`
`68`	`68`	`* - -f, --file`
`69`	`69`	`- string`
`70`	`70`	`- false`
`71`		`- - Path to the JSON configuration file that defines alert configuration settings.`
	`71`	`+ - Path to the JSON configuration file that defines alert configuration settings. To learn more about alert configuration files for the Atlas CLI, see https://dochub.mongodb.org/core/alert-config-atlas-cli.`
`72`	`72`	`* - -h, --help`
`73`	`73`	`-`
`74`	`74`	`- false`