doc: Fixes path for collection attributes in cluster docs #3739
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
maastha
commented
Oct 1, 2025
docs/resources/advanced_cluster.md
Outdated
| -> **NOTE:** If Backup Compliance Policy is enabled for the project for which this backup schedule is defined, you cannot modify the backup schedule for an individual cluster below the minimum requirements set in the Backup Compliance Policy. See [Backup Compliance Policy Prohibited Actions and Considerations](https://www.mongodb.com/docs/atlas/backup/cloud-backup/backup-compliance-policy/#configure-a-backup-compliance-policy). | ||
|
|
||
| -> **NOTE:** A network container is created for each provider/region combination on the advanced cluster. This can be referenced via a computed attribute for use with other resources. Refer to the `replication_specs[#].container_id` attribute in the [Attributes Reference](#attributes_reference) for more information. | ||
| -> **NOTE:** A network container is created for each provider/region combination on the advanced cluster. This can be referenced via a computed attribute for use with other resources. Refer to the `replication_specs.#.container_id` attribute in the [Attributes Reference](#attributes_reference) for more information. |
There was a problem hiding this comment.
making doc consistent to use .#. as used in most other docs
|
APIx bot: a message has been sent to Docs Slack channel |
manupedrozo
approved these changes
Oct 3, 2025
| - `connection_strings.private_endpoint.#.endpoints.#.endpoint_id` - Unique identifier of the private endpoint. | ||
| - `connection_strings.private_endpoint.#.endpoints.#.provider_name` - Cloud provider to which you deployed the private endpoint. Atlas returns `AWS` or `AZURE`. | ||
| - `connection_strings.private_endpoint.#.endpoints.#.region` - Region to which you deployed the private endpoint. | ||
| - `connection_strings.#.standard` - Public mongodb:// connection string for this cluster. |
There was a problem hiding this comment.
Unrelated to your changes: In the docs these currently show up as a code block.
Maybe an extra space before this line would fix it. Not sure as it renders fine in github, its a registry issue only.
jvincent-mongodb
approved these changes
Oct 3, 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
Addresses this github issue #3334. While our current document does mention below note, I think it can still be confusing and inconsistent with rest of the documentation, so making minor updates to the documentation as per recommendation in the Github issue.
Adding ".#" to an attribute signifies that it is a collection attribute & it's sub-elements can be referenced with an index value such as
connection_strings[0].srv.**NOTE** Connection strings must be returned as a list, therefore to refer to a specific attribute value add index notation.Link to any related issue(s): CLOUDP-319584
Type of change:
Required Checklist:
Further comments