-
Notifications
You must be signed in to change notification settings - Fork 39
doc: Enhances README with additional MongoDB Atlas and AWS CloudFormation documentation links and resource support details #1313
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
Conversation
…ion documentation links and resource support details
oarbusi
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, some minor comments
colm-quinn
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM, thanks for the updates!
themantissa
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Responded to questions and added a few suggestions to hopefully help us clear more up in the README. Please give me a slack ping when ready again as I'm woefully behind on email 😄
README.md
Outdated
| 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. | ||
|
|
||
| **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"). |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Just a bit of explanation and clarity:
| - 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. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Changed in a86cd5d to refer to our existing Activate the MongoDB Atlas CloudFormation public extensions which is more complete. WDYT?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Regarding Upgrade, I added a new guide here: a147282
themantissa
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thank you for the quick and complete turn around!
|
Merging this PR on behalf on @EspenAlbert |
Proposed changes
Enhances README with additional MongoDB Atlas and AWS CloudFormation documentation links and resource support details
Link to any related issue(s): CLOUDP-307844
Type of change:
expected)
Manual QA performed:
Required Checklist:
make fmtand formatted my codeworks in Atlas
Further comments