Skip to content

doc: Added Missing Heading, Fixed event trigger links #3577

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

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

bodegus
Copy link
Collaborator

@bodegus bodegus commented Aug 8, 2025

Description

Added a missing CSP heading and
https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/cloud_provider_access#example-usage-with-aws-1

Fixed broken Realm links in event_bridge
https://registry.terraform.io/providers/mongodb/mongodbatlas/latest/docs/resources/event_trigger

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. A migration guide must be created or updated if the new feature will go in a major version.
  • Breaking change (fix or feature that would cause existing functionality to not work as expected). Please, add the "breaking change" label to the PR. A migration guide must be created or updated.
  • This change requires a documentation update
  • Documentation fix/enhancement

Required Checklist:

  • I have signed the MongoDB CLA
  • I have read the contributing guides
  • I have checked that this change does not generate any credentials and that they are NOT accidentally logged anywhere.
  • NA I have added tests that prove my fix is effective or that my feature works per HashiCorp requirements
  • NA I have added any necessary documentation (if appropriate)
  • NA I have run make fmt and formatted my code
  • NA If changes include deprecations or removals I have added appropriate changelog entries.
  • NA 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

@Copilot Copilot AI review requested due to automatic review settings August 8, 2025 17:31
@bodegus bodegus requested a review from a team as a code owner August 8, 2025 17:31
Copy link
Contributor

@Copilot 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 PR fixes documentation issues in the MongoDB Atlas Terraform provider by updating broken links and adding a missing section heading. The changes ensure that documentation links point to the correct MongoDB documentation URLs and improve document structure.

Key changes:

  • Updated MongoDB Realm documentation links to point to current Atlas documentation URLs
  • Added missing "Example Usage with Azure" heading for better document organization

Reviewed Changes

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

File Description
docs/resources/event_trigger.md Updated five documentation links from legacy MongoDB Realm URLs to current Atlas documentation URLs
docs/resources/cloud_provider_access.md Added missing "Example Usage with Azure" heading and removed extra blank line

@bodegus bodegus changed the title Added Missing Heading, Fixed event trigger links doc: Added Missing Heading, Fixed event trigger links Aug 8, 2025
Copy link
Collaborator

@jwilliams-mongo jwilliams-mongo left a comment

Choose a reason for hiding this comment

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

copy LGTM, but left a few comments on links to a deprecated product

* `config_operation_type` - Required for `AUTHENTICATION` type. The [authentication operation type](https://docs.mongodb.com/realm/triggers/authentication-triggers/#std-label-authentication-event-operation-types) to listen for. Possible Values: `LOGIN`, `CREATE`, `DELETE`
* `config_providers` - Required for `AUTHENTICATION` type. A list of one or more [authentication provider](https://docs.mongodb.com/realm/authentication/providers/) id values. The trigger will only listen for authentication events produced by these providers.
* `config_operation_type` - Required for `AUTHENTICATION` type. The [authentication operation type](https://www.mongodb.com/docs/atlas/atlas-ui/triggers/authentication-triggers/#authentication-events) to listen for. Possible Values: `LOGIN`, `CREATE`, `DELETE`
* `config_providers` - Required for `AUTHENTICATION` type. A list of one or more [authentication provider](https://www.mongodb.com/docs/atlas/app-services/authentication/#authentication-providers-1) id values. The trigger will only listen for authentication events produced by these providers.
Copy link
Collaborator

Choose a reason for hiding this comment

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

question: these docs (App Services) will be going offline in about six weeks. I am not familiar with the event trigger implementation, but is this something that can work without the auth providers? I believe the only parts of App Services that will stick around past Sept are triggers and functions.

@@ -104,10 +104,10 @@ resource "mongodbatlas_event_trigger" "test" {
* `function_id` - (Optional) The ID of the function associated with the trigger.
Copy link
Collaborator

Choose a reason for hiding this comment

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

I believe the API for app_id will be removed in September, if it hasn't been already. Atlas App Services is being sunset, retaining only triggers and functions as part of Atlas core.

Is this page something that has to stick around past the September App Services EOL?

@@ -99,6 +98,7 @@ resource "mongodbatlas_cloud_provider_access_authorization" "auth_role" {

```

## Example Usage with Azure
Copy link
Collaborator

Choose a reason for hiding this comment

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

good catch

@@ -104,10 +104,10 @@ resource "mongodbatlas_event_trigger" "test" {
* `function_id` - (Optional) The ID of the function associated with the trigger.
* `disabled` - (Optional) Default: `false` If `true`, the trigger is disabled.

* `config_operation_type` - Required for `AUTHENTICATION` type. The [authentication operation type](https://docs.mongodb.com/realm/triggers/authentication-triggers/#std-label-authentication-event-operation-types) to listen for. Possible Values: `LOGIN`, `CREATE`, `DELETE`
* `config_providers` - Required for `AUTHENTICATION` type. A list of one or more [authentication provider](https://docs.mongodb.com/realm/authentication/providers/) id values. The trigger will only listen for authentication events produced by these providers.
* `config_operation_type` - Required for `AUTHENTICATION` type. The [authentication operation type](https://www.mongodb.com/docs/atlas/atlas-ui/triggers/authentication-triggers/#authentication-events) to listen for. Possible Values: `LOGIN`, `CREATE`, `DELETE`
Copy link
Collaborator

Choose a reason for hiding this comment

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

we should probably do a sanity check of all links in our docs

Copy link
Collaborator

@EspenAlbert EspenAlbert left a comment

Choose a reason for hiding this comment

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

Thank you!

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.

6 participants