TF-33257 HCP Terraform & Enterprise Docs Update Notification Configurations for Projects#1630
Conversation
Vercel Previews Deployed
|
Broken Link CheckerNo broken links found! 🎉 |
trujillo-adam
left a comment
There was a problem hiding this comment.
This review is just for the new UI page. I'll branch off of this PR to suggest some structural changes to the API docs. We'll also need to remove the TFE-specific page. If we merge by 4/3, TFE 2.0 will get the new content automatically.
content/terraform-docs-common/docs/cloud-docs/projects/notifications.mdx
Outdated
Show resolved
Hide resolved
|
|
||
| Project notification configurations require project admin access. Refer to [Project permissions](/terraform/cloud-docs/users-teams-organizations/permissions/project#project-admin) for details. | ||
|
|
||
| -> **API:** Refer to [Project notification configurations API reference](/terraform/cloud-docs/api-docs/project-notification-configurations). |
There was a problem hiding this comment.
| -> **API:** Refer to [Project notification configurations API reference](/terraform/cloud-docs/api-docs/project-notification-configurations). | |
| Refer to [Project notification configurations API reference](/terraform/cloud-docs/api-docs/project-notification-configurations) for information on integrating with your notification systems. |
Doesn't need to be a callout box and shouldn't be on the other pages, either.
content/terraform-docs-common/docs/cloud-docs/projects/notifications.mdx
Outdated
Show resolved
Hide resolved
| ## How project notifications work | ||
|
|
||
| Project notifications work alongside workspace notifications. | ||
|
|
||
| ### Apply to all workspaces | ||
|
|
||
| Project notifications trigger for all current workspaces in the project. They also trigger for any workspaces that you create in the project or move into it later. | ||
|
|
||
| ### Combine with workspace notifications | ||
|
|
||
| Project notifications do not modify or remove workspace notifications. For example, if a workspace has a Slack webhook and the project has a PagerDuty webhook, the same run event triggers both notifications. | ||
|
|
||
| ### Cannot be disabled from workspaces | ||
|
|
||
| Workspace administrators cannot turn off project notifications from workspace settings. You must modify or delete them at the project level. |
There was a problem hiding this comment.
| ## How project notifications work | |
| Project notifications work alongside workspace notifications. | |
| ### Apply to all workspaces | |
| Project notifications trigger for all current workspaces in the project. They also trigger for any workspaces that you create in the project or move into it later. | |
| ### Combine with workspace notifications | |
| Project notifications do not modify or remove workspace notifications. For example, if a workspace has a Slack webhook and the project has a PagerDuty webhook, the same run event triggers both notifications. | |
| ### Cannot be disabled from workspaces | |
| Workspace administrators cannot turn off project notifications from workspace settings. You must modify or delete them at the project level. | |
| ## Overview | |
| HCP Terraform sends project notifications in addition to workspace notifications. Project notifications do not modify or remove workspace notifications. For example, if a workspace has a Slack webhook and the project has a PagerDuty webhook, the same run event triggers both notifications. | |
| HCP Terraform sends project notifications for all current workspaces in the project. They also trigger for any workspaces that you create in the project or move into it later. | |
| By default, HCP Terraform also sends project notifications for all current workspaces in the organization, but you can remove them from the scope during configuration. | |
| Workspace administrators cannot turn off project notifications from workspace settings. You must modify or delete them at the project level. |
This is normally call the "Overview" or "Introduction" section in a usage page. The combination of wording in the H2 and the subheadings was a little confusing to me at first because they seemed like settings.
I added the information about the default behavior because that's what I saw on staging, but I don't know if that's intentional.
Just to be clear, once you create a project-level notification, the platform sends a notification to the external app for any of the selected events for all workspaces in the project, period. You can't select the workspaces in the project that trigger the notification. The workspaces field in the UI is to send notifications when workspaces outside the project trigger the notification, correct?
content/terraform-docs-common/docs/cloud-docs/projects/notifications.mdx
Show resolved
Hide resolved
content/terraform-docs-common/docs/cloud-docs/projects/notifications.mdx
Outdated
Show resolved
Hide resolved
content/terraform-docs-common/docs/cloud-docs/projects/notifications.mdx
Show resolved
Hide resolved
|
|
||
| ## Notification payloads | ||
|
|
||
| Project notifications use the same payload formats as workspace notifications. Refer to [Workspace notifications](/terraform/cloud-docs/workspaces/settings/notifications#notification-payloads) for payload details and examples. |
There was a problem hiding this comment.
Ideally, "Notification payloads" is a standalone reference topic. No action on this comment -- it's more for me to investigate a better structure.
| "title": "Manage projects", | ||
| "path": "projects/manage" | ||
| }, | ||
| { "title": "Notifications", "path": "projects/notifications" }, |
There was a problem hiding this comment.
I'll create a subbranch to propose some structural changes that I think will set us up better for future work
| ### Project notification triggers | ||
|
|
||
| The same workspace notification triggers are available for [project notifications](#project-notification-configuration). | ||
|
|
There was a problem hiding this comment.
Suggestion to remove changes to this TFE file content/terraform-enterprise/1.1.x/docs/enterprise/api-docs/notification-configurations.mdx until after the release next week, to unblock this PR for TFC
content/terraform-docs-common/docs/cloud-docs/projects/notifications.mdx
Show resolved
Hide resolved
This PR creates a folder for the notifications API docs so that we can more easily add or update based on constructs in the platform. I also added a list of endpoints described in each page so that the content is more reference-like.
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
content/terraform-docs-common/docs/cloud-docs/projects/notifications.mdx
Outdated
Show resolved
Hide resolved
content/terraform-docs-common/docs/cloud-docs/projects/notifications.mdx
Outdated
Show resolved
Hide resolved
Co-authored-by: trujillo-adam <47586768+trujillo-adam@users.noreply.github.com>
Please go to the
Previewtab and select the appropriate template:Terraform
TF-33257