Skip to content

doc: Update doc for MongoDB::Atlas::FlexCluster CFN resource#1441

Merged
jromo-mdb merged 8 commits intomasterfrom
DOCSP-53418-main
Sep 12, 2025
Merged

doc: Update doc for MongoDB::Atlas::FlexCluster CFN resource#1441
jromo-mdb merged 8 commits intomasterfrom
DOCSP-53418-main

Conversation

@jromo-mdb
Copy link
Copy Markdown
Contributor

@jromo-mdb jromo-mdb commented Sep 12, 2025

Proposed changes

  • Added detailed step-by-step setup instructions for activating and using the FlexCluster resource
  • Updated resource description with important deprecation notice directing users to use MongoDB::Atlas::Cluster instead
  • Fixed documentation link to point to the README instead of the JSON template

Jira ticket EPIC: CLOUDP-#286685
Jira ticket DOCSP: DOCSP-53418

Please include a summary of the fix/feature/change, including any relevant motivation and context.

Link to any related issue(s):

Type of change:

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to not work as
    expected)
  • This change requires a documentation update
  • If changes include removal or addition of 3rd party GitHub actions, I updated our internal document. Reach out to the APIx Integration slack channel to get access to the internal document.

Manual QA performed:

  • cfn invoke for each of CRUDL/cfn test
  • Updated resource in example
  • Published to AWS private registry
  • Used the template in example to create and update a stack in AWS
  • Deleted stack to ensure resources are deleted
  • Created multiple resources in same stack
  • Validated in Atlas UI
  • Included screenshots

Required Checklist:

  • I have signed the MongoDB CLA
  • I have added tests that prove my fix is effective or that my feature works
  • I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
  • I have added any necessary documentation (if appropriate)
  • I have run make fmt and formatted my code
  • For CFN Resources: I have released by changes in the private registry and proved by change
    works in Atlas

Further comments

@jromo-mdb jromo-mdb requested a review from lantoli September 12, 2025 16:31
@jromo-mdb jromo-mdb requested a review from a team as a code owner September 12, 2025 16:31
Copilot AI review requested due to automatic review settings September 12, 2025 16:31
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This pull request updates documentation for the MongoDB Atlas FlexCluster CloudFormation resource. The changes add comprehensive setup instructions and important deprecation notices to guide users toward the recommended resource.

  • Added detailed step-by-step setup instructions for activating and using the FlexCluster resource
  • Updated resource description with important deprecation notice directing users to use MongoDB::Atlas::Cluster instead
  • Fixed documentation link to point to the README instead of the JSON template

Reviewed Changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.

File Description
examples/flex-cluster/README.md New comprehensive setup guide with activation steps and template usage instructions
cfn-resources/flex-cluster/README.md Enhanced description with deprecation notice and corrected documentation link

Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread cfn-resources/flex-cluster/README.md Outdated
@jromo-mdb jromo-mdb changed the title Cherrypick from fork to master branch (DOCSP-53418) Cherrypick from fork to master branch Sep 12, 2025
@jromo-mdb jromo-mdb requested a review from Copilot September 12, 2025 16:42
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread examples/flex-cluster/README.md Outdated
@jromo-mdb jromo-mdb requested a review from Copilot September 12, 2025 16:45
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

Comment thread examples/flex-cluster/README.md Outdated
@lantoli
Copy link
Copy Markdown
Member

lantoli commented Sep 12, 2025

all PR checks should pass before merging, note that "pull-request-lint / Validate PR title (pull_request_target)" is failing, you need to start the PR title with "doc:", also no need to have the ticket id, e.g. title:

doc: Update doc for MongoDB::Atlas::FlexCluster CFN resource

Comment thread examples/flex-cluster/README.md Outdated
Copy link
Copy Markdown
Member

@lantoli lantoli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM , good to merge after addressing the comments and make sure all PR checks are passing. thanks!

@jromo-mdb jromo-mdb changed the title (DOCSP-53418) Cherrypick from fork to master branch doc: Update doc for MongoDB::Atlas::FlexCluster CFN resource Sep 12, 2025
@jromo-mdb jromo-mdb requested a review from Copilot September 12, 2025 18:58
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@jromo-mdb jromo-mdb requested a review from Copilot September 12, 2025 19:15
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

Copilot reviewed 2 out of 2 changed files in this pull request and generated no new comments.


Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.

@jromo-mdb jromo-mdb added this pull request to the merge queue Sep 12, 2025
Merged via the queue into master with commit 40360f1 Sep 12, 2025
38 of 39 checks passed
@jromo-mdb jromo-mdb deleted the DOCSP-53418-main branch September 12, 2025 19:23
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants