From 4da93985f14fde32dc27670071584076863e1cca Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Tue, 30 Apr 2024 16:51:49 -0400 Subject: [PATCH 1/2] Edits to BigAnimal PR5621 --- .../administering_cluster/notifications.mdx | 18 +++++++++--------- .../biganimal/release/overview/updates.mdx | 2 +- .../release/reference/access_key/index.mdx | 2 +- .../third_party_integrations/index.mdx | 6 +++--- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx b/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx index 6a6fc4375ea..cf0b8ef4f93 100644 --- a/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx +++ b/product_docs/docs/biganimal/release/administering_cluster/notifications.mdx @@ -6,27 +6,27 @@ description: "Use notifications to get an alert for the different types of event With BigAnimal, you can opt to get specific types of notifications and receive both in-app and email notifications. Different types of events are sent as notifications. Users with different roles can configure the preferences to receive these notifications in the in-app inbox, by email, or both. -The notifications are categorized into following preference sections: +The notifications are categorized into the following preference sections: - Account - Organizations - Projects -The notifications under **Account** preference section: +The notifications under the **Account** preference section are: - New project role assigned to you - Project role unassigned from you - Personal access key is about to expire -The notifications under **Organizations** preference section: +The notifications under the **Organizations** preference section are: -- Payment method added (specific to organizations that opted credit card payment option) +- Payment method added (specific to organizations that opted for credit card payment option) - Machine user access key is expiring !!!note This section is visible only to the organization owner. If the current user is owner of more than one organization, then this section lists the preferences for all the organizations. !!! -The notifications under **Projects** preference section: +The notifications under the **Projects** preference section are: - Upcoming cluster maintenance upgrade - Successful cluster maintenance upgrade @@ -54,18 +54,18 @@ Users in the following roles can view the notifications: - Project owners/editors can view the project notifications. - User can view their own account notifications. -Each notification indicates the level and project it belongs to for the user having multiple roles in BigAnimal. +For the user having multiple roles in BigAnimal, each notification indicates the level and project it belongs to. Select the bell at the top of your BigAnimal portal to view the in-app notifications. By selecting the bell, you can read the notification, mark it as unread, and archive it. To view the email notifications, check the inbox of your configured email addresses. -## Manage notifications +## Managing notifications To manage the notifications: 1. Log in to the BigAnimal portal. 1. From the menu under your name in the top-right panel, select **My Account**. 1. Select the **Notifications** tab. Notifications are grouped by account, organizations, and projects available to you. -1. Select account, organization, or project to manage the notifications. +1. Select **Account**, **Organization**, or **Project** to manage the notifications. - Enable/disable the notification for a particular event using the toggle. - - Select **Email** and **Inbox** next to an event to enable/disable the email and in-app notifications for the event. \ No newline at end of file + - To enable/disable the email and in-app notifications for the event, select **Email** and **Inbox** next to an event. \ No newline at end of file diff --git a/product_docs/docs/biganimal/release/overview/updates.mdx b/product_docs/docs/biganimal/release/overview/updates.mdx index edd07c97b78..e18d887171f 100644 --- a/product_docs/docs/biganimal/release/overview/updates.mdx +++ b/product_docs/docs/biganimal/release/overview/updates.mdx @@ -6,7 +6,7 @@ EDB performs periodic maintenance to ensure stability and security of your clust ## Notification of upcoming maintenance -You're notified in the BigAnimal portal before maintenance occurs. Details are available on the [BigAnimal status page](https://status.biganimal.com/). You can subscribe to get these updates in a feed by selecting **Subscribe to Updates** on the status page. You can also enable the notifications to receive in-app or email notifications for upcoming, successful, and failed cluster maintenance upgrade. For more information, see [managing notifications](../administering_cluster/notifications/#manage-notifications). +You're notified in the BigAnimal portal before maintenance occurs. Details are available on the [BigAnimal status page](https://status.biganimal.com/). You can subscribe to get these updates in a feed by selecting **Subscribe to Updates** on the status page. You can also enable the notifications to receive in-app or email notifications for upcoming, successful, and failed cluster maintenance upgrade. For more information, see [Managing notifications](../administering_cluster/notifications/#managing-notifications). EDB reserves the right to upgrade customers to the latest minor version without prior notice in an extraordinary circumstance. You can't configure minor versions. diff --git a/product_docs/docs/biganimal/release/reference/access_key/index.mdx b/product_docs/docs/biganimal/release/reference/access_key/index.mdx index 8f0ef1961e2..4d1357c1b00 100644 --- a/product_docs/docs/biganimal/release/reference/access_key/index.mdx +++ b/product_docs/docs/biganimal/release/reference/access_key/index.mdx @@ -27,7 +27,7 @@ To create an access key: Copy this access key and save it in a secure location. The access key is available only when you create it. If you lose your access key, you must delete it and create a new one. -You can enable in-app inbox or email notifications to get alerted when your personal key is about to expire. For more information, see [manage notifications](../../administering_cluster/notifications/#manage-notifications). +You can enable in-app inbox or email notifications so that you're alerted when your personal key is about to expire. For more information, see [Managing notifications](../../administering_cluster/notifications/#managing-notifications). ## Manage access key diff --git a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx index c54a218a28a..84f7376ad5c 100644 --- a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx @@ -8,9 +8,9 @@ Monitoring integrations are configured at the project level in BigAnimal. You ca By default, all the integrations are disabled. After creating the project, enable an integration using the **Integrations** tab. -All the metrics collected from all the clusters in the project are sent to the integrated tool and displayed in the BigAnimal [**Monitoring and logging** tab using BigAnimal's Observability](../monitoring_using_biganimal_observability). The collected logs are exported to the object storage by default. +All the metrics collected from all the clusters in the project are sent to the integrated tool and displayed in the BigAnimal **Monitoring and logging** tab [using BigAnimal's Observability](../monitoring_using_biganimal_observability). The collected logs are exported to the object storage by default. -You can enable in-app inbox or email notifications to get notified incase third-party monitoring integration fails. For more information, see [managing notifications](../../../administering_cluster/notifications/#manage-notifications). +You can enable in-app inbox or email notifications so that you are notified if third-party monitoring integration fails. For more information, see [Managing notifications](../../../administering_cluster/notifications/#managing-notifications). The third-party integrations available in BigAnimal are: @@ -21,7 +21,7 @@ The third-party integrations available in BigAnimal are: When metrics from BigAnimal are exported to third-party monitoring services, they're renamed according to the naming conventions of the target platform. -The following table provides a mapping between [BigAnimal metric names](/biganimal/release/using_cluster/05_monitoring_and_logging/metrics/) +The following table provides a mapping between [BigAnimal metric names](../metrics/) and the name that metric will be assigned when exported to a third-party service. !!! Note Kubernetes metrics From 216dec2b3ea0feceb2ffe03ab61b367ce709ac4f Mon Sep 17 00:00:00 2001 From: Betsy Gitelman Date: Tue, 30 Apr 2024 16:54:59 -0400 Subject: [PATCH 2/2] Update product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx --- .../third_party_integrations/index.mdx | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx index 84f7376ad5c..0400c5d2f30 100644 --- a/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx +++ b/product_docs/docs/biganimal/release/using_cluster/05_monitoring_and_logging/third_party_integrations/index.mdx @@ -10,7 +10,7 @@ By default, all the integrations are disabled. After creating the project, enabl All the metrics collected from all the clusters in the project are sent to the integrated tool and displayed in the BigAnimal **Monitoring and logging** tab [using BigAnimal's Observability](../monitoring_using_biganimal_observability). The collected logs are exported to the object storage by default. -You can enable in-app inbox or email notifications so that you are notified if third-party monitoring integration fails. For more information, see [Managing notifications](../../../administering_cluster/notifications/#managing-notifications). +You can enable in-app inbox or email notifications so that you're notified if third-party monitoring integration fails. For more information, see [Managing notifications](../../../administering_cluster/notifications/#managing-notifications). The third-party integrations available in BigAnimal are: