Skip to content
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

doc: Clarifies private endpoint resource docs #2059

Merged
merged 1 commit into from
Mar 22, 2024

Conversation

zach-carr
Copy link
Contributor

@zach-carr zach-carr commented Mar 21, 2024

Description

The resources mongodbatlas_privatelink_endpoint_service and mongodbatlas_privatelink_endpoint map to contradictory terminology -- privatelink_endpoint_service affects Private Endpoints, and privatelink_endpoint affects Private Endpoint Services. To help clarify, I've added links to a new section of the Atlas documentation that defines these terms as MongoDB uses them.

Link to any related issue(s):

Type of change:

  • Bug fix (non-breaking change which fixes an issue). Please, add the "bug" label to the PR.
  • New feature (non-breaking change which adds functionality). Please, add the "enhancement" label to the PR.
  • Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR.
  • This change requires a documentation update
  • Documentation fix/enhancement

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the contribution guidelines
  • I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
  • I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
  • I have added any necessary documentation (if appropriate)
  • I have run make fmt and formatted my code
  • If changes include deprecations or removals, I defined an isolated PR with a relevant title as it will be used in the auto-generated changelog.
  • 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.

Further comments

@zach-carr zach-carr requested a review from a team as a code owner March 21, 2024 18:20

~> **IMPORTANT:**You must have one of the following roles to successfully handle the resource:
* Organization Owner
* Project Owner

-> **NOTE:** Groups and projects are synonymous terms. You may find group_id in the official documentation.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

unrelated fix to note rendering

Copy link
Contributor

@sarahsimpers sarahsimpers left a comment

Choose a reason for hiding this comment

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

LGTM, thank you!

Copy link
Collaborator

@oarbusi oarbusi left a comment

Choose a reason for hiding this comment

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

Thanks! LGTM

@zach-carr zach-carr merged commit 63ab229 into mongodb:master Mar 22, 2024
45 checks passed
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