Просмотр исходного кода

docs: format, typos, and some simplifications in `docs/` (#19112)

Ilya Mashchenko 3 месяцев назад
Родитель
Сommit
d9f7159486

+ 3 - 3
docs/alerts-and-notifications/creating-alerts-with-netdata-alerts-configuration-manager.md

@@ -32,11 +32,11 @@ You can read more about the different options in the [Alerts reference documenta
 ### Alerting Conditions
 
 - **Thresholds**: Set thresholds for warning and critical Alert states, specifying whether the Alert should trigger above or below these thresholds. Advanced settings allow for custom formulas.
-  - **Recovery Thresholds**: Set thresholds for downgrading the Alert from critical to warning or from warning to clear.
+- **Recovery Thresholds**: Set thresholds for downgrading the Alert from critical to warning or from warning to clear.
 - **Check Interval**: Define how frequently the health check should run.
 - **Delay Notifications**: Manage notification delays for Alert escalations or de-escalations.
-- **Agent Specific Options**: Options exclusive to the Netdata Agent, like repeat notification frequencies and notification recipients.
-  - **Custom Exec Script**: Define custom scripts to execute when an Alert triggers.
+- **Agent-Specific Options**: Options exclusive to the Netdata Agent, like repeat notification frequencies and notification recipients.
+- **Custom Exec Script**: Define custom scripts to execute when an Alert triggers.
 
 ### Alert Name, Description, and Summary Section
 

+ 2 - 2
docs/alerts-and-notifications/notifications/README.md

@@ -4,6 +4,6 @@ This section includes the documentation of the integrations for both of Netdata'
 
 <!-- following links are virtual links to a generated page, should not lead somewhere upon click from GitHub -->
 
-- Netdata Cloud provides centralized alert notifications, utilizing the health status data already sent to Netdata Cloud from connected nodes to send alerts to configured integrations. [Supported integrations](/docs/alerts-&-notifications/notifications/centralized-cloud-notifications) include Amazon SNS, Discord, Slack, Splunk, and others.
+- Netdata Cloud provides centralized alert notifications, using the health status data already sent to Netdata Cloud from connected nodes to send alerts to configured integrations. [Supported integrations](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications) include Amazon SNS, Discord, Slack, Splunk, and others.
 
-- The Netdata Agent offers a [wider range of notification options](/docs/alerts-&-notifications/notifications/agent-dispatched-notifications) directly from the Agent itself. You can choose from over a dozen services, including email, Slack, PagerDuty, Twilio, and others, for more granular control over notifications on each node.
+- The Netdata Agent offers a [wider range of notification options](/docs/alerts-and-notifications/notifications/agent-dispatched-notifications) directly from the Agent itself. You can choose from over a dozen services, including email, Slack, PagerDuty, Twilio, and others, for more granular control over notifications on each node.

+ 23 - 23
docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-alert-notification-silencing-rules.md

@@ -7,12 +7,12 @@ From the Cloud interface, you can manage your space's Alert notification silenci
 To manage **space's Alert notification silencing rule settings**, you will need the following:
 
 - A Netdata Cloud account
-- Access to the space as an **administrator** or **manager** (**troubleshooters** can only view space rules)
+- Access to Space as an **administrator** or **manager** (**troubleshooters** can only view space rules)
 
 To manage your **personal Alert notification silencing rule settings**, you will need the following:
 
 - A Netdata Cloud account
-- Access to the space with any role except **billing**
+- Access to Space with any role except **billing**
 
 ### Steps
 
@@ -21,33 +21,33 @@ To manage your **personal Alert notification silencing rule settings**, you will
 3. Click on the **Notification Silencing Rules** tab.
 4. You will be presented with a table of the configured Alert notification silencing rules for:
 
-   - The space (if you aren't an **observer**)
-   - Yourself
+    - The space (if you aren't an **observer**)
+    - Yourself
 
    You will be able to:
 
-   1. **Add a new** Alert notification silencing rule configuration.
-      - Choose if it applies to **All users** or **Myself** (All users is only available for **administrators** and **managers**).
-      - You need to provide a name for the configuration so you can easily refer to it.
-      - Define criteria for Nodes, to which Rooms will the rule apply, on what Nodes and whether or not it applies to host labels key-value pairs.
-      - Define criteria for Alerts, such as Alert name is being targeted and on what Alert context. You can also specify if it will apply to a specific Alert role.
-      - Define when it will be applied:
-        - Immediately, from now until it is turned off or until a specific duration (start and end date automatically set).
-        - Scheduled, you can specify the start and end time for when the rule becomes active and then inactive (time is set according to your browser's local timezone).
-      Note: You are only able to add a rule if your space is on a [paid plan](/docs/netdata-cloud/view-plan-and-billing.md).
-   2. **Edit an existing** Alert notification silencing rule configuration. You will be able to change:
-      - The name provided for it
-      - Who it applies to
-      - Selection criteria for Nodes and Alerts
-      - When it will be applied
-   3. **Enable/Disable** a given Alert notification silencing rule configuration.
-      - Use the toggle to enable or disable
-   4. **Delete an existing** Alert notification silencing rule.
-      - Use the trash icon to delete your configuration
+    1. **Add a new** Alert notification silencing rule configuration.
+        - Choose if it applies to **All users** or **Myself** (All users is only available for **administrators** and **managers**).
+        - You need to provide a name for the configuration so you can refer to it.
+        - Define criteria for Nodes, to which Rooms will the rule apply, on what Nodes and whether it applies to host labels key-value pairs.
+        - Define criteria for Alerts, such as Alert name is being targeted and in what Alert context. You can also specify if it applies to a specific Alert role.
+        - Define when it is applied:
+            - Immediately, from now until it is turned off or until a specific duration (start and end date automatically set).
+            - Scheduled, you can specify the start and end time for when the rule becomes active and then inactive (time is set according to your browser's local timezone).
+              Note: You are only able to add a rule if your space is on a [paid plan](/docs/netdata-cloud/view-plan-and-billing.md).
+    2. **Edit an existing** Alert notification silencing rule configuration. You will be able to change:
+        - The name provided for it
+        - Who it applies to
+        - Selection criteria for Nodes and Alerts
+        - When it will be applied
+    3. **Enable/Disable** a given Alert notification silencing rule configuration.
+        - Use the toggle to enable or disable
+    4. **Delete an existing** Alert notification silencing rule.
+        - Use the trash icon to delete your configuration
 
 ## Silencing Rules Examples
 
-| Rule name                        | Rooms          | Nodes    | Host Label               | Alert name                                       | Alert context | Alert instance           | Alert role  | Description                                                                                                                                                                                                               |
+| Rule name                        | Rooms              | Nodes    | Host Label               | Alert name                                       | Alert context | Alert instance           | Alert role  | Description                                                                                                                                                                                                               |
 |:---------------------------------|:-------------------|:---------|:-------------------------|:-------------------------------------------------|:--------------|:-------------------------|:------------|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
 | Space silencing                  | All Rooms          | *        | *                        | *                                                | *             | *                        | *           | This rule silences the entire space, targets all nodes, and for all users. E.g. infrastructure-wide maintenance window.                                                                                                   |
 | DB Servers Rooms                 | PostgreSQL Servers | *        | *                        | *                                                | *             | *                        | *           | This rule silences the nodes in the Room named PostgreSQL Servers, for example, it doesn't silence the `All Nodes` Room. E.g. My team with membership to this Room doesn't want to receive notifications for these nodes. |

+ 22 - 22
docs/alerts-and-notifications/notifications/centralized-cloud-notifications/manage-notification-methods.md

@@ -9,7 +9,7 @@ From the Cloud interface, you can manage your Space's notification settings as w
 To manage Space notification settings, you will need the following:
 
 - A Netdata Cloud account
-- Access to the Space as an **administrator**
+- Access to Space as an **administrator**
 
 ### Available Actions per Notification Method Based on Service Level
 
@@ -31,20 +31,20 @@ To manage Space notification settings, you will need the following:
 2. Click on the **Alerts & Notifications** tab on the left-hand side.
 3. Click on the **Notification Methods** tab.
 4. You will be presented with a table of the configured notification methods for the Space. You will be able to:
-   1. **Add a new** notification method configuration.
-      - Choose the service from the list of available ones. The available options will depend on your subscription plan.
-      - You can optionally provide a name for the configuration so you can easily refer to it.
-      - You can define the filtering criteria, regarding which Rooms the method will apply, and what notifications you want to receive (All Alerts and unreachable, All Alerts, Critical only).
-      - Depending on the service, different inputs will be present. Please note that there are mandatory and optional inputs.
-         - If you have doubts on how to configure the service, you can find a link at the top of the modal that takes you to the specific documentation page to help you.
-   2. **Edit an existing** notification method configuration. Personal level ones can't be edited here, see [Manage User Notification Settings](#manage-user-notification-settings). You will be able to change:
-      - The name provided for it
-      - Filtering criteria
-      - Service-specific inputs
-   3. **Enable/Disable** a given notification method configuration.
-      - Use the toggle to enable or disable the notification method configuration.
-   4. **Delete an existing** notification method configuration. Netdata provided ones can't be deleted, e.g., Email.
-      - Use the trash icon to delete your configuration.
+    1. **Add a new** notification method configuration.
+        - Choose the service from the list of available ones. The available options will depend on your subscription plan.
+        - You can optionally provide a name for the configuration so you can refer to it.
+        - You can define the filtering criteria, regarding which Rooms the method will apply, and what notifications you want to receive (All Alerts and unreachable, All Alerts, Critical only).
+        - Depending on the service, different inputs will be present. Please note that there are mandatory and optional inputs.
+            - If you have doubts on how to configure the service, you can find a link at the top of the modal that takes you to the specific documentation page to help you.
+    2. **Edit an existing** notification method configuration. Personal level ones can't be edited here, see [Manage User Notification Settings](#manage-user-notification-settings). You will be able to change:
+        - The name provided for it
+        - Filtering criteria
+        - Service-specific inputs
+    3. **Enable/Disable** a given notification method configuration.
+        - Use the toggle to enable or disable the notification method configuration.
+    4. **Delete an existing** notification method configuration. Netdata provided ones can't be deleted, e.g., Email.
+        - Use the trash icon to delete your configuration.
 
 ## Manage User Notification Settings
 
@@ -61,11 +61,11 @@ Note: If an administrator has disabled a Personal [service level](/docs/alerts-a
 
 1. Click on the **User notification settings** shortcut on top of the help button.
 2. You are presented with:
-   - The Personal [service level](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#service-level) notification methods you can manage.
-   - The list of Spaces and Rooms inside those where you have access to.
+    - The Personal [service level](/docs/alerts-and-notifications/notifications/centralized-cloud-notifications/centralized-cloud-notifications-reference.md#service-level) notification methods you can manage.
+    - The list of Spaces and Rooms inside those where you have access to.
 3. On this modal you will be able to:
-   1. **Enable/Disable** the notification method for you; this applies across all Spaces and Rooms.
-      - Use the toggle to enable or disable the notification method.
-   2. **Define what notifications you want** per Space/Room: All Alerts and unreachable, All Alerts, Critical only, or No notifications.
-   3. **Activate notifications** for a Room you aren't a member of.
-      - From the **All Rooms** tab, click on the Join button for the Room(s) you want.
+    1. **Enable/Disable** the notification method for you; this applies across all Spaces and Rooms.
+        - Use the toggle to enable or disable the notification method.
+    2. **Define what notifications you want** per Space/Room: All Alerts and unreachable, All Alerts, Critical only, or No notifications.
+    3. **Activate notifications** for a Room you aren't a member of.
+        - From the **All Rooms** tab, click on the Join button for the Room(s) you want.

+ 2 - 2
docs/category-overview-pages/working-with-logs.md

@@ -1,8 +1,8 @@
 # Working with Logs
 
-This section talks about ways Netdata collects and visualizes logs.
+This section talks about the ways Netdata collects and visualizes logs.
 
-The [systemd journal plugin](/src/collectors/systemd-journal.plugin/) is the core Netdata component for reading systemd journal logs.
+The [systemd journal plugin](/src/collectors/systemd-journal.plugin) is the core Netdata component for reading systemd journal logs.
 
 For structured logs, Netdata provides tools like [log2journal](/src/collectors/log2journal/README.md) and [systemd-cat-native](/src/libnetdata/log/systemd-cat-native.md) to convert them into compatible systemd journal entries.
 

+ 2 - 2
docs/dashboards-and-charts/README.md

@@ -7,7 +7,7 @@ When you access the Netdata dashboard through the Cloud, you'll always have the
 By default, the Agent dashboard shows the latest version (matching Netdata Cloud). However, there are a few exceptions:
 
 - Without internet access, the Agent can't download the newest dashboards. In this case, it will automatically use the bundled version.
-- Users have defined, e.g. through URL bookmark, that they want to see the previous version of the dashboard (accessible `http://NODE:19999/v1`, replacing `NODE` with the IP address or hostname of your Agent).
+- Users have defined, e.g., through URL bookmark that they want to see the previous version of the dashboard (accessible `http://NODE:19999/v1`, replacing `NODE` with the IP address or hostname of your Agent).
 
 ## Main sections
 
@@ -37,4 +37,4 @@ You can access the dashboard at <https://app.netdata.cloud/> and [sign-in with a
 
 To view your Netdata dashboard, open a web browser and enter the address `http://NODE:19999`  - replace `NODE` with your Agent's IP address or hostname. If the Agent is on the same machine, use `http://localhost:19999`.
 
-Documentation for previous Agent dashboard can still be found [here](/src/web/gui/README.md).
+Documentation for the previous Agent dashboard can still be found [here](/src/web/gui/README.md).

+ 16 - 24
docs/dashboards-and-charts/alerts-tab.md

@@ -4,34 +4,26 @@ Netdata comes with hundreds of pre-configured health alerts designed to notify y
 
 ## Active tab
 
-From the Active tab you can see all the active alerts in your Room. You will be presented with a table having information about each alert that is in warning or critical state.
+From the Active tab, you can see all the active alerts in your Room. You will be presented with a table having information about each alert that is in warning or critical state.
 
 You can always sort the table by a certain column by clicking on the name of that column, and using the gear icon on the top right to control which columns are visible at any given time.
 
 ### Filter alerts
 
-From this tab, you can also filter alerts with the right hand bar. More specifically you can filter:
-
-- Alert status
-  - Filter based on the status of the alerts (e.g. Warning, Critical)
-- Alert class
-  - Filter based on the class of the alert (e.g. Latency, Utilization, Workload etc.)
-- Alert type & component
-  - Filter based on the alert's type (e.g. System, Web Server) and component (e.g. CPU, Disk, Load)
-- Alert role
-  - Filter by the role that the alert is set to notify (e.g. Sysadmin, Webmaster etc.)
-- Host labels
-  - Filter based on the host labels that are configured for the nodes across the Room (e.g. `_cloud_instance_region` to match `us-east-1`)
-- Node status
-  - Filter by node availability status (e.g. Live or Offline)
-- Netdata version
-  - Filter by Netdata version (e.g. `v1.45.3`)
-- Nodes
-  - Filter the alerts based on the nodes of your Room.
+From this tab, you can also filter alerts with the right-hand bar. More specifically, you can filter:
+
+- **Alert status**: Filter based on the status of the alerts (e.g., Warning, Critical)
+- **Alert class**: Filter based on the class of the alert (e.g., Latency, Utilization, Workload, etc.)
+- **Alert type & component**: Filter based on the alert's type (e.g., System, Web Server) and component (e.g., CPU, Disk, Load)
+- **Alert role**: Filter by the role that the alert is set to notify (e.g., Sysadmin, Webmaster etc.)
+- **Host labels**: Filter based on the host labels that are configured for the nodes across the Room (e.g., `_cloud_instance_region` to match `us-east-1`)
+- **Node status**: Filter by node availability status (e.g., Live or Offline)
+- **Netdata version**: Filter by Netdata version (e.g., `v1.45.3`)
+- **Nodes**: Filter the alerts based on the nodes of your Room.
 
 ### View alert details
 
-By clicking on the name of an entry of the table you can access that alert's details page, providing you with:
+By clicking on the name of an entry of the table, you can access that alert's details page, providing you with:
 
 - Latest and Triggered time values
 - The alert's description
@@ -49,9 +41,9 @@ From this tab, the "Silencing" column shows if there is any rule present for eac
 
 ## Alert Configurations tab
 
-From this tab you can view all the configurations for all running alerts in your Room. Each row concerns one alert, and it provides information about it in the rest of the table columns.
+From this tab, you can view all the configurations for all running alerts in your Room. Each row concerns one alert, and it provides information about it in the rest of the table columns.
 
-By running alerts we mean alerts that are related to some metric that is or was collected. Netdata may have more alerts pre-configured that aren't applicable to your monitoring use-cases.
+By running alerts, we mean alerts that are related to some metric that is or was collected. Netdata may have more alerts pre-configured that aren't applicable to your monitoring use-cases.
 
 You can control which columns are visible by using the gear icon on the right-hand side.
 
@@ -61,6 +53,6 @@ Similarly to the previous tab, you can see the silencing status of an alert, whi
 
 From the actions column you can explore the alert's configuration, split by the different nodes that have this alert configured.
 
-From there you can click on any of the rows to get to the individual alert configurations for that node.
+From there, you can click on any of the rows to get to the individual alert configurations for that node.
 
-Click on an alert row to see the alert's page, with all the information about when it was last triggered and what it's configuration is.
+Click on an alert row to see the alert's page, with all the information about when it was last triggered, and what its configuration is.

+ 2 - 2
docs/dashboards-and-charts/anomaly-advisor-tab.md

@@ -22,5 +22,5 @@ The right side of the page displays an anomaly index for the highlighted timelin
 
 ## Usage Tips
 
-- If you are interested in a subset of specific nodes then filtering to just those nodes before highlighting is recommended to get better results. When you highlight a timeframe, Netdata will ask the Agents for a ranking across all metrics, so if there is a subset of nodes there will be less "averaging" going on and you'll get a less noisy ranking.
-- Ideally try and highlight close to a spike or window of interest so that the resulting ranking can narrow-in more easily on the timeline you are interested in.
+- If you are interested in a subset of specific nodes, then filtering to just those nodes before highlighting is recommended to get better results. When you highlight a timeframe, Netdata will ask the Agents for a ranking across all metrics, so if there is a subset of nodes, there will be less "averaging" going on, and you'll get a less noisy ranking.
+- Ideally, try and highlight close to a spike or window of interest so that the resulting ranking can narrow-in more easily on the timeline you are interested in.

+ 14 - 14
docs/dashboards-and-charts/dashboards-tab.md

@@ -10,18 +10,18 @@ From the Dashboards tab, click on the **+** button.
 
 In the modal, give your custom dashboard a name, and click **+ Add**.
 
-- The **Add Chart** button on the top right of the interface adds your first chart card. From the dropdown, select either **All Nodes** or a specific node.  
-  
+- The **Add Chart** button on the top right of the interface adds your first chart card. From the dropdown, select either **All Nodes** or a specific node.
+
   Next, select the context. You'll see a preview of the chart before you finish adding it. In this modal you can also [interact with the chart](/docs/dashboards-and-charts/netdata-charts.md), meaning you can configure all the aspects of the [NIDL framework](/docs/dashboards-and-charts/netdata-charts.md#nidl-framework) of the chart and more in detail, you can:
-  - define which `group by` method to use
-  - select the aggregation function over the data source
-  - select nodes
-  - select instances
-  - select dimensions
-  - select labels
-  - select the aggregation function over time
-  
-  After you are done configuring the chart, you can also change the type of the chart from the right hand side of the [Title bar](/docs/dashboards-and-charts/netdata-charts.md#title-bar), and select which of the final dimensions you want to be visible and in what order, from the [Dimensions bar](/docs/dashboards-and-charts/netdata-charts.md#dimensions-bar).
+    - define which `group by` method to use
+    - select the aggregation function over the data source
+    - select nodes
+    - select instances
+    - select dimensions
+    - select labels
+    - select the aggregation function over time
+
+  After you are done configuring the chart, you can also change the type of the chart from the right-hand side of the [Title bar](/docs/dashboards-and-charts/netdata-charts.md#title-bar), and select which of the final dimensions you want to be visible and in what order, from the [Dimensions bar](/docs/dashboards-and-charts/netdata-charts.md#dimensions-bar).
 
 - The **Add Text** button on the top right of the interface creates a new card with user-defined text, which you can use to describe or document a particular dashboard's meaning and purpose.
 
@@ -52,11 +52,11 @@ new location. Once you release your mouse, other elements re-sort to the grid sy
 
 ### Resize elements
 
-To resize any element on a dashboard, click on the bottom-right corner and drag it to its new size. Other elements re-sort to the grid system automatically.
+To resize any element on a dashboard, click in the bottom-right corner and drag it to its new size. Other elements re-sort to the grid system automatically.
 
 ### Go to chart
 
-Quickly jump to the location of the chart in either the [Metrics tab](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md) or if the chart refers to a single node, its single node dashboard by clicking the 3-dot icon in the corner of any chart to open a menu. Hit the **Go to Chart** item.
+Quickly jump to the location of the chart in either the [Metrics tab](/docs/dashboards-and-charts/metrics-tab-and-single-node-tabs.md) or if the chart refers to a single node, its single node dashboard by clicking the 3-dot icon in the corner of any chart to open a menu. Hit the **Go-to-Chart** item.
 
 You'll land directly on that chart of interest, but you can now scroll up and down to correlate your findings with other
 charts. Of course, you can continue to zoom, highlight, and pan through time just as you're used to with Netdata Charts.
@@ -93,4 +93,4 @@ Because of the visual complexity of individual charts, dashboards require a mini
 
 ## What's next?
 
-Once you've designed a dashboard or two, make sure to [invite your team](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#invite-your-team) if you haven't already. You can add these new users to the same Room to let them see the same dashboards without any effort.
+Once you've designed a dashboard or two, make sure to [invite your team](/docs/netdata-cloud/organize-your-infrastructure-invite-your-team.md#team-collaboration) if you haven't already. You can add these new users to the same Room to let them see the same dashboards without any effort.

+ 3 - 3
docs/dashboards-and-charts/events-feed.md

@@ -61,14 +61,14 @@ At a high-level view, these are the domains from which the Events feed will prov
 
 ## Who can access the events?
 
-All users will be able to see events from the Topology and Alerts domain but Auditing events, once these are added, will only be accessible to administrators. For more details check the [Netdata Role-Based Access model](/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md).
+All users will be able to see events from the Topology and Alerts domain, but Auditing events, once these are added, will only be accessible to administrators. For more details, check the [Netdata Role-Based Access model](/docs/netdata-cloud/authentication-and-authorization/role-based-access-model.md).
 
 ## How to use the events feed
 
 1. Click on the **Events** tab (located near the top of your screen)
 2. You will be presented with a table listing the events that occurred from the timeframe defined on the [date time picker](/docs/dashboards-and-charts/visualization-date-and-time-controls.md#date-and-time-selector)
-3. You can use the filtering capabilities available on right-hand bar to slice through the results provided
+3. You can use the filtering capabilities available on the right-hand bar to slice through the results provided
 
 > **Note**
 >
-> When you try to query a longer period than what your space allows you will see an error message highlighting that you are querying data outside your plan.
+> When you try to query a longer period than what your space allows, you will see an error message highlighting that you are querying data outside your plan.

Некоторые файлы не были показаны из-за большого количества измененных файлов