Skip to content

CLOUDP-321526: Fix snooty error about two backticks #4024

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions docs/command/atlas-api-cloudBackups-createExportBucket.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
12 changes: 6 additions & 6 deletions docs/command/atlas-api-clusters-createCluster.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
4 changes: 2 additions & 2 deletions docs/command/atlas-api-clusters-updateCluster.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
24 changes: 12 additions & 12 deletions docs/command/atlas-api-databaseUsers-createDatabaseUser.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Expand All @@ -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
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/command/atlas-api-projects-createProject.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
4 changes: 2 additions & 2 deletions docs/command/atlas-api-projects-updateProject.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
12 changes: 6 additions & 6 deletions docs/command/atlas-api-rollingIndex-createRollingIndex.txt
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
4 changes: 2 additions & 2 deletions tools/cmd/docs/transformations.go
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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(" ")
}
Expand Down
Loading