From 7dc829e943849cbe3aaf128033d8b7c2a2bd45e7 Mon Sep 17 00:00:00 2001 From: Bianca Lisle Date: Thu, 3 Jul 2025 12:58:56 +0100 Subject: [PATCH 1/2] address ' Monospace text uses two backticks () Did you mean: payload.json WARNING(command/atlas-api-databaseUsers-createDatabaseUser.txt:133ish): Monospace text uses two backticks' --- tools/cmd/docs/transformations.go | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/tools/cmd/docs/transformations.go b/tools/cmd/docs/transformations.go index 3fcb767e17..c0c5013c55 100644 --- a/tools/cmd/docs/transformations.go +++ b/tools/cmd/docs/transformations.go @@ -194,7 +194,7 @@ func buildExamples(cmd *cobra.Command, examples map[string][]metadatatypes.Examp if tabs { sb.WriteString(" ") } - sb.WriteString("Create the file below and save it as ``payload.json``\n\n") + sb.WriteString("Create the file below and save it as `payload.json`\n\n") includePayloadFileName := fmt.Sprintf("%s-%s-%s-payload.json", strings.ReplaceAll(cmd.CommandPath(), " ", "-"), version, source) const permissions = 0600 @@ -214,7 +214,7 @@ func buildExamples(cmd *cobra.Command, examples map[string][]metadatatypes.Examp if tabs { sb.WriteString(" ") } - sb.WriteString("After creating ``payload.json``, run the command below in the same directory.\n\n") + sb.WriteString("After creating `payload.json`, run the command below in the same directory.\n\n") } else if tabs { sb.WriteString(" ") } From 29771ea2a3402cc2e9baff25fefb01b4e2363465 Mon Sep 17 00:00:00 2001 From: Bianca Lisle Date: Thu, 3 Jul 2025 13:03:28 +0100 Subject: [PATCH 2/2] update docs --- ...as-api-cloudBackups-createExportBucket.txt | 16 ++++++------- .../atlas-api-clusters-createCluster.txt | 12 +++++----- .../atlas-api-clusters-updateCluster.txt | 4 ++-- ...s-api-databaseUsers-createDatabaseUser.txt | 24 +++++++++---------- ...IpAccessList-createProjectIpAccessList.txt | 4 ++-- .../atlas-api-projects-createProject.txt | 4 ++-- .../atlas-api-projects-updateProject.txt | 4 ++-- ...as-api-rollingIndex-createRollingIndex.txt | 12 +++++----- 8 files changed, 40 insertions(+), 40 deletions(-) diff --git a/docs/command/atlas-api-cloudBackups-createExportBucket.txt b/docs/command/atlas-api-cloudBackups-createExportBucket.txt index 3e03bb294d..986b4a286e 100644 --- a/docs/command/atlas-api-cloudBackups-createExportBucket.txt +++ b/docs/command/atlas-api-cloudBackups-createExportBucket.txt @@ -107,11 +107,11 @@ Examples AWS - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2023-01-01-aws-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2023-01-01-aws.sh :language: shell @@ -120,11 +120,11 @@ Examples AWS - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2024-05-30-aws-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2024-05-30-aws.sh :language: shell @@ -133,11 +133,11 @@ Examples Azure - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2024-05-30-azure-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2024-05-30-azure.sh :language: shell @@ -146,11 +146,11 @@ Examples GCP - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2024-05-30-gcp-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-cloudBackups-createExportBucket-2024-05-30-gcp.sh :language: shell diff --git a/docs/command/atlas-api-clusters-createCluster.txt b/docs/command/atlas-api-clusters-createCluster.txt index b7a9dc92ff..6c13fe1924 100644 --- a/docs/command/atlas-api-clusters-createCluster.txt +++ b/docs/command/atlas-api-clusters-createCluster.txt @@ -118,11 +118,11 @@ Examples Cluster - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-clusters-createCluster-2024-08-05-cluster-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-clusters-createCluster-2024-08-05-cluster.sh :language: shell @@ -131,11 +131,11 @@ Examples Cluster - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-clusters-createCluster-2024-10-23-cluster-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-clusters-createCluster-2024-10-23-cluster.sh :language: shell @@ -144,11 +144,11 @@ Examples Creates a new M10 replica set cluster in AWS US East region running MongoDB 6.0 - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-clusters-createCluster-2024-10-23-create_cluster-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-clusters-createCluster-2024-10-23-create_cluster.sh :language: shell diff --git a/docs/command/atlas-api-clusters-updateCluster.txt b/docs/command/atlas-api-clusters-updateCluster.txt index 1979a7a154..8bf9b3818b 100644 --- a/docs/command/atlas-api-clusters-updateCluster.txt +++ b/docs/command/atlas-api-clusters-updateCluster.txt @@ -114,11 +114,11 @@ Examples Updates the cluster to increase disk size to 20GB and increase node count to 5 -Create the file below and save it as ``payload.json`` +Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-clusters-updateCluster-2024-10-23-update_cluster-payload.json :language: shell -After creating ``payload.json``, run the command below in the same directory. +After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-clusters-updateCluster-2024-10-23-update_cluster.sh :language: shell diff --git a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt index d846746b33..215b5c859e 100644 --- a/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt +++ b/docs/command/atlas-api-databaseUsers-createDatabaseUser.txt @@ -107,11 +107,11 @@ Examples AWS IAM Authentication - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-aws_iam_authentication-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-aws_iam_authentication.sh :language: shell @@ -120,11 +120,11 @@ Examples LDAP Authentication - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-ldap_authentication-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-ldap_authentication.sh :language: shell @@ -133,11 +133,11 @@ Examples OIDC Workforce Federated Authentication - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workforce_federated_authentication-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workforce_federated_authentication.sh :language: shell @@ -146,11 +146,11 @@ Examples OIDC Workload Federated Authentication - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workload_federated_authentication-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-oidc_workload_federated_authentication.sh :language: shell @@ -159,11 +159,11 @@ Examples SCRAM-SHA Authentication - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-scram-sha_authentication-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-scram-sha_authentication.sh :language: shell @@ -172,11 +172,11 @@ Examples X509 Authentication - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-x509_authentication-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-databaseUsers-createDatabaseUser-2023-01-01-x509_authentication.sh :language: shell diff --git a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt index 0d5d2b6106..674beb53b6 100644 --- a/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt +++ b/docs/command/atlas-api-projectIpAccessList-createProjectIpAccessList.txt @@ -114,11 +114,11 @@ Examples Adds multiple access list entries to the specified project -Create the file below and save it as ``payload.json`` +Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-projectIpAccessList-createProjectIpAccessList-2023-01-01-project_ip_access_list_add-payload.json :language: shell -After creating ``payload.json``, run the command below in the same directory. +After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-projectIpAccessList-createProjectIpAccessList-2023-01-01-project_ip_access_list_add.sh :language: shell diff --git a/docs/command/atlas-api-projects-createProject.txt b/docs/command/atlas-api-projects-createProject.txt index bd4fcb1968..7810b6dafc 100644 --- a/docs/command/atlas-api-projects-createProject.txt +++ b/docs/command/atlas-api-projects-createProject.txt @@ -100,11 +100,11 @@ Examples Creates a new project named "MongoTube" with an environment tag set to "e2e" -Create the file below and save it as ``payload.json`` +Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-projects-createProject-2023-01-01-create_project-payload.json :language: shell -After creating ``payload.json``, run the command below in the same directory. +After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-projects-createProject-2023-01-01-create_project.sh :language: shell diff --git a/docs/command/atlas-api-projects-updateProject.txt b/docs/command/atlas-api-projects-updateProject.txt index a78a140717..7e07a90bd0 100644 --- a/docs/command/atlas-api-projects-updateProject.txt +++ b/docs/command/atlas-api-projects-updateProject.txt @@ -102,11 +102,11 @@ Examples Update the value of the existing project to "MongoTube - Production" and change the tags to an environment tag set to "production" -Create the file below and save it as ``payload.json`` +Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-projects-updateProject-2023-01-01-update_project-payload.json :language: shell -After creating ``payload.json``, run the command below in the same directory. +After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-projects-updateProject-2023-01-01-update_project.sh :language: shell diff --git a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt index 0f00e2d61a..7e0c81c3d8 100644 --- a/docs/command/atlas-api-rollingIndex-createRollingIndex.txt +++ b/docs/command/atlas-api-rollingIndex-createRollingIndex.txt @@ -111,11 +111,11 @@ Examples 2dspere Index - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-rollingIndex-createRollingIndex-2023-01-01-2dspere_index-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-rollingIndex-createRollingIndex-2023-01-01-2dspere_index.sh :language: shell @@ -124,11 +124,11 @@ Examples Partial Index - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-rollingIndex-createRollingIndex-2023-01-01-partial_index-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-rollingIndex-createRollingIndex-2023-01-01-partial_index.sh :language: shell @@ -137,11 +137,11 @@ Examples Sparse Index - Create the file below and save it as ``payload.json`` + Create the file below and save it as `payload.json` .. literalinclude:: /includes/examples/atlas-api-rollingIndex-createRollingIndex-2023-01-01-sparse_index-payload.json :language: shell - After creating ``payload.json``, run the command below in the same directory. + After creating `payload.json`, run the command below in the same directory. .. literalinclude:: /includes/examples/atlas-api-rollingIndex-createRollingIndex-2023-01-01-sparse_index.sh :language: shell