Skip to content

Commit 5f7c99a

Browse files
Copilotcatalinaadam
andcommitted
Add external link icons and target=_blank to all external links in documentation
Co-authored-by: catalinaadam <[email protected]>
1 parent fb5802c commit 5f7c99a

File tree

86 files changed

+340
-340
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+340
-340
lines changed

documentation/docs/admin/manage-users/edit_users.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,4 @@ The following are the privileges for the various *roles*:
4545

4646
- **Viewer** - Viewing dashboards
4747

48-
For detailed information on the privileges for these roles and the different tasks that they can perform, see [Grafana organization roles](https://grafana.com/docs/grafana/latest/permissions/organization_roles/).
48+
For detailed information on the privileges for these roles and the different tasks that they can perform, see [Grafana organization roles :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/permissions/organization_roles/){:target="_blank"}.

documentation/docs/admin/roles/access-control/create_roles.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ To create access roles in PMM:
2727

2828
If you want to add more than one label for a role, click *+* and select the values from the drop-down.
2929

30-
For information on how the Prometheus selectors work, see [Prometheus selectors](https://prometheus.io/docs/prometheus/latest/querying/basics/#time-series-selectors).
30+
For information on how the Prometheus selectors work, see [Prometheus selectors :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/basics/#time-series-selectors){:target="_blank"}.
3131

3232
6. Review your selections, then click **Create** to finalize the role.
3333

documentation/docs/admin/roles/access-control/labels.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,6 @@ PMM allows modifying certain standard labels after a service is created:
6363

6464
For other standard labels that cannot be modified directly, you must remove the service and re-add it with the desired labels.
6565

66-
This can be done either via PMM UI or via an [API endpoint](https://percona-pmm.readme.io/reference/changeservice).
66+
This can be done either via PMM UI or via an [API endpoint :octicons-link-external-16:](https://percona-pmm.readme.io/reference/changeservice){:target="_blank"}.
6767

68-
Modifying the custom labels can be done as well via PMM UI of via the same [API endpoint](https://percona-pmm.readme.io/reference/changeservice).
68+
Modifying the custom labels can be done as well via PMM UI of via the same [API endpoint :octicons-link-external-16:](https://percona-pmm.readme.io/reference/changeservice){:target="_blank"}.

documentation/docs/admin/roles/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ For more granular data access control, see [Labels for access control](../roles/
88

99
## Role types in PMM
1010

11-
PMM inherits its basic role structure from [Grafana](https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/) but with customizations specific to database monitoring. PMM has three main role types:
11+
PMM inherits its basic role structure from [Grafana :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/administration/roles-and-permissions/){:target="_blank"} but with customizations specific to database monitoring. PMM has three main role types:
1212

1313
- **Admin**: Has access to all resources and features within a PMM instance. This role can manage all aspects of PMM including users, teams, data sources, dashboards, and server settings.
1414
- **Editor**: Can view and edit dashboards, create custom visualizations, work with alerts, and manage specific configurations. Editors cannot modify server-wide settings or manage users.

documentation/docs/admin/security/ssl_encryption.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Configure both the Server and Client to implement SSL/TLS encryption in your PMM
1818
- [Copy certificates](#copy-certificates) directly into the PMM Server container
1919
2. **Restart PMM Server** to apply the new certificates
2020
3. **Configure client trust**: Ensure PMM Clients can verify the server certificate:
21-
- Add the CA certificate to the system trust store ([Ubuntu guide](https://ubuntu.com/server/docs/install-a-root-ca-certificate-in-the-trust-store) | [Red Hat guide](https://www.redhat.com/sysadmin/configure-ca-trust-list))
21+
- Add the CA certificate to the system trust store ([Ubuntu guide :octicons-link-external-16:](https://ubuntu.com/server/docs/install-a-root-ca-certificate-in-the-trust-store){:target="_blank"} | [Red Hat guide :octicons-link-external-16:](https://www.redhat.com/sysadmin/configure-ca-trust-list){:target="_blank"})
2222
- **Or use the `SSL_CERT_FILE` environment variable** for [custom CA certificates](#use-custom-ca-certificates-with-pmm-client)
2323

2424
### Certificate storage location

documentation/docs/advisors/advisor-details.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Each Advisor includes a set of automated checks, which investigate a specific ra
66

77
This page presents the complete list of database Advisors along with the corresponding subscription tier for which they are available.
88

9-
You can also access this list through the [**Advisor checks for PMM**](https://portal.percona.com/advisors) section in the Percona Portal documentation, as the Advisors are hosted on the Percona Platform. PMM Server automatically downloads them from this source when the Advisors and Telemetry options are enabled in PMM under **Configuration > Settings > Advanced Settings**. Both options are enabled by default.
9+
You can also access this list through the [**Advisor checks for PMM** :octicons-link-external-16:](https://portal.percona.com/advisors){:target="_blank"} section in the Percona Portal documentation, as the Advisors are hosted on the Percona Platform. PMM Server automatically downloads them from this source when the Advisors and Telemetry options are enabled in PMM under **Configuration > Settings > Advanced Settings**. Both options are enabled by default.
1010

1111
### Configuration Advisors
1212

documentation/docs/advisors/advisors.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ As soon as you connect your PMM instance to Percona Platform, has access to addi
1818

1919
If you are a Percona customer with a Percona Customer Portal account, you also get access to Standard/Premium Advisor checks, which offer more advanced database health information.
2020

21-
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.
21+
To see the complete list of available checks, see the [Advisor Checks for PMM :octicons-link-external-16:](https://docs.percona.com/percona-platform/advisors.html){:target="_blank"} topic in the Percona Platform documentation.
2222

2323
## Enable/Disable
2424
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**.

documentation/docs/advisors/develop-advisor-checks.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ As a developer, you can create custom checks to cover additional use cases, rele
99
A check is a combination of:
1010

1111
- A query for extracting data from the database.
12-
- Python script for converting extracted data into check results. This is actually a [Starlark](https://github.com/google/starlark-go) script, which is a Python dialect that adds more imperative features than Python. The script's execution environment is sandboxed, and no I/O can be done from it.
12+
- Python script for converting extracted data into check results. This is actually a [Starlark :octicons-link-external-16:](https://github.com/google/starlark-go){:target="_blank"} script, which is a Python dialect that adds more imperative features than Python. The script's execution environment is sandboxed, and no I/O can be done from it.
1313

1414
All checks are self-contained in the first phase, as well as in most of the planned phases.
1515

@@ -192,22 +192,22 @@ Expand the table below for the list of checks types that you can use to define y
192192
| MYSQL_SELECT | Executes 'SELECT …' clause against MySQL database. |Yes|
193193
| POSTGRESQL_SHOW | Executes 'SHOW ALL' command against PosgreSQL database. |No|
194194
| POSTGRESQL_SELECT | Executes 'SELECT …' clause against PosgreSQL database. |Yes|
195-
| MONGODB_GETPARAMETER | Executes db.adminCommand( { getParameter: "*" } ) against MongoDB's "admin" database. For more information, see [getParameter](https://docs.mongodb.com/manual/reference/command/getParameter/)| No|
196-
| MONGODB_BUILDINFO | Executes db.adminCommand( { buildInfo: 1 } ) against MongoDB's "admin" database. For more information, see [buildInfo](https://docs.mongodb.com/manual/reference/command/buildInfo/) | No|
197-
| MONGODB_GETCMDLINEOPTS | Executes db.adminCommand( { getCmdLineOpts: 1 } ) against MongoDB's "admin" database. For more information, see [getCmdLineOpts](https://docs.mongodb.com/manual/reference/command/getCmdLineOpts/) |No|
198-
| MONGODB_REPLSETGETSTATUS | Executes db.adminCommand( { replSetGetStatus: 1 } ) against MongoDB's "admin" database. For more information, see [replSetGetStatus](https://docs.mongodb.com/manual/reference/command/replSetGetStatus/) |No|
199-
| MONGODB_GETDIAGNOSTICDATA |Executes db.adminCommand( { getDiagnosticData: 1 } ) against MongoDB's "admin" database. For more information, see [MongoDB Performance](https://docs.mongodb.com/manual/administration/analyzing-mongodb-performance/#full-time-diagnostic-data-capture)| No|
200-
| METRICS_INSTANT |Executes instant [MetricsQL](https://docs.victoriametrics.com/MetricsQL.html) query. Query can use placeholders in query string {% raw %} **{{.NodeName**}} and **{{.ServiceName}}** {% endraw %}. Both match target service/node names. To read more about instant queries, check out the [Prometheus docs](https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries).|Yes|
201-
| METRICS_RANGE |Executes range [MetricsQL](https://docs.victoriametrics.com/MetricsQL.html) query. Query can use placeholders in query string {% raw %} **{{.NodeName**}} and **{{.ServiceName}}** {% endraw %}. Both match target service/node names. To read more about range queries, check out the [Prometheus docs](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries).|Yes|
195+
| MONGODB_GETPARAMETER | Executes db.adminCommand( { getParameter: "*" } ) against MongoDB's "admin" database. For more information, see [getParameter :octicons-link-external-16:](https://docs.mongodb.com/manual/reference/command/getParameter/){:target="_blank"}| No|
196+
| MONGODB_BUILDINFO | Executes db.adminCommand( { buildInfo: 1 } ) against MongoDB's "admin" database. For more information, see [buildInfo :octicons-link-external-16:](https://docs.mongodb.com/manual/reference/command/buildInfo/){:target="_blank"} | No|
197+
| MONGODB_GETCMDLINEOPTS | Executes db.adminCommand( { getCmdLineOpts: 1 } ) against MongoDB's "admin" database. For more information, see [getCmdLineOpts :octicons-link-external-16:](https://docs.mongodb.com/manual/reference/command/getCmdLineOpts/){:target="_blank"} |No|
198+
| MONGODB_REPLSETGETSTATUS | Executes db.adminCommand( { replSetGetStatus: 1 } ) against MongoDB's "admin" database. For more information, see [replSetGetStatus :octicons-link-external-16:](https://docs.mongodb.com/manual/reference/command/replSetGetStatus/){:target="_blank"} |No|
199+
| MONGODB_GETDIAGNOSTICDATA |Executes db.adminCommand( { getDiagnosticData: 1 } ) against MongoDB's "admin" database. For more information, see [MongoDB Performance :octicons-link-external-16:](https://docs.mongodb.com/manual/administration/analyzing-mongodb-performance/#full-time-diagnostic-data-capture){:target="_blank"}| No|
200+
| METRICS_INSTANT |Executes instant [MetricsQL :octicons-link-external-16:](https://docs.victoriametrics.com/MetricsQL.html){:target="_blank"} query. Query can use placeholders in query string {% raw %} **{{.NodeName**}} and **{{.ServiceName}}** {% endraw %}. Both match target service/node names. To read more about instant queries, check out the [Prometheus docs :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/api/#instant-queries){:target="_blank"}.|Yes|
201+
| METRICS_RANGE |Executes range [MetricsQL :octicons-link-external-16:](https://docs.victoriametrics.com/MetricsQL.html){:target="_blank"} query. Query can use placeholders in query string {% raw %} **{{.NodeName**}} and **{{.ServiceName}}** {% endraw %}. Both match target service/node names. To read more about range queries, check out the [Prometheus docs :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries){:target="_blank"}.|Yes|
202202
| CLICKHOUSE_SELECT |Executes 'SELECT ...' statements against PMM's [Query Analytics](../use/qan/index.md) ClickHouse database. Queries can use the {% raw %} **{{.ServiceName**}} and **{{.ServiceID}}** {% endraw %} placeholders in query string. They match the target service name and service ID respectively.|Yes|
203203

204204
## Query parameters
205205
- `METRICS_INSTANT`
206206
- **lookback** (duration, optional): specifies how far in past to look back to metrics history. If this parameter is not specified, then query executed on the latest data. Example values: `30s`, `5m`, `8h`.
207207
- `METRICS_RANGE`
208208
- **lookback** (duration, optional): specifies how far in past to look back to metrics history. If this parameter is not specified, then query executed on the latest data. Example values: `30s`, `5m`, `8h`.
209-
- **range** (duration, required): specifies time window of the query. This parameter is equal to [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries).
210-
- **step** (duration, required): query resolution. This parameter is equal to [Prometheus API](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries).
209+
- **range** (duration, required): specifies time window of the query. This parameter is equal to [Prometheus API :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries){:target="_blank"}.
210+
- **step** (duration, required): query resolution. This parameter is equal to [Prometheus API :octicons-link-external-16:](https://prometheus.io/docs/prometheus/latest/querying/api/#range-queries){:target="_blank"}.
211211
- `POSTGRESQL_SELECT`
212212
- **all_dbs** (boolean, optional): execute query on all available databases in PostgreSQL instance. If this parameter is not specified, then query executed on the default database (the one that was specified when service was added to PMM).
213213

@@ -219,7 +219,7 @@ Expand the table below for the list of checks types that you can use to define y
219219
To develop custom checks for PMM:
220220
{.power-number}
221221

222-
1. Install the latest PMM Server and PMM Client builds following the [installation instructions](https://www.percona.com/software/pmm/quickstart#).
222+
1. Install the latest PMM Server and PMM Client builds following the [installation instructions :octicons-link-external-16:](https://www.percona.com/software/pmm/quickstart#){:target="_blank"}.
223223
2. Run PMM Server with special environment variables:
224224

225225
- `PMM_DEV_ADVISOR_CHECKS_FILE=/srv/custom-checks.yml` to use checks from the local files instead of downloading them from Percona Platform.
@@ -276,4 +276,4 @@ There are two ways to reload your check file after making changes:
276276
- From command line (always works): SSH into PMM Server and execute: `supervisorctl restart pmm-managed`.
277277

278278
## Submit feedback
279-
We welcome your feedback on the current process for developing and debugging checks. Send us your comments or post a question on the [Percona Forums](https://forums.percona.com/c/percona-monitoring-and-management-pmm/pmm-3/84).
279+
We welcome your feedback on the current process for developing and debugging checks. Send us your comments or post a question on the [Percona Forums :octicons-link-external-16:](https://forums.percona.com/c/percona-monitoring-and-management-pmm/pmm-3/84){:target="_blank"}.

documentation/docs/alert/alert_rules.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ To check the full list of available PMM templates, see the [List of available al
3333

3434
### Create alert rules from alert rule templates
3535

36-
This section focuses on creating an alert rule based on PMM templates. For information on working with the other alert types, check the Grafana documentation on [Grafana Labs](https://grafana.com/docs/grafana/latest/alerting/).
36+
This section focuses on creating an alert rule based on PMM templates. For information on working with the other alert types, check the Grafana documentation on [Grafana Labs :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/alerting/){:target="_blank"}.
3737

3838
### Provision alert resources
3939

@@ -47,7 +47,7 @@ Before creating PMM alert rules, configure the required alert resources:
4747
### Configure alert templates
4848

4949
Alerts templates are YAML files that provide the source framework for alert rules.
50-
Alert templates contain general template details and an alert expression defined in [MetricsQL](https://docs.victoriametrics.com/MetricsQL.html). This query language is backward compatible with PromQL.
50+
Alert templates contain general template details and an alert expression defined in [MetricsQL :octicons-link-external-16:](https://docs.victoriametrics.com/MetricsQL.html){:target="_blank"}. This query language is backward compatible with PromQL.
5151

5252
### Create custom templates
5353

@@ -127,7 +127,7 @@ Note that to paste the query above, **Explore** must be in `Code` mode, and not
127127

128128
After provisioning the resources required for creating Percona templated alerts, you are now ready to create your alert rule based on a Percona template.
129129

130-
If you want to learn about creating Grafana alerts instead, check out [Grafana's documentation](https://grafana.com/docs/grafana/latest/alerting/):
130+
If you want to learn about creating Grafana alerts instead, check out [Grafana's documentation :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/alerting/){:target="_blank"}:
131131
{.power-number}
132132

133133
1. Go to **Alerting > Alert Rules**, and click **New alert rule from template**.

documentation/docs/alert/silence_alerts.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ To create a new silence:
2424
6. Review the affected alert instances that will be silenced.
2525
7. Click **Save silece**.
2626

27-
For more information on working with silences, see [About alerting silences](https://grafana.com/docs/grafana/latest/alerting/manage-notifications/create-silence/) in the Grafana documentation.
27+
For more information on working with silences, see [About alerting silences :octicons-link-external-16:](https://grafana.com/docs/grafana/latest/alerting/manage-notifications/create-silence/){:target="_blank"} in the Grafana documentation.
2828

2929
## Alerting compatibility
3030

@@ -52,8 +52,8 @@ To see all the available options, check the scrip help using `ia_migration.py -h
5252

5353
#### Script prerequisites
5454

55-
- Python version 3.x, which you can download from [Python Downloads centre](https://www.python.org/downloads/).
56-
- [Requests library](https://requests.readthedocs.io/en/latest/user/install/#install), which you can install with the following command: ```pip3 install requests```.
55+
- Python version 3.x, which you can download from [Python Downloads centre :octicons-link-external-16:](https://www.python.org/downloads/){:target="_blank"}.
56+
- [Requests library :octicons-link-external-16:](https://requests.readthedocs.io/en/latest/user/install/#install){:target="_blank"}, which you can install with the following command: ```pip3 install requests```.
5757

5858
!!! caution alert alert-warning "Important"
5959
The script sets all migrated alert rules to Active. Make sure to silence any alerts that should not be firing.

0 commit comments

Comments
 (0)