doc: Enhances README with additional MongoDB Atlas and AWS CloudFormation documentation links and resource support details #1313
There are no files selected for viewing
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
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -2,13 +2,12 @@ | |||||
| [](https://github.com/mongodb/mongodbatlas-cloudformation-resources/actions/workflows/code-health.yaml) | ||||||
| [](https://github.com/mongodb/mongodbatlas-cloudformation-resources/actions/workflows/contract-testing.yaml) | ||||||
|
|
||||||
EspenAlbert marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
| Use [AWS CloudFormation](https://aws.amazon.com/cloudformation/) to manage [MongoDB Atlas](https://www.mongodb.com/cloud/atlas). See our [documentation](https://www.mongodb.com/products/integrations/aws-cloudformation) for quick starts and common questions. For a list of supported resources, see [here](cfn-resources/README.md). | ||||||
|
|
||||||
| ## Getting Started | ||||||
| ### MongoDB Atlas CloudFormation | ||||||
|
|
||||||
| See the [`cfn` examples](examples/README.md) to setup prerequisites and get started with your first cluster using our sample CloudFormation Stack templates. For all examples, first enable resources in the [AWS Cloudformation Third Party registry](https://console.aws.amazon.com/cloudformation/home#/registry/public-extensions?visibility=PUBLIC&type=RESOURCE&category=THIRD_PARTY) (select "Third party" as `Provider` and search by "MongoDB::Atlas"). | ||||||
|
|
||||||
| ### MongoDB Atlas AWS CDK | ||||||
| See the [cdk examples](https://github.com/mongodb/awscdk-resources-mongodbatlas/blob/main/examples/README.md) to setup prerequisites and get started with your first cluster using our AWS CDK sample code. | ||||||
|
|
@@ -29,6 +28,10 @@ Feature requests can be submitted at [feedback.mongodb.com](https://feedback.mon | |||||
|
|
||||||
| Support for the MongoDB Atlas Resource Provider for CloudFormation is provided under MongoDB Atlas support plans, starting with Developer. Please submit support questions within the Atlas UI. In addition, support questions submitted under the Issues section of this repo are also being monitored. Bugs should be filed under the Issues section of this repo. | ||||||
EspenAlbert marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||
|
|
||||||
| **Please note**: | ||||||
| - We **only** support resources enabled in the [AWS Cloudformation Third Party registry](https://console.aws.amazon.com/cloudformation/home#/registry/public-extensions?visibility=PUBLIC&type=RESOURCE&category=THIRD_PARTY) (select "Third party" as `Provider` and search by "MongoDB::Atlas"). | ||||||
|
||||||
| - We **only** support resources enabled in the [AWS Cloudformation Third Party registry](https://console.aws.amazon.com/cloudformation/home#/registry/public-extensions?visibility=PUBLIC&type=RESOURCE&category=THIRD_PARTY) (select "Third party" as `Provider` and search by "MongoDB::Atlas"). | |
| - In order to ensure the highest quality experience and support, we only support resources enabled via the [AWS Cloudformation Third Party registry](https://console.aws.amazon.com/cloudformation/home#/registry/public-extensions?visibility=PUBLIC&type=RESOURCE&category=THIRD_PARTY) (select "Third party" as `Provider` and search by "MongoDB::Atlas"). Any usage outside of this workflow is not supported or recommended. |
Collaborator
There was a problem hiding this comment.
Also in reading over the rest of the README - I think we need a header (double #) on "Enabling" that further reiterates where to enable the resources, i.e. the 3rd party registry. And also to do so in each acct/region needed. We only have this in troubleshooting but a header on Enabling hopefully will keep them out of troubleshooting. We might also want to include an "Upgrade" header?
Contributor
Author
There was a problem hiding this comment.
Changed in a86cd5d to refer to our existing Activate the MongoDB Atlas CloudFormation public extensions which is more complete. WDYT?
Contributor
Author
There was a problem hiding this comment.
Regarding Upgrade, I added a new guide here: a147282
EspenAlbert marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
EspenAlbert marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
Oops, something went wrong.
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.
Uh oh!
There was an error while loading. Please reload this page.