From f4506b759c1fcf78645fe03913f52f82c5f38500 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Fri, 7 Feb 2025 23:29:47 +0300 Subject: [PATCH 01/17] Harmonize the use of doc icons --- documentation/WRITERS-NOTES.md | 1 - .../docs/install-pmm/install-pmm-client/connect-database/aws.md | 2 +- .../install-pmm/install-pmm-client/connect-database/mysql.md | 2 +- documentation/variables.yml | 1 - 4 files changed, 2 insertions(+), 4 deletions(-) diff --git a/documentation/WRITERS-NOTES.md b/documentation/WRITERS-NOTES.md index 11f2cc0846..527bd772af 100644 --- a/documentation/WRITERS-NOTES.md +++ b/documentation/WRITERS-NOTES.md @@ -187,7 +187,6 @@ Custom (in-house design) icons are defined as SVG code in `variables.yml`. | Usage | Description | Used where | | ---------------------- | ------------------------------------ | -------------------------------- | -| `{{icon.addinstance}}` | Thin + in circle | PMM Add Instance | | `{{icon.checks}}` | Checkbox list items | Inventory list | | `{{icon.inventory}}` | Checkbox list items | PMM Inventory & Inventory List | | `{{icon.dashboards}}` | Abstract blocks assembly | PMM Dashboards | diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/aws.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/aws.md index ed119c1d76..b0fcd70bb9 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/aws.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/aws.md @@ -153,7 +153,7 @@ GRANT SELECT, UPDATE, DELETE, DROP ON performance_schema.* TO 'pmm'@'%'; It may take longer for PMM to discover Amazon RDS instances in the `creating` state. You must wait a bit longer until PMM discovers these instances. -The preferred method of adding an Amazon RDS database instance to PMM is via the **Configuration** → {{icon.inventory}} **PMM Inventory** → {{icon.addinstance}} **Add Instance** menu option. +The preferred method of adding an Amazon RDS database instance to PMM is via the :material-cog: **Configuration** → {{icon.inventory}} **PMM Inventory** → :material-plus-circle-outline: **Add Instance** menu option. This method supports Amazon RDS database instances that use Amazon Aurora, MySQL, or MariaDB engines, as well as any remote PostgreSQL, ProxySQL, MySQL and MongoDB instances. diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md index 6f4385c34d..e7f23931ae 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md @@ -388,7 +388,7 @@ pmm-admin add mysql --environment=test --custom-labels='source=slowlog' --usern If you need to monitor a MySQL instance from a different server where PMM Client is installed, follow these steps in the PMM web interface: {.power-number} -1. Select ** PMM Configuration > PMM Inventory > {{icon.addinstance}} Add Service**. +1. Select :material-cog: **PMM Configuration > PMM Inventory > :material-plus-circle-outline: Add Service**. 2. Choose **MySQL > Add a remote instance**. diff --git a/documentation/variables.yml b/documentation/variables.yml index e2a5dd0cc1..297e5a84d1 100644 --- a/documentation/variables.yml +++ b/documentation/variables.yml @@ -12,5 +12,4 @@ icon: dashboards: inventory: node: - addinstance: bouncingellipsis: From cd905d4002b80ff744ab42daab39d169efbf9e04 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Fri, 7 Feb 2025 23:54:57 +0300 Subject: [PATCH 02/17] Replace the cog icon --- documentation/WRITERS-NOTES.md | 2 +- documentation/docs/advisors/advisors.md | 2 +- .../docs/backup/mongodb-backup/mongo_prerequisites.md | 2 +- .../docs/backup/mysql-backup/mysql_prerequisites.md | 2 +- .../percona_platform/check_percona_platform.md | 2 +- documentation/docs/how-to/integrate-platform.md | 2 +- .../install-pmm-client/connect-database/mysql.md | 2 +- .../install-pmm-client/connect-database/postgresql.md | 2 +- .../custom_dashboard/set_custom_for_org.md | 2 +- .../dashboards-panels/custom_dashboard/set_custom_team.md | 2 +- .../custom_dashboard/set_personal_home.md | 2 +- .../dashboards-panels/manage-dashboards/manage-folders.md | 8 ++++---- documentation/docs/reference/ui/ui_components.md | 6 +++--- documentation/docs/use/dashboard-inventory.md | 2 +- .../dashboards-panels/manage-dashboards/manage-folders.md | 2 +- .../manage-dashboards/set-custom-dashboard.md | 4 ++-- documentation/docs/use/dashboards/dashboard-inventory.md | 2 +- 17 files changed, 23 insertions(+), 23 deletions(-) diff --git a/documentation/WRITERS-NOTES.md b/documentation/WRITERS-NOTES.md index 527bd772af..7b2ef67787 100644 --- a/documentation/WRITERS-NOTES.md +++ b/documentation/WRITERS-NOTES.md @@ -151,7 +151,7 @@ Use HTML for icons: | | Lightening flash/bolt | PMM UI - Nodes compare | | | Right caret | General | | | Clock (at nine) | PMM UI - Time range selector | -| | Cog wheel | PMM UI Configuration | +| :material-cog: | Cog wheel | PMM UI Configuration | | | Share comment symbol | PMM UI - Share dashboard image | | | Compass | PMM UI - Explore | | | Copy | PMM UI - Copy (e.g. backup schedule) | diff --git a/documentation/docs/advisors/advisors.md b/documentation/docs/advisors/advisors.md index c1d8f59ec4..308dfc1371 100644 --- a/documentation/docs/advisors/advisors.md +++ b/documentation/docs/advisors/advisors.md @@ -21,7 +21,7 @@ If you are a Percona customer with a Percona Customer Portal account, you also g To see the complete list of available checks, see the [Advisor Checks for PMM](https://docs.percona.com/percona-platform/advisors.html) topic in the Percona Platform documentation. ## Enable/Disable -To download the checks available for your Percona Account, the Advisors and Telemetry options have to be enabled under **Configuration > Settings > Advanced Settings**. +To download the checks available for your Percona Account, the Advisors and Telemetry options have to be enabled under :material-cog: **Configuration > Settings > Advanced Settings**. These options are enabled by default so that PMM can run automatic Advisor checks in the background. However, you can disable them at any time if you do not need to check the health and performance of your connected databases. diff --git a/documentation/docs/backup/mongodb-backup/mongo_prerequisites.md b/documentation/docs/backup/mongodb-backup/mongo_prerequisites.md index d6c69b5185..8990f21b66 100644 --- a/documentation/docs/backup/mongodb-backup/mongo_prerequisites.md +++ b/documentation/docs/backup/mongodb-backup/mongo_prerequisites.md @@ -3,7 +3,7 @@ Before creating MongoDB backups, make sure to: {.power-number} -1. Check that **Backup Management** is enabled and the Backup option is available on the side menu. If Backup Management has been disabled on your instance, go to **Configuration > PMM Settings > Advanced Settings**, re-enable **Backup Management** then click **Apply changes**. +1. Check that **Backup Management** is enabled and the Backup option is available on the side menu. If Backup Management has been disabled on your instance, go to :material-cog: **Configuration > PMM Settings > Advanced Settings**, re-enable **Backup Management** then click **Apply changes**. 2. [Prepare and create a storage location for your backups](../prepare_storage_location.md). 3. Check that [PMM Client](../../install-pmm/install-pmm-client/index.md) is installed and running on all MongoDB nodes in the cluster. 4. Check that [Percona Backup for MongoDB](https://docs.percona.com/percona-backup-mongodb/index.html) (PBM) is installed and `pbm-agent` is running on all MongoDB nodes in the replica set. Make sure to [configure the MongoDB connection URI for pbm-agent](https://docs.percona.com/percona-backup-mongodb/install/initial-setup.html#set-the-mongodb-connection-uri-for-pbm-agent) on all nodes. diff --git a/documentation/docs/backup/mysql-backup/mysql_prerequisites.md b/documentation/docs/backup/mysql-backup/mysql_prerequisites.md index 71df9815f9..57f7eb1879 100644 --- a/documentation/docs/backup/mysql-backup/mysql_prerequisites.md +++ b/documentation/docs/backup/mysql-backup/mysql_prerequisites.md @@ -3,7 +3,7 @@ Before creating MySQL backups, make sure to: {.power-number} -1. Check that **Backup Management** is enabled and the Backup option is available on the side menu. If Backup Managemt has been disabled on your instance, go to **Configuration > PMM Settings > Advanced Settings**, re-enable **Backup Management** then click **Apply changes**. +1. Check that **Backup Management** is enabled and the Backup option is available on the side menu. If Backup Managemt has been disabled on your instance, go to :material-cog: **Configuration > PMM Settings > Advanced Settings**, re-enable **Backup Management** then click **Apply changes**. !!! caution alert alert-warning "Important" If PMM Server runs as a Docker container, enable backup features at container creation time by adding `-e ENABLE_BACKUP_MANAGEMENT=1` to your `docker run` command. diff --git a/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md b/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md index 858d8f2291..c16318e09a 100644 --- a/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md +++ b/documentation/docs/configure-pmm/percona_platform/check_percona_platform.md @@ -26,7 +26,7 @@ After connecting to the Percona Platform, PMM has access to [additional alert te Disconnect a PMM instance when you want to unlink it from your Percona Platform organization or stop monitoring it there. -To disconnect a PMM Server, go to **Configuration > Settings > Percona Platform** and click **Disconnect**. +To disconnect a PMM Server, go to :material-cog: **Configuration > Settings > Percona Platform** and click **Disconnect**. #### Disconnecting instances as an Admin diff --git a/documentation/docs/how-to/integrate-platform.md b/documentation/docs/how-to/integrate-platform.md index 1a880fe454..c1bd0f960c 100644 --- a/documentation/docs/how-to/integrate-platform.md +++ b/documentation/docs/how-to/integrate-platform.md @@ -45,7 +45,7 @@ After connecting to the Percona Platform, PMM has access to additional alert tem ### Disconnect a PMM instance Disconnect a PMM instance when you want to unlink it from your Percona Platform organization or stop monitoring it there. -To disconnect a PMM Server, go to > **Configuration > Settings > Percona Platform** and click **Disconnect**. +To disconnect a PMM Server, go to :material-cog: **Configuration > Settings > Percona Platform** and click **Disconnect**. #### Disconnecting instances as an Admin diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md index e7f23931ae..fd32a47b07 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/mysql.md @@ -381,7 +381,7 @@ Add the database server as a service using one of these example commands. If suc #### TLS connection ```sh -pmm-admin add mysql --environment=test --custom-labels='source=slowlog' --username=root --password=password --query-source=slowlog MySQLSlowLog localhost:3306 +pmm-admin add mysql --environment=test --custom-labels='source=slowlog' --username=root --password=password --tls --tls-skip-verify --tls-ca=pathtoca.pem --tls-cert=pathtocert.pem --tls-key=pathtocertkey.pem --query-source=slowlog MySQLSlowLog localhost:3306 ``` ### Install PMM Client as a remote instance diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/postgresql.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/postgresql.md index fa2f8743c2..576eef94d5 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/postgresql.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/postgresql.md @@ -373,7 +373,7 @@ The `pmm-admin` flag limits Auto-discovery: To check the service from the PMM UI: {.power-number} -1. Select **Configuration** → {{icon.inventory}} **Inventory**. +1. Select :material-cog: **Configuration** → {{icon.inventory}} **Inventory**. 2. In the **Services** tab, verify the **Service name**, **Address** and any other relevant details. 3. In the **Options** column, expand the **Details** section and check that the Agents are using the desired data source. diff --git a/documentation/docs/reference/ui/dashboards-panels/custom_dashboard/set_custom_for_org.md b/documentation/docs/reference/ui/dashboards-panels/custom_dashboard/set_custom_for_org.md index 00b028aecc..8ad92f7f67 100644 --- a/documentation/docs/reference/ui/dashboards-panels/custom_dashboard/set_custom_for_org.md +++ b/documentation/docs/reference/ui/dashboards-panels/custom_dashboard/set_custom_for_org.md @@ -5,7 +5,7 @@ Organization Admins can set the home dashboard for their organization. For infor 1. Navigate to the dashboard that you want to set as the home dashboard. 2. Click the star next to the dashboard title to mark the dashboard as a favorite. -3. Hover your cursor over *Configuration* +3. Hover your cursor over :material-cog: *Configuration* 4. Click *Preferences*. 5. In the Home Dashboard field, select the dashboard that you want to set as your home dashboard. 6. Click *Save*. diff --git a/documentation/docs/reference/ui/dashboards-panels/custom_dashboard/set_custom_team.md b/documentation/docs/reference/ui/dashboards-panels/custom_dashboard/set_custom_team.md index 17605adc61..d198034030 100644 --- a/documentation/docs/reference/ui/dashboards-panels/custom_dashboard/set_custom_team.md +++ b/documentation/docs/reference/ui/dashboards-panels/custom_dashboard/set_custom_team.md @@ -4,7 +4,7 @@ Organization and team Admins can set the home dashboard for their team as follow 1. Navigate to the dashboard that you want to set as your home dashboard. 2. Click star next to the dashboard to mark the dashboard as a favorite. -3. On the main menu, hover your cursor over *Configuration*. +3. On the main menu, hover your cursor over :material-cog: *Configuration*. 4. Click *Teams*. Grafana displays the team list. 5. Click on the team for whom you want to set the home dashboard and then navigate to the *Settings* tab. 6. In the Home Dashboard field, select the dashboard that you want to use for your home dashboard. diff --git a/documentation/docs/reference/ui/dashboards-panels/custom_dashboard/set_personal_home.md b/documentation/docs/reference/ui/dashboards-panels/custom_dashboard/set_personal_home.md index 332c96bf5f..6b916fbdde 100644 --- a/documentation/docs/reference/ui/dashboards-panels/custom_dashboard/set_personal_home.md +++ b/documentation/docs/reference/ui/dashboards-panels/custom_dashboard/set_personal_home.md @@ -9,7 +9,7 @@ The home dashboard you set is the dashboard all the users will see after logging ![!image](../../images/PMM_click_to_add_favorite_dashboard.png) -3. From the side menu go to *Configuration > Preferences*. In the *Home Dashboard* field, select the dashboard that you want to set as your home dashboard. +3. From the side menu go to :material-cog: *Configuration > Preferences*. In the *Home Dashboard* field, select the dashboard that you want to set as your home dashboard. ![!image](../../images/PMM_set_home_dashboard.png) diff --git a/documentation/docs/reference/ui/dashboards-panels/manage-dashboards/manage-folders.md b/documentation/docs/reference/ui/dashboards-panels/manage-dashboards/manage-folders.md index cc277eb24b..29010a7244 100644 --- a/documentation/docs/reference/ui/dashboards-panels/manage-dashboards/manage-folders.md +++ b/documentation/docs/reference/ui/dashboards-panels/manage-dashboards/manage-folders.md @@ -26,7 +26,7 @@ The other way of moving dashboards from one folder to another is: 1. Open the dashboard that you want to move to another folder. -2. Click on icon to open *Dashboard Settings*. +2. Click on :material-cog: icon to open *Dashboard Settings*. 3. On the *General* page, under *Folder* select the folder name that you want to move from the dropdown. ![!image](../../../images/PMM_Move_dashboards-way2.png) @@ -54,7 +54,7 @@ Organization Admins can set the home dashboard for their organization. For infor 1. Navigate to the dashboard that you want to set as the home dashboard. 2. Click the star next to the dashboard title to mark the dashboard as a favorite. -3. Hover your cursor over *Configuration* +3. Hover your cursor over :material-cog: *Configuration* 4. Click *Preferences*. 5. In the Home Dashboard field, select the dashboard that you want to set as your home dashboard. 6. Click *Save*. @@ -66,7 +66,7 @@ Organization and team Admins can set the home dashboard for their team as follow 1. Navigate to the dashboard that you want to set as your home dashboard. 2. Click star next to the dashboard to mark the dashboard as a favorite. -3. On the main menu, hover your cursor over *Configuration*. +3. On the main menu, hover your cursor over :material-cog: *Configuration*. 4. Click *Teams*. Grafana displays the team list. 5. Click on the team for whom you want to set the home dashboard and then navigate to the *Settings* tab. 6. In the Home Dashboard field, select the dashboard that you want to use for your home dashboard. @@ -81,7 +81,7 @@ Organization and team Admins can set the home dashboard for their team as follow ![!image](../../../images/PMM_click_to_add_favorite_dashboard.png) -3. From the side menu go to *Configuration > Preferences*. In the *Home Dashboard* field, select the dashboard that you want to set as your home dashboard. +3. From the side menu go to :material-cog: *Configuration > Preferences*. In the *Home Dashboard* field, select the dashboard that you want to set as your home dashboard. ![!image](../../../images/PMM_set_home_dashboard.png) diff --git a/documentation/docs/reference/ui/ui_components.md b/documentation/docs/reference/ui/ui_components.md index 8edbc1c55f..8a923295c1 100644 --- a/documentation/docs/reference/ui/ui_components.md +++ b/documentation/docs/reference/ui/ui_components.md @@ -20,9 +20,9 @@ The main menu is part of the Grafana framework and is visible on every page. | | Query Analytics (QAN) | Navigate to the Query Analytics dashboard where you can analyze database queries over time, optimize database performance, and identify the source of problems. | | Alerting | [Alerting](../../alert/index.md), Create new alerts and manage your alert rules and alert templates. | | Advisors | Run health assessment checks against your connected databases and check any failed checks. -| | Backup | [Backup management and storage location configuration][BACKUP]. The Backup icon appears when **Backup Management** is activated in **PMM Configuration > Settings > Advanced Settings**. -| | Connections | Access Grafana's built-in data sources within PMM to seamlessly integrate and visualize data from various systems like Prometheus, MySQL, PostgreSQL, InfluxDB, and Elasticsearch. -| | PMM Configuration|| Hosts all PMM-related configuration and inventory options. | +| | Backup | [Backup management and storage location configuration][BACKUP]. The Backup icon appears when **Backup Management** is activated in :material-cog: **PMM Configuration > Settings > Advanced Settings**. +| :material-cog: | Connections | Access Grafana's built-in data sources within PMM to seamlessly integrate and visualize data from various systems like Prometheus, MySQL, PostgreSQL, InfluxDB, and Elasticsearch. +| :material-cog: | PMM Configuration|| Hosts all PMM-related configuration and inventory options. | | | Administration |Hosts all Grafana-related configuration and inventory options. | | Entitlements |This tab is displayed after connecting PMM to Percona Portal, and shows all your Percona Platform account information. | | List of tickets opened by Customer Support | Shows the list of tickets opened across your organization. This tab is only available after you connect PMM to Percona Platform. diff --git a/documentation/docs/use/dashboard-inventory.md b/documentation/docs/use/dashboard-inventory.md index 167da7f01b..b70cda158b 100644 --- a/documentation/docs/use/dashboard-inventory.md +++ b/documentation/docs/use/dashboard-inventory.md @@ -2,7 +2,7 @@ The **Inventory** dashboard is a high-level overview of all objects registered in PMM. -To check your inventory list, go to **Configuration** > **Inventory**. +To check your inventory list, go to :material-cog: **Configuration** > **Inventory**. ![!image](../images/Inventory.png) diff --git a/documentation/docs/use/dashboards-panels/manage-dashboards/manage-folders.md b/documentation/docs/use/dashboards-panels/manage-dashboards/manage-folders.md index 2fcfc90dd0..a215658af3 100644 --- a/documentation/docs/use/dashboards-panels/manage-dashboards/manage-folders.md +++ b/documentation/docs/use/dashboards-panels/manage-dashboards/manage-folders.md @@ -23,7 +23,7 @@ The other way of moving dashboards from one folder to another is: {.power-number} 1. On the **Dashboards** page, click on the dashboard that you want to move to another folder. -2. Click on Dashboard settings icon at the top of the page. +2. Click on :material-cog: Dashboard settings icon at the top of the page. 3. On the **General** tab, use the **Folder** drop-down menu to select the new target folder. 4. Click **Save Dashboard** on the the left to save the change. ![!image](../../../images/PMM_Move_dashboards-way2.png) diff --git a/documentation/docs/use/dashboards-panels/manage-dashboards/set-custom-dashboard.md b/documentation/docs/use/dashboards-panels/manage-dashboards/set-custom-dashboard.md index e8a819979b..d42f2a6fc4 100644 --- a/documentation/docs/use/dashboards-panels/manage-dashboards/set-custom-dashboard.md +++ b/documentation/docs/use/dashboards-panels/manage-dashboards/set-custom-dashboard.md @@ -9,7 +9,7 @@ Organization Admins can set the home dashboard for their organization. For infor 1. From the side menu, go to **Dashboards** and click on the dashboard that you want to set as the home dashboard. 2. Click the star on top of the page to mark the dashboard as a favorite. -3. From the main menu on the left, go to **Administration > Default preferences**. +3. From the main menu on the left, go to :material-cog: **Administration > Default preferences**. 4. In the **Home Dashboard** field, select the dashboard that you want to set as your home dashboard. 5. Click **Save**. @@ -20,7 +20,7 @@ Organization and team Admins can set the home dashboard for their team as follow 1. Navigate to the dashboard that you want to set as your home dashboard. 2. Click star next to the dashboard title to mark the dashboard as a favorite. -3. From the main menu on the left, go to **Administration > Users and access > Teams**. +3. From the main menu on the left, go to :material-cog: **Administration > Users and access > Teams**. 4. Click on the team for whom you want to set the home dashboard and then navigate to the **Settings** tab. 5. In the **Home Dashboard** field, select the dashboard that you want to use for your home dashboard. 6. Click **Save**. \ No newline at end of file diff --git a/documentation/docs/use/dashboards/dashboard-inventory.md b/documentation/docs/use/dashboards/dashboard-inventory.md index 1247d1aadb..709972fa02 100644 --- a/documentation/docs/use/dashboards/dashboard-inventory.md +++ b/documentation/docs/use/dashboards/dashboard-inventory.md @@ -2,7 +2,7 @@ The **Inventory** dashboard is a high-level overview of all objects registered in PMM. -To check your inventory list, go to **PMM Configuration** > **PMM Inventory**. +To check your inventory list, go to :material-cog: **PMM Configuration** > **PMM Inventory**. Inventory objects form a hierarchy with Node at the top, then Service and Agents assigned to a Node. This information is detailed in the two tabs available on this page. From 391ff4e6da603004e3d20887df7e81a366cd397e Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Sat, 8 Feb 2025 00:10:57 +0300 Subject: [PATCH 03/17] Replace the inventory icon --- documentation/WRITERS-NOTES.md | 4 +++- .../install-pmm/install-pmm-client/connect-database/aws.md | 2 +- .../install-pmm-client/connect-database/postgresql.md | 2 +- documentation/variables.yml | 1 - 4 files changed, 5 insertions(+), 4 deletions(-) diff --git a/documentation/WRITERS-NOTES.md b/documentation/WRITERS-NOTES.md index 7b2ef67787..8ba8f1d903 100644 --- a/documentation/WRITERS-NOTES.md +++ b/documentation/WRITERS-NOTES.md @@ -141,6 +141,8 @@ Use HTML for icons: - For PMM UI (Grafana) icons (`uil-` prefix), go to , find an icon, select 'Font' and copy the code here. - For Font Awesome (`fa-` prefix), go to , find an icon, copy the code. +Note: the following list is WIP and will be updated as we go along. + | Unicons icon code | Description | Used where | | -------------------------------------------- | ---------------------------------- | ------------------------------------ | | | Down chevron | PMM UI | @@ -152,6 +154,7 @@ Use HTML for icons: | | Right caret | General | | | Clock (at nine) | PMM UI - Time range selector | | :material-cog: | Cog wheel | PMM UI Configuration | +| :material-clipboard-list-outline: | Clipboard list | PMM UI - Inventory | | | Share comment symbol | PMM UI - Share dashboard image | | | Compass | PMM UI - Explore | | | Copy | PMM UI - Copy (e.g. backup schedule) | @@ -188,7 +191,6 @@ Custom (in-house design) icons are defined as SVG code in `variables.yml`. | Usage | Description | Used where | | ---------------------- | ------------------------------------ | -------------------------------- | | `{{icon.checks}}` | Checkbox list items | Inventory list | -| `{{icon.inventory}}` | Checkbox list items | PMM Inventory & Inventory List | | `{{icon.dashboards}}` | Abstract blocks assembly | PMM Dashboards | | `{{icon.node}}` | Circle surrounded by smaller circles | Node dashboards | | `{{icon.percona}}` | Percona logo | Wherever PMM home icon is needed | diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/aws.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/aws.md index b0fcd70bb9..3c58848aa2 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/aws.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/aws.md @@ -153,7 +153,7 @@ GRANT SELECT, UPDATE, DELETE, DROP ON performance_schema.* TO 'pmm'@'%'; It may take longer for PMM to discover Amazon RDS instances in the `creating` state. You must wait a bit longer until PMM discovers these instances. -The preferred method of adding an Amazon RDS database instance to PMM is via the :material-cog: **Configuration** → {{icon.inventory}} **PMM Inventory** → :material-plus-circle-outline: **Add Instance** menu option. +The preferred method of adding an Amazon RDS database instance to PMM is via the :material-cog: **Configuration** → :material-clipboard-list-outline: **PMM Inventory** → :material-plus-circle-outline: **Add Instance** menu option. This method supports Amazon RDS database instances that use Amazon Aurora, MySQL, or MariaDB engines, as well as any remote PostgreSQL, ProxySQL, MySQL and MongoDB instances. diff --git a/documentation/docs/install-pmm/install-pmm-client/connect-database/postgresql.md b/documentation/docs/install-pmm/install-pmm-client/connect-database/postgresql.md index 576eef94d5..a6fae21506 100644 --- a/documentation/docs/install-pmm/install-pmm-client/connect-database/postgresql.md +++ b/documentation/docs/install-pmm/install-pmm-client/connect-database/postgresql.md @@ -373,7 +373,7 @@ The `pmm-admin` flag limits Auto-discovery: To check the service from the PMM UI: {.power-number} -1. Select :material-cog: **Configuration** → {{icon.inventory}} **Inventory**. +1. Select :material-cog: **Configuration** → :material-clipboard-list-outline: **Inventory**. 2. In the **Services** tab, verify the **Service name**, **Address** and any other relevant details. 3. In the **Options** column, expand the **Details** section and check that the Agents are using the desired data source. diff --git a/documentation/variables.yml b/documentation/variables.yml index 297e5a84d1..71ab710ded 100644 --- a/documentation/variables.yml +++ b/documentation/variables.yml @@ -10,6 +10,5 @@ icon: percona: checks: dashboards: - inventory: node: bouncingellipsis: From 8c339a8a2ba91b71af71a46a2d529572b7937eb9 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Sat, 8 Feb 2025 00:17:08 +0300 Subject: [PATCH 04/17] Replace the bouncingellipsis icon --- documentation/WRITERS-NOTES.md | 1 + documentation/docs/backup/mongodb-backup/create_PITR_mongo.md | 4 ++-- .../docs/backup/mongodb-backup/create_mongo_on_demand.md | 2 +- documentation/docs/backup/mysql-backup/create_mysql_backup.md | 2 +- documentation/variables.yml | 1 - 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/WRITERS-NOTES.md b/documentation/WRITERS-NOTES.md index 8ba8f1d903..93f8d97476 100644 --- a/documentation/WRITERS-NOTES.md +++ b/documentation/WRITERS-NOTES.md @@ -155,6 +155,7 @@ Note: the following list is WIP and will be updated as we go along. | | Clock (at nine) | PMM UI - Time range selector | | :material-cog: | Cog wheel | PMM UI Configuration | | :material-clipboard-list-outline: | Clipboard list | PMM UI - Inventory | +| :material-dots-horizontal: | Triple dots, aligned horizontally | PMM UI - Backup in progress | | | Share comment symbol | PMM UI - Share dashboard image | | | Compass | PMM UI - Explore | | | Copy | PMM UI - Copy (e.g. backup schedule) | diff --git a/documentation/docs/backup/mongodb-backup/create_PITR_mongo.md b/documentation/docs/backup/mongodb-backup/create_PITR_mongo.md index 561102d301..36fb5b2a48 100644 --- a/documentation/docs/backup/mongodb-backup/create_PITR_mongo.md +++ b/documentation/docs/backup/mongodb-backup/create_PITR_mongo.md @@ -49,7 +49,7 @@ Before creating a backup, make sure to check the [MongoDB backup prerequisites]( Unless you are using verified custom workflows, make sure to keep the default **Folder** value coming from the cluster name. Editing this field will impact PMM-PBM integration workflows. 11. Click **Schedule** to start creating the backup artifact. -12. Go to the **All Backups** tab, and check the **Status** column. An animated ellipsis indicator {{icon.bouncingellipsis}} shows that a backup is currently being created. +12. Go to the **All Backups** tab, and check the **Status** column. An animated ellipsis icon :material-dots-horizontal: shows that a backup is currently being created. ![!](../../images/PMM_Backup_Management-MongoDB-PITR-Enable.jpg) @@ -69,4 +69,4 @@ Make sure to disable any other scheduled backup jobs before creating a PITR back ![!](../../images/PMM_Backup_Management-MongoDB-PITR-Enable-Error.jpg) -This constraint applies at the service level. You can still have PITR enabled for one service while having regular scheduled backup jobs for other services. \ No newline at end of file +This constraint applies at the service level. You can still have PITR enabled for one service while having regular scheduled backup jobs for other services. diff --git a/documentation/docs/backup/mongodb-backup/create_mongo_on_demand.md b/documentation/docs/backup/mongodb-backup/create_mongo_on_demand.md index bd8c1424d3..49a2b19917 100644 --- a/documentation/docs/backup/mongodb-backup/create_mongo_on_demand.md +++ b/documentation/docs/backup/mongodb-backup/create_mongo_on_demand.md @@ -30,4 +30,4 @@ To schedule or create an on-demand backup, check the instructions below. If you Unless you are using verified custom workflows, make sure to keep the default **Folder** value coming from the cluster name. Editing this field will impact PMM-PBM integration workflows. 11. To start creating the backup artifact, click **Backup** or **Schedule** at the top of the window, depending on whether you are creating a scheduled or an on-demand backup. -12. Go to the **All Backups** tab, and check the **Status** column. An animated ellipsis indicator {{icon.bouncingellipsis}} shows that a backup is currently being created. +12. Go to the **All Backups** tab, and check the **Status** column. An animated ellipsis icon :material-dots-horizontal: shows that a backup is currently being created. diff --git a/documentation/docs/backup/mysql-backup/create_mysql_backup.md b/documentation/docs/backup/mysql-backup/create_mysql_backup.md index 7bad8a9ed5..4f8a58910b 100644 --- a/documentation/docs/backup/mysql-backup/create_mysql_backup.md +++ b/documentation/docs/backup/mysql-backup/create_mysql_backup.md @@ -20,4 +20,4 @@ To create a backup: 8. Leave the **Folder** field as is. This field is relevant for MongoDB backups to ensure compatibility with PBM wokflows and comes prefilled with the cluster label. 9. Expand **Advanced Settings** to specify the settings for retrying the backup in case of any issues. You can either let PMM retry the backup again (**Auto**), or do it again yourself (**Manual**). Auto retry mode enables you to select up to ten retries and an interval of up to eight hours between retries. 10. To start creating the backup artifact, click **Backup** or **Schedule** at the top of the window, depending on whether you are creating a scheduled or an on-demand backup. -11. Go to the **All Backups** tab, and check the **Status** column. An animated ellipsis indicator {{icon.bouncingellipsis}} shows that a backup is currently being created. +11. Go to the **All Backups** tab, and check the **Status** column. An animated ellipsis icon :material-dots-horizontal: shows that a backup is currently being created. diff --git a/documentation/variables.yml b/documentation/variables.yml index 71ab710ded..fd25d002c9 100644 --- a/documentation/variables.yml +++ b/documentation/variables.yml @@ -11,4 +11,3 @@ icon: checks: dashboards: node: - bouncingellipsis: From 2aca001b85dcfea782ddc4e6d1881200629609d8 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Sat, 8 Feb 2025 00:30:22 +0300 Subject: [PATCH 05/17] Replace the checks icon (advisors) --- documentation/WRITERS-NOTES.md | 2 +- documentation/docs/advisors/advisors.md | 10 +++++----- documentation/docs/images/edit.png | Bin 427 -> 0 bytes documentation/variables.yml | 1 - 4 files changed, 6 insertions(+), 7 deletions(-) delete mode 100644 documentation/docs/images/edit.png diff --git a/documentation/WRITERS-NOTES.md b/documentation/WRITERS-NOTES.md index 93f8d97476..a353affa31 100644 --- a/documentation/WRITERS-NOTES.md +++ b/documentation/WRITERS-NOTES.md @@ -156,6 +156,7 @@ Note: the following list is WIP and will be updated as we go along. | :material-cog: | Cog wheel | PMM UI Configuration | | :material-clipboard-list-outline: | Clipboard list | PMM UI - Inventory | | :material-dots-horizontal: | Triple dots, aligned horizontally | PMM UI - Backup in progress | +| :material-magnify-expand: | Advisors | PMM UI - Advisors | | | Share comment symbol | PMM UI - Share dashboard image | | | Compass | PMM UI - Explore | | | Copy | PMM UI - Copy (e.g. backup schedule) | @@ -191,7 +192,6 @@ Custom (in-house design) icons are defined as SVG code in `variables.yml`. | Usage | Description | Used where | | ---------------------- | ------------------------------------ | -------------------------------- | -| `{{icon.checks}}` | Checkbox list items | Inventory list | | `{{icon.dashboards}}` | Abstract blocks assembly | PMM Dashboards | | `{{icon.node}}` | Circle surrounded by smaller circles | Node dashboards | | `{{icon.percona}}` | Percona logo | Wherever PMM home icon is needed | diff --git a/documentation/docs/advisors/advisors.md b/documentation/docs/advisors/advisors.md index 308dfc1371..a9c84554e9 100644 --- a/documentation/docs/advisors/advisors.md +++ b/documentation/docs/advisors/advisors.md @@ -39,13 +39,13 @@ You can change the standard 24-hour interval to a custom frequency for each Advi To change the frequency of an automatic check: {.power-number} -1. Click **{{icon.checks}} Advisors**. +1. Click :material-magnify-expand: **Advisors**. 2. Select the Advisor tab that contains the check for which you want to change the frequency. 3. Expand the relevant Advisor and scroll through the list to find your check. Alternatively, use the **Filter** section at the top of the table to search checks by Name, Description, Status, or Interval. !!! hint alert alert-success "Tip" If you need to share filtered Advisor results with your team members, send them the PMM URL. This saves your search criteria and results. -4. Click the ![Edit](../images/edit.png) **Interval** icon in the **Actions** column, next to the check you want to update. +4. Click the :material-pencil-box-outline: **Interval** icon in the **Actions** column, next to the check you want to update. 5. Chose an interval and click **Save**. ## Manual checks @@ -54,7 +54,7 @@ In addition to the automatic checks that run every 24 hours, you can also run ch To run checks manually: {.power-number} -1. Click **{{icon.checks}} Advisors** on the main menu. +1. Click :material-magnify-expand: **Advisors** on the main menu. 2. Select the Advisor tab that contains the checks which you want to run manually. 3. Click **Run checks** to run all the available checks for this Advisor group, or expand an Advisor and click **Run** next to each check that you want to run individually. ![!Actions options](../images/PMM_Checks_Actions.png) @@ -69,9 +69,9 @@ The results are sent to PMM Server where you can review any failed checks on the ![!Failed Advisor Checks panel](../images/HomeDashboard.png) -To see more details about the available checks and any checks that failed, click the *{{icon.checks}} Advisors* icon on the main menu. +To see more details about the available checks and any checks that failed, click the :material-magnify-expand: *Advisors* icon on the main menu. -**Check results data *always* remains on the PMM Server.** This is not related to anonymous data sent for Telemetry purposes. +Note: Check results *always* remain on the PMM Server. They are never sent as part of Telemetry. ## Create your own Advisors PMM Advisors offer a set of checks that can detect common security threats, performance degradation, data loss and data corruption. diff --git a/documentation/docs/images/edit.png b/documentation/docs/images/edit.png deleted file mode 100644 index 3eef1d9a8cbbb5f51d417f5838e440d46b4ab73d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 427 zcmV;c0aX5pP)Px#1ZP1_K>z@;j|==^1poj532;bRa{vGi!~g&e!~vBn4jTXf0YFJaK~y+Tm6E}3 zfX$6@|GWEVcftamfzj>a+jJ@%;>qDwyG`|R=-~6~3+a=>0LR;0*TpD`{tsWZuBqx~ zmnvtmSfJxLe}`pR77B5@-Qta9;bybJ!C*jhzlJ-Vj!-2*5MW#Mp0iOK)-+A1l5{@D z{%v14#Da}VSZ+3jDoN86d%d1;B}ZXJQH0uEi?duV(PF)Fih`e4atN!cDpbj8wW>XF z4~0jg5oTFN6MNR{HJYX=Ts;)Nd$=dFhyM=4Fi7WlerVw*7wq*wqjAX#kt7M&wheI{ z1M3m^^D1^r6(ryHaq={QkFQUd&ECP(br_Gww8+DfB(Yr*uy2(x4AJvEaglRC{08m8 V;?IE3)|vnS002ovPDHLkV1jn_xWWJc diff --git a/documentation/variables.yml b/documentation/variables.yml index fd25d002c9..16243deaca 100644 --- a/documentation/variables.yml +++ b/documentation/variables.yml @@ -8,6 +8,5 @@ release_date: 2025-01-30 # For the Percona image icon (encoded inline SVG), see https://css-tricks.com/using-svg/ icon: percona: - checks: dashboards: node: From 2b36fcf162a0e7efc8317b49ce269fb9ace58c91 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Sat, 8 Feb 2025 00:34:29 +0300 Subject: [PATCH 06/17] Replace the dashboards icon --- documentation/WRITERS-NOTES.md | 2 +- documentation/docs/install-pmm/install-pmm-client/docker.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/WRITERS-NOTES.md b/documentation/WRITERS-NOTES.md index a353affa31..186d4d7bd2 100644 --- a/documentation/WRITERS-NOTES.md +++ b/documentation/WRITERS-NOTES.md @@ -157,6 +157,7 @@ Note: the following list is WIP and will be updated as we go along. | :material-clipboard-list-outline: | Clipboard list | PMM UI - Inventory | | :material-dots-horizontal: | Triple dots, aligned horizontally | PMM UI - Backup in progress | | :material-magnify-expand: | Advisors | PMM UI - Advisors | +| :material-view-dashboard: | Abstract blocks assembly | PMM UI - Dashboards | | | Share comment symbol | PMM UI - Share dashboard image | | | Compass | PMM UI - Explore | | | Copy | PMM UI - Copy (e.g. backup schedule) | @@ -192,7 +193,6 @@ Custom (in-house design) icons are defined as SVG code in `variables.yml`. | Usage | Description | Used where | | ---------------------- | ------------------------------------ | -------------------------------- | -| `{{icon.dashboards}}` | Abstract blocks assembly | PMM Dashboards | | `{{icon.node}}` | Circle surrounded by smaller circles | Node dashboards | | `{{icon.percona}}` | Percona logo | Wherever PMM home icon is needed | diff --git a/documentation/docs/install-pmm/install-pmm-client/docker.md b/documentation/docs/install-pmm/install-pmm-client/docker.md index 4dc943773f..6c9bdeb2f4 100644 --- a/documentation/docs/install-pmm/install-pmm-client/docker.md +++ b/documentation/docs/install-pmm/install-pmm-client/docker.md @@ -55,7 +55,7 @@ You can now add services with [`pmm-admin`](../../use/commands/pmm-admin.md) by In the GUI: - - Select {{icon.dashboards}} *PMM Dashboards* → {{icon.node}} *System (Node)* → {{icon.node}} *Node Overview*. + - Select :material-view-dashboard: *PMM Dashboards* → {{icon.node}} *System (Node)* → {{icon.node}} *Node Overview*. - In the *Node Names* menu, select the new node. - Change the time range to see data. From 838c12ce881c24396fbde9306a39b98f6e8d3ed0 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Sat, 8 Feb 2025 00:40:42 +0300 Subject: [PATCH 07/17] Replace the node icon --- documentation/WRITERS-NOTES.md | 4 ++-- documentation/docs/install-pmm/install-pmm-client/docker.md | 2 +- documentation/variables.yml | 2 -- 3 files changed, 3 insertions(+), 5 deletions(-) diff --git a/documentation/WRITERS-NOTES.md b/documentation/WRITERS-NOTES.md index 186d4d7bd2..410ced1144 100644 --- a/documentation/WRITERS-NOTES.md +++ b/documentation/WRITERS-NOTES.md @@ -133,7 +133,7 @@ Currently, we use three different sets of icons: The preference should be given to Mkdocs Material icons, since they were initially designed for `mkdocs` project and work very well with it. In rare cases, when an icon cannot be found in Mkdocs Material, you can find a suitable one on Iconscout. FontAwesome icons do not play well with Mkdocs, so use them with caution and don't forget to apply additional CSS styles in case they don't render well in PDF. -Ideally, we should migrate to using just the two first sets. +Ideally, we should migrate to using just the first set, which offers 10,000+ icons, and is more than sufficient for all our documentation needs. Use HTML for icons: @@ -158,6 +158,7 @@ Note: the following list is WIP and will be updated as we go along. | :material-dots-horizontal: | Triple dots, aligned horizontally | PMM UI - Backup in progress | | :material-magnify-expand: | Advisors | PMM UI - Advisors | | :material-view-dashboard: | Abstract blocks assembly | PMM UI - Dashboards | +| :material-dots-circle: | A circle surrounded by smaller ones| PMM UI - Node dashboards | | | Share comment symbol | PMM UI - Share dashboard image | | | Compass | PMM UI - Explore | | | Copy | PMM UI - Copy (e.g. backup schedule) | @@ -193,7 +194,6 @@ Custom (in-house design) icons are defined as SVG code in `variables.yml`. | Usage | Description | Used where | | ---------------------- | ------------------------------------ | -------------------------------- | -| `{{icon.node}}` | Circle surrounded by smaller circles | Node dashboards | | `{{icon.percona}}` | Percona logo | Wherever PMM home icon is needed | ## Symbols diff --git a/documentation/docs/install-pmm/install-pmm-client/docker.md b/documentation/docs/install-pmm/install-pmm-client/docker.md index 6c9bdeb2f4..932310c984 100644 --- a/documentation/docs/install-pmm/install-pmm-client/docker.md +++ b/documentation/docs/install-pmm/install-pmm-client/docker.md @@ -55,7 +55,7 @@ You can now add services with [`pmm-admin`](../../use/commands/pmm-admin.md) by In the GUI: - - Select :material-view-dashboard: *PMM Dashboards* → {{icon.node}} *System (Node)* → {{icon.node}} *Node Overview*. + - Select :material-view-dashboard: *PMM Dashboards* → :material-dots-circle: *System (Node)* → :material-dots-circle: *Node Overview*. - In the *Node Names* menu, select the new node. - Change the time range to see data. diff --git a/documentation/variables.yml b/documentation/variables.yml index 16243deaca..c12725a9c3 100644 --- a/documentation/variables.yml +++ b/documentation/variables.yml @@ -8,5 +8,3 @@ release_date: 2025-01-30 # For the Percona image icon (encoded inline SVG), see https://css-tricks.com/using-svg/ icon: percona: - dashboards: - node: From 3b5936bfbcb204d4e25ef67514478c75a3869065 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Sat, 8 Feb 2025 00:46:15 +0300 Subject: [PATCH 08/17] Remove the outdated Percona logo icon --- documentation/WRITERS-NOTES.md | 6 ------ documentation/variables.yml | 4 ---- 2 files changed, 10 deletions(-) diff --git a/documentation/WRITERS-NOTES.md b/documentation/WRITERS-NOTES.md index 410ced1144..403afe1645 100644 --- a/documentation/WRITERS-NOTES.md +++ b/documentation/WRITERS-NOTES.md @@ -190,12 +190,6 @@ Note: the following list is WIP and will be updated as we go along. | | Toggle (on) | PMM UI - Toggle switch | | | Trash can | PMM UI - Various 'Delete' operation | -Custom (in-house design) icons are defined as SVG code in `variables.yml`. - -| Usage | Description | Used where | -| ---------------------- | ------------------------------------ | -------------------------------- | -| `{{icon.percona}}` | Percona logo | Wherever PMM home icon is needed | - ## Symbols While MkDocs will automatically replace certain strings with symbols, it's preferable where possible to use unicode symbols for other icons, so that they appear when the raw Markdown is exported as HTML and imported into Google Docs. diff --git a/documentation/variables.yml b/documentation/variables.yml index c12725a9c3..f70aa55c26 100644 --- a/documentation/variables.yml +++ b/documentation/variables.yml @@ -4,7 +4,3 @@ release: '3.0.0' version: '3.0.0' release_date: 2025-01-30 -# SVG icons. Use in markdown as {{icon.}} -# For the Percona image icon (encoded inline SVG), see https://css-tricks.com/using-svg/ -icon: - percona: From c877b7bd5e6d3b58caa7837a2e946eaa8a37bf67 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Sat, 8 Feb 2025 01:28:56 +0300 Subject: [PATCH 09/17] Replace the uil-settings icon --- documentation/WRITERS-NOTES.md | 2 +- documentation/docs/advisors/advisors.md | 2 +- documentation/docs/configure-pmm/advanced_settings.md | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/WRITERS-NOTES.md b/documentation/WRITERS-NOTES.md index 403afe1645..80317fcec6 100644 --- a/documentation/WRITERS-NOTES.md +++ b/documentation/WRITERS-NOTES.md @@ -178,7 +178,7 @@ Note: the following list is WIP and will be updated as we go along. | | Question mark in circle | PMM UI - Help | | | Minus in magnifying glass | PMM UI - Time range zoom out | | | Magnifying glass | PMM UI - Search | -| | Cog wheel | PMM UI Configuration->Settings | +| :material-cog-outline: | Cog wheel | PMM UI Configuration->Settings | | | Share symbol | PMM UI - Share dashboard | | | Shield | PMM UI - Server admin | | | Star | PMM UI - Dashboard favourites | diff --git a/documentation/docs/advisors/advisors.md b/documentation/docs/advisors/advisors.md index a9c84554e9..68bd746555 100644 --- a/documentation/docs/advisors/advisors.md +++ b/documentation/docs/advisors/advisors.md @@ -21,7 +21,7 @@ If you are a Percona customer with a Percona Customer Portal account, you also g To see the complete list of available checks, see the [Advisor Checks for PMM](https://docs.percona.com/percona-platform/advisors.html) topic in the Percona Platform documentation. ## Enable/Disable -To download the checks available for your Percona Account, the Advisors and Telemetry options have to be enabled under :material-cog: **Configuration > Settings > Advanced Settings**. +To download the checks available for your Percona Account, the Advisors and Telemetry options have to be enabled under :material-cog: **Configuration >** :material-cog-outline: **Settings > Advanced Settings**. These options are enabled by default so that PMM can run automatic Advisor checks in the background. However, you can disable them at any time if you do not need to check the health and performance of your connected databases. diff --git a/documentation/docs/configure-pmm/advanced_settings.md b/documentation/docs/configure-pmm/advanced_settings.md index e0ec60696f..a5ae53aa85 100644 --- a/documentation/docs/configure-pmm/advanced_settings.md +++ b/documentation/docs/configure-pmm/advanced_settings.md @@ -16,7 +16,7 @@ PMM Telemetry is based on data collected by various PMM components and stored in -!!! note alert alert-primary "" When PMM is installed, telemetry is not sent immediately. Before the first telemetry report is generated, PMM provides users with a 24-hour grace period to disable telemetry. -To see the metrics being collected by telemetry, from the [main menu](../reference/ui/ui_components.md#main-menu) navigate to **PMM Configuration** > **Settings** > **Advanced Settings** > **Telemetry** and hover over the exclamation mark. +To see the metrics being collected by telemetry, from the [main menu](../reference/ui/ui_components.md#main-menu) navigate to **PMM Configuration** > :material-cog-outline: **Settings** > **Advanced Settings** > **Telemetry** and hover over the exclamation mark. ![!image](../images/PMM_Settings_Advanced_Settings_Telemetry.png) From ddd38d023ce84442f6f52c27e41e3d953d0387ed Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Sat, 8 Feb 2025 01:29:29 +0300 Subject: [PATCH 10/17] Replace mysql, mongodb and postgresql pics with icons --- documentation/docs/images/haproxy-dashboard.png | Bin 5182 -> 0 bytes documentation/docs/images/mysql-dashboard.png | Bin 5230 -> 0 bytes .../docs/images/postresql-dashboard.png | Bin 5435 -> 0 bytes documentation/docs/reference/ui/ui_components.md | 10 +++++----- 4 files changed, 5 insertions(+), 5 deletions(-) delete mode 100644 documentation/docs/images/haproxy-dashboard.png delete mode 100644 documentation/docs/images/mysql-dashboard.png delete mode 100644 documentation/docs/images/postresql-dashboard.png diff --git a/documentation/docs/images/haproxy-dashboard.png b/documentation/docs/images/haproxy-dashboard.png deleted file mode 100644 index d0061e9b5311581c74c1698c374a2f3825f7605b..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 5182 zcmcgvc{tQ<_a7p%g(yOeDNA`~x6LpVBPk>!Tf!{gVPa-5V<)>5k*KE-kwQY&L=?#u zvSn#ek*&p&HS0U7r?=<5p5OI*uiqcPx#pg^zxVmv=X}n&&pF@gK4)fXC@ip300aUF z8y&`*bN;t-hA97L&To^Y0uKlzq)yYt93J=ggw?>BAGMX9K+#cvPoqPBv9d#CCyaf6~z zmETIZ3x)J~Uy5G^*F{q_^+Q}JnkFF&&4GjDe$o3}2P}s@6r@4fo_bov7ysnKbT7$! ziBCsBK;73wmxo72rsYi|`Zg~`$zPfFza7|+Fs;#6LNtYGkfl^cAUixRA{2PsL4)+3T6>Q0MljW{(#s07wa z07W+=1NL@W+pKLDZ4khxhX|axi#R1No;wSF*19_hUbc_Wc+PwCkvw@)i$0zzZF9 zYDRD$$*IG(idUriT ziN`I3hXUeqGqa66w71D0KedzZ{NpsyEeF=7$`AM!fF$&m|0L!Pegt(6S4Dgk>wkx= zdjOXG@Yp{mAkkUV7UIJLtqsDD>J8Tfux>Ojtycv$F16N%Ug5uGfR%{P(fME`q_|n^ zNt8VP!js?o~_KEF@hJyiTCS7&$GdtEOXHtEd=?7+yq>WbP(^KAm*F3Jt?`PR019vt5)s+8Mirdoaa%%d3XRj_py5QXs`??n#Z>Egpjh7am4kI!^&Z@aJ3fwu6Tok7Nq;$8^g-f}Fj$ ztbA0jx%QK&_N^;jFJzWu^2$MLH?$zhj?lGf0k;L^vV0n(r9m+o!V6w4Yi ze$AEt4x!C8`kpY2SrmUL@HRwakiH14=nTXKDYWxP^7w~pgy>5hYXlqbNfh7D|B9b) zOV+!}ZhfDld&Q;kE*X3QI}*;>)LpAnsGF<9)eY6b2K5I)=kT3M{Rsg^9eZIp!4^ks z4PP2y4^`kl%2z4nUNmWJ`ylEeV1tJ#T3z(M6n6<8pLS9AxT^9M3FZ;ih-23d+8pXX zLQA*HoHf%qu9nkd;c!}8EgG9=%FKDa>luukHuJQ*_L=tS)efr}ercNxo*W6wt9fzt=J7oD!$TGI!HTC?CDamX z{)l+%^&}^?wA1k=cS}M`7i|@6PnMXT#$}S(ENpVyP52Gwt+b2<=WV5VrI?pCFNa@N zmTHwOdzP^6JjFe4f3o-_+c8dc6jIrIHvWlqeP2U){bIID=Ce-8F<1}1y()9rlo@Ux zoO+D;4qAG65c-3*$byaf7WXW6DZIf1*`{phob*U88m`pmZ)`^FS?~e-H!;sF1 z^olHuL<`@SvPZ}wQ0f9|;xc(?EUnwA1tEfHL)p^USh%4fr$a$ zf#rwmU)`sg=KIHI*fDcbHCOY&KlHtF3)v8GdS1%H1agYr1Y7S6JLo7Lgm-5MdRe8+9-GBEAHl5l`M@WiW8AC`Q~s z%^=L#boS0zC9(%eAfJ&jl-+^O_j^6m*HKtZdNnlWP8js6uez``#$kJqR*mApr1qrj zR83?dZ2FYBS!Z+R#PrSj=evS*`oT6=U#I9DF*5GIf3%K0UUiNw{M@b1j+>p5u;I$qmO9N4LprLnr3*T`fk<{Rv0gOj>b!JH>(M zmtSLMZjXAN`||YG;6%;e&G#Z+c$Sc_3|7q&Nm(eygiH+{yd zC9Cau>bid+VY+!xL-5k}l0>P?Eh@f?gt23Dw@%->)cHv;a67{;94-#~X#Kg!=gnXN zuu{YtHXW86PWyA}O3JeD?DNaITVW;+FAG}&`y+?zhBJnHEf)*=3e8zSNAuZSh?QDC zH6M0zmD-x9=A>e$qMm;%|8oA9{FrQ4d#6Iiw~FT{uAQ*T-ITk~E!Fc!zVH3iM{Avt z!NS5a7u2sXSIUjb$LmMhTQ8JamP($CIw^2pdmyR2balsbhmU2_t}1Wmfl6oph1fnh zy5}xWPc30@SgzrxTXR*FiW47S%av34o-B4C1XY#60~|h`dA=&l z_s7<5+05O4xZrm>sm^Nv>Yf@(8s2g{{j*D-W(~h%#y+C!y84wbMYY8PhB<~uV?}nU zVAb910v=A{>(8CdBiJ(2WP`pQc~xE(OL(8vmLh@)EV};U%;%WNYfqf2p6|kr`sR;6 zT>e%s$k-vWHZi|kBeD=%AH8cwvQ`!LWJNt&uIfY3c-`=gXITYq`6-WfdX|2&tu2-5 zRkEL~u6Z;)OKofY^S%HxumU$J^4_%n)P+jP1)<3oYsBS-RK~)@o`tXp2OrUeck}uK zPe$Xu?hc&T=WFb5H(mF^=nY{s>#V=NpH`ZQPtT0q$_l|@JS{1x=ixnH_jd)sk6^QL zlas#td@+lsn_O0VU%f4_rpZM~moKOamntYel9vZwO}Ul9VyO~_|&lNi-~06ve-l?_=Bmvq8EDBsi$ zlId4Z4U`S8GRqq|$mnY>o0{eVdAdtm-coM6jFPWqJ-!W=u6S^|R&?~9a$CyV;Z?FA zT?XaH*K=3oQAp5zH zF%*cd4p`d<%TYiF*hH`o-Ic+@`rshn^DS4g$*ZWw41pPzGzyUmEZLi|j#jW7C)n z@P1>22osZEHvW+do&L)Ni*4Y= z@%U%#{t?Zx@O1;=<^YT7=|Khzyf`%XK)@Rjz?#u~09R`~jYFNqi6IW6s`Zjxc3-Hiq(l@-tK?r0IfU}q5=SCpiu=*YVkqzKE0|((`01Ar0Kv75w6k;O-)YMcE zYFISl2h@Z~p;3MR5y}Cn{te2>Knjsf{9nNoGM38ppc6UFXmp|z0C!_JLBPM_jMZnl zGCeqkIqcBCuN!f$=^jif&6Okgd0qcb(!>O7#9*3f#_=s0G7RTCJ6 zh9SYqCPXrgu~A?9{$fXVCNi7=POpPQ;QwcL{=38d!Snys9r#9v`*Be4|2)I*vfsKP z$NTR~oEEz={ng$%55Haz0D}`L4^I34IG>#d0&!Uz;SX9U$6rWjJ@Vv$XhT*h(+n@L zw9__Fq$7F^y7$H4wx~s+K|XuG@z!0L@qL;5UWA%--5jhjRJK7*iwicFYpE4(`8Kt6 zT|q11&5D7GC8=Pd<54cBiAb<4b(R%a71u5@~97rS^lZL}}1^@NlyL z%<@X1u2iO6h-AS@Xt}m-M2EBNgZK<7gx^v9XOX$lXlK>r;>WYB=1XRk)VLIPp6#g^ zVKt~}pKrE}`_z_`t$0afm+@mAtPauQRcvbX&K|qlNyVM>J&KwlVIP-lVIL29O8VFk znchy@qcoa?8^low$8Va{o;5;j(*J^+AO!xMW~2isQ?skSzH+^{)>dYD*bQgwOhnC9kZH>d;1Svl$cy9~2o&a|8^BFUWhM44b)?vW~qKGT;m` z;O}9VQL|RY)zzD@IfT5gN+{`O1CevJUKLj}?TWs!EAa#5L^p)O;Zm;3o^etc2j|&>Ee}gc4r%}zC!KQSgaDCNjc^`D;&G#N z85hw#&Wh{?G2Hn9=lazT)e;2y3?-qpRKMJ>vve5qVdA0eS0gw+^oWyiu#`${1g)&F znprVC@;c;FPxYfzdG4r~Hu2FfxYi;wZM)D?>saZ1JM#HzXM-;V>(weEj*6sa7MVu+ z*l0A1pEsC(F~(_nn8@pysi=vxsLOEWGSU`!x%Wz|@F-0XsBxJQZXh9;ThObVD3Y-d z+~sQ4qp~;P#=#S-aqH#aCUZ>IS7%plEoHxB>5zl6;x5Xyb{sG69{iQ#Jz?Msp$Hhw%;vymM{!TRTENZaqx zzs=L7B#~l!#$Bxuhug}nk*9ixM6P^*Xp`CU zlZ$}o5F*yELwRhnqFlok(L%AFgTcKY!W^)=s}=$rJwP!?Aa55PvKzAlW$J7s^UQWR zh+XaG&7s|8Dwhe*xNR;6Li@L@TT^J%%C0w@lyo(kz z79S<~d8-sG&5;|JS3Y>IbfsOlvR5copqz`JyPNA{&>7p{Be!JIq;{3x^UqWkofsHn zF9}SVVF=9Z>bwVQt&Y4bG{d=>HwPH+-B&<7^9jNDlSJtbdux6M+gi<;Ic`G% z!NW%5VX`hE4*PF}9UKf^-7jkLx$Ue8zXdDuCl ziZ`O;08R+vdSD{j>QB-7dY8PDDm!A%FXq`~OFgci%sa4pJNNuY2bpCyg+co5aGjdH zQa2O^buS?g@jHi*YrTh-7?S=R0hd>XoVnGnKx?8u8GRBsAOPcrbIAu$Us%1^^MbId zwj|Im7;en@CVrfIpibCD!&Adk+*8O?KR>wV$R%SbV6<6?oarqYrI1?rkr)dzNwbUQ z3T6rBdiPf_hywB6I4KJ&`D=|whN%nE3!V$u1=|IM2$8y^L8I_{b4rDZ2NiV`En|@nxpiUc9?(c-Hiz zVak(3=4T&PI{78|URzUL(o~md2@x?n`e39ZzQYZlfnOoaBE}_JC8Ty&)?bRWi1dwY zk^m!=lDd*qT9lH4lSYz4)xm^i!igecQIDh36CcMoN7G^wemB0O*wnoNKSls|^r!os zTTkROZ!l3X4$ZaAE<8IH+qxfVQgXj=LU#?c#hT+bO}tYq5J- z(h0tbZ&c@nHbb4TJ?9y1T$)sf1X=whzVHnpy>d_a{!6BFCb2iPv<9C--KNh=x$5>Y zDm*LZFNbHD{~6wcx%x^e=8$a&;V$9ngk#6h!{<0UJOF;L*RfCt*OuseOaz{Ax`v2e zPL@m#O>Sx~N%a0RpdhcY50IztnzR)>u~aZA9_$iL7+H zNTkl><7*X1bDH=Pbke;{Os}g+d{kd6eth*{Tk+eaNwN2TwnG;i)NlBVjE*0m^i5yr zNSQg*>X(1<@wzC#HGjBiifL{}oNJP6+}LjL*<6QQ?76XL-2I0Ai_epv>#s6ahu5XP ze(UIdrP<&eHCvef6wQJ5zV0{d`nh4LZ?yYM+gIzwfyse==cTK6XYw(`@Zyd9AH-K< zv2Cw$U$D=4sob}A?&J1tSVpyBOLn4bP&E%~_Q@h;!(}CnWe{Tp>|3utd^F7j0_@lrM zR+DyjnW=kUZxyxaq3d~RdiC|Z^`J>ZOSq1tb<`b+DupeN!^dAl1nGod2rsDZl54qd zZjLaYy>&IlUcuX141t;nx~62J^dh$Yq>Y=+Wb3=Ya9N>l%jv}7Ls^)&ORt{BxLO_3 zufto+#G-8x8Pp7Ei~aZIGrpLwH%ET9qwRXDJ#lJcQ&)qmH_M@avnqbz;G9slh;GYV zlS9h9N(Y!`i6h$?*!kGqxvBa=@lxEr)aUZ+XRVI4=G?CNF#KWDXZTssvvknD6E`wF zk|v50JIZTs3<`R#(CKmNZRc^j}E}uZo@&d3GmSeW?A| zm&CNhFNIP#)s&?oNYPwE?<%o>x=VYMCerEyNkDk_>0-{UJ?r`wzj$qIMTP53-bGn2 zRO^d@Yfce%qMOBvJ|}GR&F8NSn(7B{o;;Iw0;E)y-{U`cYeDgJU%#;!QesjO?Cgw@Ph_7S4wo~!1xiEk-IEV(DT zAMM^MCQX(vj*v#qblG+{b$QzxpHe5~z0ae*9E&_HnR|-!)J!fc$I)?#Boxpw(h`_F z_4H4oQs08-W6D&E2dZ!KvB#sP5}^`NVnD%uLPM|fGykk!LQx@cEa7b0*^d=N7fL!A zUGJu${e@{FPvSb4XHtqvXwGw$^~j8Jk9G0&Cceu%3U;&wSgtRv)ihpx68em z@Ow(WrZnq*%k*-aO0gBPI_n`h(B+9-_*w?P=W3OLP0{mgopoCDxwB{rW}L;Bj(g@; zetf>!I6G4%Gch-wSvBmFmETcOnB`9Fo^N7Hus+9KNgY)lo2+wx(_NmUaIVS+{WfwY zc_X=vG}7(Hr|92kn7E6aFp#bA5%6{C~i#uh+(X&9S1ve_rbQXh(R`keZ=9a z`DqaVU$t8y!0n~o7SA04u68IoWUBqNrDsm8C`fk~ad&+B8TSJb{<ymIr!}m%67_Y@f5v65JHC(=-4;M1K2bGq;hO0{}QJ2qzur4wlD|XtIYI3PX0m zsxdq$ENuWlSD!&aq1~}`pbOTOK+*%vR#bt21dJZY9$^Wwq!?lG1T$YM*4EeRB-+;< zt&IWc9|Gz!kSqWXEFA@8co0c6BtsAM9T&+OZ%>0k!0#$_cRi5dwn3nS<#C`9nTiE! zszFuJ5C{aQsjY^^pkOX=915)hgh60XFqCy^szNo9FgOyb4gC27u?$i%IHZlS$xm~v zH$4!ZPNyKjU~g}4HE*~Ynd%CLYHMqQAuuourpnS#rTLKPD26JDw*M~#V=N6#B~a)D zG6}eih;ku&(e*$qvfsVHG6?_1CDDF{iWM~Qwge1SgKYct!(k7~F9v_pWS}U2Q^cTu z=~29>#P2*YXfT$D^}v$oG?p&(7bpc!rju!S^8Wz+OZ+zjtc|d={AJ@Gxp;W|GC`vs zxxn)HXYBq_n|9KNf(6@PX=E=d8hhjdi{^e1a61CX;{*nl=wM7>QKzwDs0UJ4|6OwW zHwgmvQ*w%ir5cevw!PH@*`ldf)>@XI+kvDYji^`@9c#?G^+2o)fT=>XRbkMRFbERD zy3`Ls5J))WhpHtRL%{j`qbeMUfc;ICm4O%(9reE|W6($(nd*UJF(Y`OT(MvZ$rS|r z6=$RonMkIx471q5f1fvJoz$sh9D&FZ{5-LLCuwPkG$+yMC=wcLZmb7ld8kGpU|6XP zQP+g4qg7on+M25BE^xRiN)rN6#o^RZ+L{m)41?ADYrQcU?X?}N?e#xO3PVP-F#b(S zT@wvu)eTM+0*69X5!&h~RTnK5u7(Q+rm3L~MZn-1f1z1Z39PC{5r0SBW`$uPY9TbX zX|V|5a4;4t2uc-&fS^_35EldjqK#0;K~dX<^F6_kW&|3YO!fI$indtKpCcjx_&ukP zDD-w&>49jd3s?;3=Op1DqVZqZ{kh&7k7YsrM`rxK-9K#8$T+$;ii$OK{hnn%I?nOG zstE{#t3iQ^mMAoVv|V3Hf3ZX3Q6yI^tJi@+;QzBb|J~;P;Q9aR4tTr6{n#k*f9~OT z*>ByD<^A_5R*T&p{%Y^6mtP+UEQu8RIy6#nQ%d#dgdEmBwz~`!4Ne6mLcST8W25hb^G1m>sA3dDW-<8|W zL`-#|3&qpKYu#pNzR8Fu14N2F>ED=48RNPN?^$M{C(p(}$t;l60tA9o`5*E`9Nhw+ z4VhyWy0$Ul`HP>rvmdyxGAClj9E>u`ioaB4I0Hy6w9#hf?BGNsoG}vjZfhW5PM~7+ z&OjA2!M1CaxiX-iopfo*gHukpYo>Brl=qi!s>OH_LhmXtzg=A#QHY*b|!_3%1c2PnrA+lx58WKsCY$02g z5=D}frR>{0qx$vqdp^JS^FE*Vk9R(E-*es9IoJ1m&$-Syb6-(rriOgnd$<7r0H4tb zq&f3ffO!dWaWL<#mNIMr0Iw=hU*8N#q`AAHeF1JJQ_h)7m+8uz>rp~Z zfX($>t{pyGEOZ@^7ADSh*b8^2uKWtuVAok8g8|kSTcPI_TuV=_&Cc{c53%>X!CEz= zFseD~J+rageut5);XP9W2juLZy!>1vhXe39oz=+A1xWL!a^F}Gj|)E9#nS&Q>BS4N zhZqb9a5HUb_S@1PUEEhZr^JBHIwRlZ8~dsjAWl58cV+d7U8DdYXkf1KIx8R&R=rxr zTEeT({#rNz*mwn}t{?1*Q#T1-ZVMR04hcSD(Y2hQ%18imJoPjm#>KN}^sPyI3D1Xv z0DX4^*C#%HoR>BYALLkzl)gRhcR!%{#=Kf*8QN4y4J)qj5hO;9gE%HP+?@}+Jsx<9 z97C6n5Vd$^Y-Ihwt+SY{R{FgjZ!J1@^o*^Aa-*$at=PATEy0XFW1@9P{eG1X6A#fH zfE^gQqiXVdG5V4ENR2Z>C;e=zAYnU7I2wDy*^_-D7l953TLfZIYi`#+JU@(0yE-MT zdWxviaI0m!4fFN}L9Y1bMiGpCuZ+%p%bOCZY*10m6+JXYr189<=11q|aD{*-5qxPz zg#W=FYn!dzg3a8>v|#Rw4yJHW<%bNa4;9QWxJH$VL_S3L%t(dcv!KbSdTn)x#Lr@Njs@}crSRQ{db=6 zo7nkA)=Hr0hEG)`P}bp^oWsrMQj!@hoR0h;fFv7>Y@D9S4qqS-m*!gH+Pk~ya%}Fw zY&ZamyP0jo@q?{?$hke7m!G8y?$q6ytJL)^0*L6X$D{MdJ_C9tYQnz>4ZVXlJ_hdn z@XRmQ|E7z&Ey#yWu|5zvsW(yQPrKK)#;6HsS?j0|xy_YjfDpNsd-Q`5uPld9L!>nF z+%RCdAz+TnhcD=JwBMM6{`ZxSr+th+fwX{jGW1H1rOc*UNlMeJmD zjkj~U!(yfSgydjJ0Ozo16Z-uYq*Su3^p@|7y!wscbqaiChA6)&Zz^&#{nXBTgB$AR z9i|B`zDI}R3|C@(^iNw_w)$sZ$actndHE@89eqe`Px1Fg_`&+>r-DoeBllH!bo57uOYNBB)P_i)!wk80RGOr{QUd22t2cFP7I-ywb3=g z!kKy=EaSZ+@h*>UeeEs!Vvzw3&Btbr>gtW&Sz39K>$JCrVtlFf$Md+gaBE) zNnr?IJL~sjhvYe5)a@~2R}E2g;vD2#3YK*jPX=Vy`F8Cr40+?exDYgXZ~qhaR6#ar zY2~n(PX}ZpWiYYo2T~&U3r8b?B`09lFXMn9KlbPH@(S6djpi6PPT5K|T z9!CuuUbtq}Vkn}2_6(_yt6a}8Ek&M(&v3lk$b|zTs;GCWE6YX3_R5T&WcRL5z6*z6 zUp;Eb2?@$|;%yh9J=21!?!KDkG?l=X6nYCSYOUBGRQ_zzUt+pxtyn-^D0|#^n5FO? zM2lteJ!)QKMfeH#Xt3HCX$8M=bR;%Vri&|r%`ZePSYP~f3()w$P2s~_Z@4&jX1}ZM z)Au=bP*?)#n$GDjb|cEB@lK;m<6@(B<9MUenEn_b3fUt!bi?1M`=C;8ki|(`!`B9g z<5kGd(lv7VaV9OD9|Wn~Hb^B|t2poLvDd-ZQsZ>aD9hg#p`26>KYizz&GDg=#5B9i z1+$}PRC4<*9M5a1TtTGT8jrRMwLEhMikdf<$Oc*5$u`d|wVH@-3%DhaXPf7h z=k_Wp&-_(Z-kYV({yG$zvFDarK?4C z=91psbaHN|dFlg)Ooz0mj+^NhQaKD7PKFlLy-LV9Q{Zu8ys9Zk)}B^IC?gbp6z;g2 z=&X`@{#x0CvXJr>TN&GPWv1t~GqH3UBB?V2e2H(AbTM&Rc;kw$pScn*yr31;fHj>97z6sl>=eqF=vpn4T;+RK>~HD74s3IaEH`> z5vAV?LFG;ndii@#6Z#1|3C{_B?K6p}4(*QK4y&X`iOc5_tdX|ur8$o(@kS*JW$k5l zu0!P2&bHTwThFJRz3~d=s_h!%dCjwCQA#rLYHf!_l5LVg1@heKH*RkhEAD#b+)c8- zZ(sh_z^`xQt%FPL$WzyY=*)o=-7T-L4Mq%?0P1nu+YzdrmJ1W?<&_kuA z*45Tv*1N1S!JIorOKOH54mF1s-|M9~{iL{uPcp)kVI5oYu(={UKcYF@DqJVB_(~kI44Hlnd%((IB&sx8*g(Y~)Wvim z?^89jABw_Wlr-Ec1~0rYJU-Z6@(}Z8{F4W2%&V#9sz9{k?m*2t*<*=ai8(3i&=RG2 zdvmj%w#=FNjHZ|S0*?*>Z4!o)^-dZY58Z}Aq@KGW+i4ratZ-ww=-4BUd0>klOsQU_yJ6bI$6!AN$jgTOo2&Pp1@m zQwb}C2W_7^7G6GR`Le4t{A_)^4cbQX;RxQ)neuX9yHVTFjZ>W_9oh$bgz;Bie~bQp zf6_DR>+`I!ncNZ7fbrM(uu~Ni2Uc%b7FPOf{iW3B?N||hqm(vb zIw3ld8b5bCdEIy69_AD`q^ z)!USfN~6lDrjK16SIaHSMbAZ^<9?(yl2}>3DfZIwbA^PP!srsd+Qn}AXcxzE#6 zlh0cz-*7r>v8Gyf=JT*rS@q+(H1zj+sV1l9Ew#rlr~G;L#5+n%ElJ1iLgiXy=QX@xuHmT|{(TAvRd+l8 zC$q?=s7nPXTT1HQz;7qtR93{G-e-3v^J@f@-hFlPOZ4oW2IrcW`w)}9g;P(~SDSdq zV*Fb(OY3#~%P~z?_K78F)*#MRHPNMNJ_JrRPTYHuUF2SvT)W4!eA>3YTyj9pVfJZV z?fe3vvm^cyHzlA-dzSyb>5%=^YSCrh*;iZW_2v}v^2~wd&>2S`!R2>L`XddKvETLw z%pCGH_OqLB{9yDJHJN?MPyd2us) z2Gy7qd^|=TY^#`?X90M6NLXgcciw_Y*VCTe2TD{uK3^|5SuEd~JUX$7<-t8DeAm3> zIEe5ca5HgAVICxQx}UJ20RX#Ywl5YV^Mi8$0LMw9g*DyU#2A64kd)9k3I?y_Lvm+o z0{~h&KJI9&E1nL-;GKzNZP09WEeJ@&X){yO1Y+W@k9Q%SxIo3DE|^+iFSuega3Gzd zKrJ5x6M%%Lqk%poH!=<3qYe6ji(rnor@#RJuppo&-s z1OimkP{QNTFbtf4#vTE}ATTHx%KWM+Le&s3I0C8x{Ph7b4N`FgggNr~FLTT%ZIBC{ z?v4P1y}iAayx~d|sxug>p`ihWz`!t=B2z<==1ZodeH6*G1AieP@iZ)z=uRh6$iQtx zG=}0y*9I}k{_q0tL;N=`nf5DG%%Fj{C19u$WZSQw4wKw}Gx(dP58C~2ia6|VJ$Fy4 z+Yg>NEEw;GC*jF-8dDeg8`Rx}LZ{GNDE|ZWZ}Hy@FgL=)58pV@}#T$4rX&wLpwCZ?X5Nlg{9(|Yngs-2hts(PsO9@cqH@E1~D@LrU=ncgh4G}5Cl{ep`xq+ zQ9-~VKUGaAI3mIKA63;6aQNR;nHh*f)6xH{G7gI%P^cs{lNphOcE*F<$<83)?>Hm$ zDQ*-h(=d}A{LgtK<}sa0ArRe|f?vn=A0$mo5JqGg9ZkmKjgZ7jt8W44e%3te|6s+fVthU$xEGZlX%f$FMDP=qw zhuw~qIu;F6Wa1DM)!|HVh`I&@r$JCtS0-TpLOV?*GOHTx_9yB#D;yIMtp>+ql+o&n zXl1B|qB0H#SH!5P5ft$lI7A($j#gF25Vi~FM}i?v5NUJ@)%RB^qVOKSMs7slkDNlF zvD;;(4WgmF@Ho(~N#Z|5{Qps_^qc6}ZCiyhVlO?JjJdmR`A{y)3(-)-(sp8v1zfVVr`&y52A=N|r$ z{m~7X-v5|lw%G0A@Al4o`27cgCo>~OWww7gD*rG5z z8g#XsSjOUcbvs6bRu~!0v0E9T@nDB%L!1IqTa1-%EN+T&gu&QcPcJ03tggQVM-(~M zLXn0MQ1Q>x@IGZ#crgSH-EelotuQ9{hZZMrHN36%mXJOD1s{3!GV9P*cv@-ImZ#T6 z>A@Ul=1bXWqZb<#-1$XD+pB!1l2h?T0Q*I@_M@I_Ujoq{5(yne66QT{N3h)!@rG9G zx={w>dFI6X#5+e6kBEEC4D;}ZyADubCt4NY@_8*#@}HN2lc z=ec{xN-EGIGUQByH1gUm^G**G;<{e-qbsRj4>xRWa!Tye4rrg7>NSk`6bXswNUDG( z?2$ZBzZX{%7Cpw8RwD4 zNayX_RvWeCO7EYx!f`4_xYh>QRL diff --git a/documentation/docs/reference/ui/ui_components.md b/documentation/docs/reference/ui/ui_components.md index 8a923295c1..a8f76d7f48 100644 --- a/documentation/docs/reference/ui/ui_components.md +++ b/documentation/docs/reference/ui/ui_components.md @@ -16,13 +16,13 @@ The main menu is part of the Grafana framework and is visible on every page. | | Dashboards | Create dashboards or [folders][Folders], manage dashboards, import dashboards, create playlists, manage snapshots. | | Explore | Run queries with [PromQL]. | | Operating System (OS) | Operating System dashboard -| ![!image](../../images/mysql-dashboard.png) ![!image](../../images/haproxy-dashboard.png) ![!image](../../images/postresql-dashboard.png) | Service Type dashboards | Navigate to the dashboards available for the [services added for monitoring](../../install-pmm/install-pmm-client/connect-database/index.md) (MySQL, MongoDB, PostgreSQL, HAproxy or ProxySQL). +| :simple-mysql: :simple-mongodb: :simple-postgresql: | Service Type dashboards | Navigate to the dashboards available for the [services added for monitoring](../../install-pmm/install-pmm-client/connect-database/index.md) (MySQL, MongoDB, PostgreSQL, HAproxy or ProxySQL). | | Query Analytics (QAN) | Navigate to the Query Analytics dashboard where you can analyze database queries over time, optimize database performance, and identify the source of problems. | | Alerting | [Alerting](../../alert/index.md), Create new alerts and manage your alert rules and alert templates. -| | Advisors | Run health assessment checks against your connected databases and check any failed checks. -| | Backup | [Backup management and storage location configuration][BACKUP]. The Backup icon appears when **Backup Management** is activated in :material-cog: **PMM Configuration > Settings > Advanced Settings**. -| :material-cog: | Connections | Access Grafana's built-in data sources within PMM to seamlessly integrate and visualize data from various systems like Prometheus, MySQL, PostgreSQL, InfluxDB, and Elasticsearch. -| :material-cog: | PMM Configuration|| Hosts all PMM-related configuration and inventory options. | +| | Advisors | Run health assessment checks against your connected databases and check any failed checks. +| | Backup | [Backup management and storage location configuration][BACKUP]. The Backup icon appears when **Backup Management** is activated in :material-cog: **PMM Configuration** > :material-cog-outline: **Settings** > **Advanced Settings**. +| :material-cog: | Connections | Access Grafana's built-in data sources within PMM to seamlessly integrate and visualize data from various systems like Prometheus, MySQL, PostgreSQL, InfluxDB, and Elasticsearch. +| :material-cog: | PMM Configuration|| Hosts all PMM-related configuration and inventory options. | | | Administration |Hosts all Grafana-related configuration and inventory options. | | Entitlements |This tab is displayed after connecting PMM to Percona Portal, and shows all your Percona Platform account information. | | List of tickets opened by Customer Support | Shows the list of tickets opened across your organization. This tab is only available after you connect PMM to Percona Platform. From 03c9ed3c7eecc6fa495824cf2d65dbf1ee8f7bea Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Sat, 8 Feb 2025 02:07:59 +0300 Subject: [PATCH 11/17] PMM ui component fixes --- documentation/docs/reference/ui/ui_components.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/documentation/docs/reference/ui/ui_components.md b/documentation/docs/reference/ui/ui_components.md index a8f76d7f48..c2b8bc018c 100644 --- a/documentation/docs/reference/ui/ui_components.md +++ b/documentation/docs/reference/ui/ui_components.md @@ -17,7 +17,7 @@ The main menu is part of the Grafana framework and is visible on every page. | | Explore | Run queries with [PromQL]. | | Operating System (OS) | Operating System dashboard | :simple-mysql: :simple-mongodb: :simple-postgresql: | Service Type dashboards | Navigate to the dashboards available for the [services added for monitoring](../../install-pmm/install-pmm-client/connect-database/index.md) (MySQL, MongoDB, PostgreSQL, HAproxy or ProxySQL). -| | Query Analytics (QAN) | Navigate to the Query Analytics dashboard where you can analyze database queries over time, optimize database performance, and identify the source of problems. +| | Query Analytics (QAN) | Navigate to the Query Analytics dashboard where you can analyze database queries over time, optimize database performance, and identify the source of problems. | | Alerting | [Alerting](../../alert/index.md), Create new alerts and manage your alert rules and alert templates. | | Advisors | Run health assessment checks against your connected databases and check any failed checks. | | Backup | [Backup management and storage location configuration][BACKUP]. The Backup icon appears when **Backup Management** is activated in :material-cog: **PMM Configuration** > :material-cog-outline: **Settings** > **Advanced Settings**. @@ -25,7 +25,7 @@ The main menu is part of the Grafana framework and is visible on every page. | :material-cog: | PMM Configuration|| Hosts all PMM-related configuration and inventory options. | | | Administration |Hosts all Grafana-related configuration and inventory options. | | Entitlements |This tab is displayed after connecting PMM to Percona Portal, and shows all your Percona Platform account information. -| | List of tickets opened by Customer Support | Shows the list of tickets opened across your organization. This tab is only available after you connect PMM to Percona Platform. +| | List of tickets opened by Customer Support | Shows the list of tickets opened across your organization. This tab is only available after you connect PMM to Percona Portal. | | Environment Overview | This tab is displayed after connecting PMM to Percona Portal. Shows the name and email of the Customer Success Manager assigned to your organization, who can help with any PMM queries. This tab will soon be populated with more useful information about your PMM environment. From 7cae1076213adb774ad3db236b217a8b2d8fbf3b Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Sat, 8 Feb 2025 02:12:04 +0300 Subject: [PATCH 12/17] Remove CentOS 7 --- .../docs/install-pmm/install-pmm-client/package_manager.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/documentation/docs/install-pmm/install-pmm-client/package_manager.md b/documentation/docs/install-pmm/install-pmm-client/package_manager.md index ac50456fb2..014eafc12b 100644 --- a/documentation/docs/install-pmm/install-pmm-client/package_manager.md +++ b/documentation/docs/install-pmm/install-pmm-client/package_manager.md @@ -79,8 +79,7 @@ To manually download package manager: - [Debian 9 (Stretch)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/stretch/) - [Debian 10 (Buster)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/buster/) - [Debian 11 (Bullseye)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/bullseye/) - - [Red Hat/CentOS](https://www.percona.com/downloads/pmm3/{{release}}/binary/redhat/7/) - [Red Hat/CentOS/Oracle 8](https://www.percona.com/downloads/pmm3/{{release}}/binary/redhat/8/) - [Ubuntu 18.04 (Bionic Beaver)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/bionic/) - [Ubuntu 20.04 (Focal Fossa)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/focal/) - - [Ubuntu 22.04 (Jammy Jellyfish)](https://www.percona.com/downloads//{{release}}/binary/debian/jammy/) \ No newline at end of file + - [Ubuntu 22.04 (Jammy Jellyfish)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/jammy/) \ No newline at end of file From 9eae70c878b53a5da6c2f3673312d9c131e3da39 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Sat, 8 Feb 2025 02:17:06 +0300 Subject: [PATCH 13/17] Fix package managers (new and EOL) --- .../install-pmm/install-pmm-client/package_manager.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/documentation/docs/install-pmm/install-pmm-client/package_manager.md b/documentation/docs/install-pmm/install-pmm-client/package_manager.md index 014eafc12b..672107242a 100644 --- a/documentation/docs/install-pmm/install-pmm-client/package_manager.md +++ b/documentation/docs/install-pmm/install-pmm-client/package_manager.md @@ -76,10 +76,10 @@ To manually download package manager: ??? info "Download page links" Here are the download page links for each supported platform: - - [Debian 9 (Stretch)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/stretch/) - - [Debian 10 (Buster)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/buster/) - - [Debian 11 (Bullseye)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/bullseye/) - [Red Hat/CentOS/Oracle 8](https://www.percona.com/downloads/pmm3/{{release}}/binary/redhat/8/) - - [Ubuntu 18.04 (Bionic Beaver)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/bionic/) + - [Red Hat/CentOS/Oracle 9](https://www.percona.com/downloads/pmm3/{{release}}/binary/redhat/9/) + - [Debian 11 (Bullseye)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/bullseye/) + - [Debian 12 (Bookworm)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/bookworm/) - [Ubuntu 20.04 (Focal Fossa)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/focal/) - - [Ubuntu 22.04 (Jammy Jellyfish)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/jammy/) \ No newline at end of file + - [Ubuntu 22.04 (Jammy Jellyfish)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/jammy/) + - [Ubuntu 24.04 (Noble Numbat)](https://www.percona.com/downloads/pmm3/{{release}}/binary/debian/noble/) From 5f179fea3ac303551eeaca10b69d9af6655c2c0b Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Mon, 10 Feb 2025 13:26:06 +0300 Subject: [PATCH 14/17] Put material icons together --- documentation/WRITERS-NOTES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/WRITERS-NOTES.md b/documentation/WRITERS-NOTES.md index 80317fcec6..7e1f338b03 100644 --- a/documentation/WRITERS-NOTES.md +++ b/documentation/WRITERS-NOTES.md @@ -154,6 +154,7 @@ Note: the following list is WIP and will be updated as we go along. | | Right caret | General | | | Clock (at nine) | PMM UI - Time range selector | | :material-cog: | Cog wheel | PMM UI Configuration | +| :material-cog-outline: | Cog wheel | PMM UI Configuration->Settings | | :material-clipboard-list-outline: | Clipboard list | PMM UI - Inventory | | :material-dots-horizontal: | Triple dots, aligned horizontally | PMM UI - Backup in progress | | :material-magnify-expand: | Advisors | PMM UI - Advisors | @@ -178,7 +179,6 @@ Note: the following list is WIP and will be updated as we go along. | | Question mark in circle | PMM UI - Help | | | Minus in magnifying glass | PMM UI - Time range zoom out | | | Magnifying glass | PMM UI - Search | -| :material-cog-outline: | Cog wheel | PMM UI Configuration->Settings | | | Share symbol | PMM UI - Share dashboard | | | Shield | PMM UI - Server admin | | | Star | PMM UI - Dashboard favourites | From aaa0d3b557b51cbe0e46635db61d8c9e1b4107bf Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Mon, 10 Feb 2025 17:08:59 +0300 Subject: [PATCH 15/17] Fix grammar --- documentation/WRITERS-NOTES.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/WRITERS-NOTES.md b/documentation/WRITERS-NOTES.md index 7e1f338b03..6e8ddd5706 100644 --- a/documentation/WRITERS-NOTES.md +++ b/documentation/WRITERS-NOTES.md @@ -133,7 +133,7 @@ Currently, we use three different sets of icons: The preference should be given to Mkdocs Material icons, since they were initially designed for `mkdocs` project and work very well with it. In rare cases, when an icon cannot be found in Mkdocs Material, you can find a suitable one on Iconscout. FontAwesome icons do not play well with Mkdocs, so use them with caution and don't forget to apply additional CSS styles in case they don't render well in PDF. -Ideally, we should migrate to using just the first set, which offers 10,000+ icons, and is more than sufficient for all our documentation needs. +Ideally, we should migrate to using just the first set, which offers 10,000+ icons, that are more than sufficient for all our documentation needs. Use HTML for icons: From 7bf01ac8e39f483978b2151a19f24dd1bde1a13a Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Mon, 10 Feb 2025 17:58:37 +0300 Subject: [PATCH 16/17] Fix broken links --- .../docs/advisors/{advisors-details.md => advisor-details.md} | 0 .../{develop_advisor_checks.md => develop-advisor-checks.md} | 0 2 files changed, 0 insertions(+), 0 deletions(-) rename documentation/docs/advisors/{advisors-details.md => advisor-details.md} (100%) rename documentation/docs/advisors/{develop_advisor_checks.md => develop-advisor-checks.md} (100%) diff --git a/documentation/docs/advisors/advisors-details.md b/documentation/docs/advisors/advisor-details.md similarity index 100% rename from documentation/docs/advisors/advisors-details.md rename to documentation/docs/advisors/advisor-details.md diff --git a/documentation/docs/advisors/develop_advisor_checks.md b/documentation/docs/advisors/develop-advisor-checks.md similarity index 100% rename from documentation/docs/advisors/develop_advisor_checks.md rename to documentation/docs/advisors/develop-advisor-checks.md From e78a2ea684415aedb3d476c01328c006a7c58027 Mon Sep 17 00:00:00 2001 From: Alex Demidoff Date: Mon, 10 Feb 2025 18:02:18 +0300 Subject: [PATCH 17/17] Fix one more broken link --- documentation/mkdocs-base.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/mkdocs-base.yml b/documentation/mkdocs-base.yml index df8390a300..8d8637cce3 100644 --- a/documentation/mkdocs-base.yml +++ b/documentation/mkdocs-base.yml @@ -361,7 +361,7 @@ nav: - reference/dashboards/dashboard-victoriametrics-agents-overview.md - Environments: - reference/dashboards/dashboard-env-overview.md - - reference/dashboards/dashboard-environent-summary.md + - reference/dashboards/dashboard-environment-summary.md - Kubernetes: - reference/dashboards/kubernetes_cluster_summary.md - reference/dashboards/kubernetes_monitor_operators.md