chore: Add module examples to User Management Guide and apply consistency in docs #4048
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
marcabreracast
force-pushed
the
CLOUDP-344329_Add_Remaining_Module_Examples
branch
from
02f70c4 to
a4932fc
Compare
… favor of links to examples
Contributor
|
APIx bot: a message has been sent to Docs Slack channel |
Contributor
There was a problem hiding this comment.
Pull request overview
This PR consolidates migration documentation and adds comprehensive module examples across all User Management migration paths, following the pattern established in PR #4045.
Changes:
- Adds
module_maintainer/andmodule_user/migration examples (v1→v2→v3) for four migration guides - Restructures example directories with
basic/,module_maintainer/, andmodule_user/subdirectories - Consolidates version-specific READMEs in basic examples into single parent READMEs for better maintainability
Reviewed changes
Copilot reviewed 78 out of 115 changed files in this pull request and generated no comments.
Show a summary per file
| File | Description |
|---|---|
| examples/migrate_team_project_assignment/v2/README.md | Removed standalone README (content moved to basic/README.md) |
| examples/migrate_team_project_assignment/module_user/* | Added module consumer migration examples (v1-v3) |
| examples/migrate_team_project_assignment/module_maintainer/* | Added module developer migration examples (v1-v3) |
| examples/migrate_team_project_assignment/basic/* | Updated to consolidate README and adjust main.tf |
| examples/migrate_team_project_assignment/README.md | Updated to reference restructured subdirectories |
| examples/migrate_project_invitation_to_cloud_user_project_assignment/v2/README.md | Removed standalone README (content moved to basic/README.md) |
| examples/migrate_project_invitation_to_cloud_user_project_assignment/v3/README.md | Removed standalone README (content moved to basic/README.md) |
| examples/migrate_project_invitation_to_cloud_user_project_assignment/module_user/* | Added module consumer migration examples (v1-v3) |
| examples/migrate_project_invitation_to_cloud_user_project_assignment/module_maintainer/* | Added module developer migration examples (v1-v3) |
| examples/migrate_project_invitation_to_cloud_user_project_assignment/basic/README.md | Consolidated version-specific READMEs into single parent README |
| examples/migrate_project_invitation_to_cloud_user_project_assignment/README.md | Updated to reference restructured subdirectories |
| examples/migrate_atlas_user_and_atlas_users/v2/README.md | Removed standalone README (content moved to basic/README.md) |
| examples/migrate_atlas_user_and_atlas_users/v3/README.md | Removed standalone README (content moved to basic/README.md) |
| examples/migrate_atlas_user_and_atlas_users/module_user/* | Added module consumer migration examples (v1-v3) |
| examples/migrate_atlas_user_and_atlas_users/module_maintainer/* | Added module developer migration examples (v1-v3) |
| examples/migrate_atlas_user_and_atlas_users/basic/README.md | Consolidated version-specific READMEs into single parent README |
| examples/migrate_atlas_user_and_atlas_users/README.md | Updated to reference restructured subdirectories |
| docs/guides/atlas-user-management.md | Updated to reference new module examples and simplify documentation |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
erabil-mdb
approved these changes
Jan 9, 2026
Contributor
erabil-mdb
left a comment
erabil-mdb
left a comment
There was a problem hiding this comment.
LGTM! + a few super small suggestions
| ## Usage | ||
|
|
||
| 1. Start with v1 to understand the original setup | ||
| 2. Apply v2 to validate new data sources return expected data |
Contributor
There was a problem hiding this comment.
Suggested change
| 2. Apply v2 to validate new data sources return expected data | |
| 2. Apply v2 to validate that new data sources return expected data |
| @@ -0,0 +1,27 @@ | |||
| # Module Maintainer Migration Example | |||
|
|
|||
| This example demonstrates how module maintainers should migrate from `mongodbatlas_atlas_user` data source to `mongodbatlas_cloud_user_org_assignment`. | |||
Contributor
There was a problem hiding this comment.
Suggested change
| This example demonstrates how module maintainers should migrate from `mongodbatlas_atlas_user` data source to `mongodbatlas_cloud_user_org_assignment`. | |
| This example demonstrates how module maintainers should migrate from the `mongodbatlas_atlas_user` data source to `mongodbatlas_cloud_user_org_assignment`. |
| ## v1: Initial State | ||
|
|
||
| Module using the deprecated `mongodbatlas_atlas_user` data source: | ||
| - Complex role filtering with for expressions |
Contributor
There was a problem hiding this comment.
Suggested change
| - Complex role filtering with for expressions | |
| - Complex role filtering with `for` expressions |
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
This PR consolidates and adds module examples across all migration paths in the User Management migration guide. It is a follow-up to PR #4045, using the
Org Invitation → Cloud User Org Assignmentmigration as the reference pattern for consistency.Module Examples Added
The following migration guides now include
module_maintainer/andmodule_user/examples (v1 → v2 → v3):mongodbatlas_org_invitation→mongodbatlas_cloud_user_org_assignmentmongodbatlas_project.teams→mongodbatlas_team_project_assignmentmongodbatlas_project_invitation→mongodbatlas_cloud_user_project_assignmentdata.mongodbatlas_atlas_user→data.mongodbatlas_cloud_user_org_assignmentdata.mongodbatlas_atlas_users→mongodbatlas_organization.users/mongodbatlas_project.users/mongodbatlas_team.usersDocumentation Improvements
Example Directory RestructuringMigration examples have been reorganized into the following structure:
basic/- Direct resource usage examples with consolidated READMEmodule_maintainer/- Module developer migration examplesmodule_user/- Module consumer migration examplesREADME.md- Overview with links to all subdirectoriesBasic Example README Consolidation
The following
basic/directories had their version-specific READMEs consolidated into a single parent README for better maintainability:migrate_atlas_user_and_atlas_users/basic/v2/README.mdandv3/README.mdintobasic/README.mdmigrate_project_invitation_to_cloud_user_project_assignment/basic/v2/README.mdandv3/README.mdintobasic/README.mdEach consolidated README now documents all migration phases (v1 → v2 → v3) with key attribute changes, usage steps, and expected behavior in a single location.
Link to any related issue(s): CLOUDP-344329
Type of change:
Required Checklist:
Further comments