doc: Unify credential variables in docs and examples #3277
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
APIx bot: a message has been sent to Docs Slack channel |
AgustinBettati
approved these changes
Apr 14, 2025
examples/starter/Readme.md
Outdated
| @@ -26,8 +26,8 @@ You can refer to the MongoDB Atlas documentation to know about the region names | |||
| This can be done using environment variables: | |||
|
|
|||
| ```bash | |||
| export MONGODB_ATLAS_PUBLIC_KEY="xxxx" | |||
| export MONGODB_ATLAS_PRIVATE_KEY="xxxx" | |||
| export MONGODB_ATLAS_PUBLIC_KEY="<YOUR_ATLAS_PUBLIC_KEY>" | |||
There was a problem hiding this comment.
Suggested change
| export MONGODB_ATLAS_PUBLIC_KEY="<YOUR_ATLAS_PUBLIC_KEY>" | |
| export MONGODB_ATLAS_PUBLIC_KEY="<ATLAS_PUBLIC_KEY>" |
nit: the YOUR_ prefix sounds redundant (applies to all cases)
There was a problem hiding this comment.
that's fair, changed here: 7d2902c
maastha
approved these changes
Apr 14, 2025
marcosuma
reviewed
Apr 14, 2025
docs/guides/0.9.1-upgrade-guide.md
Outdated
| @@ -35,7 +35,7 @@ resource "mongodbatlas_cloud_provider_access_authorization" "auth" { | |||
| role_id = mongodbatlas_cloud_provider_access_setup.unique.role_id | |||
|
|
|||
| aws = { | |||
| iam_assumed_role_arn = "arn:aws:iam::772401394250:role/test-user-role" | |||
| iam_assumed_role_arn = "arn:aws:iam::<YOUR_ACCOUNT_ID>:role/test-user-role" | |||
There was a problem hiding this comment.
Suggested change
| iam_assumed_role_arn = "arn:aws:iam::<YOUR_ACCOUNT_ID>:role/test-user-role" | |
| iam_assumed_role_arn = "arn:aws:iam::<YOUR_AWS_ACCOUNT_ID>:role/test-user-role" |
?
There was a problem hiding this comment.
changed here to AWS_ACCOUNT_ID following Agustin's suggestion to drop "YOUR_": 7d2902c
marcosuma
approved these changes
Apr 14, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Unify credential variables in docs and examples
Link to any related issue(s): CLOUDP-312826
Type of change:
Required Checklist:
Further comments