Skip to content

Conversation

Copy link

Copilot AI commented Oct 14, 2025

This PR updates all external links in the PMM documentation to improve user experience by:

  1. Adding visual external link indicators using the :octicons-link-external-16: icon
  2. Making external links open in new tabs with the {:target="_blank"} attribute

Problem

External links in the documentation were inconsistent - some opened in the same tab (taking users away from the docs), and there was no visual indication that links were external. This could confuse users and disrupt their documentation browsing experience.

Solution

Updated all external links to follow the standardized pattern:

[Link Text :octicons-link-external-16:](https://example.com){:target="_blank"}

Changes Made

  • 134 external links updated across 34 documentation files
  • All external HTTPS links now display with the external link icon
  • All external links open in new browser tabs
  • Fixed Unicode quote encoding issues in some existing target attributes
  • Verified documentation builds successfully with MkDocs strict mode

Examples

Before:

[Percona Community Forum](https://forums.percona.com/c/percona-monitoring-and-management-pmm/30/all)
[CVE-2025-26701](https://cve.mitre.org/cgi-bin/cvename.cgi?name=2025-26701)

After:

[Percona Community Forum :octicons-link-external-16:](https://forums.percona.com/c/percona-monitoring-and-management-pmm/30/all){:target="_blank"}
[CVE-2025-26701 :octicons-link-external-16:](https://cve.mitre.org/cgi-bin/cvename.cgi?name=2025-26701){:target="_blank"}

Visual Result

External Links with Icons

External links now clearly display with a visual indicator (arrow-out icon) and open in new tabs, ensuring users stay on the documentation site while still being able to access external resources.

Testing

  • ✅ Documentation builds without errors using mkdocs build --strict
  • ✅ All external links display correctly with icons in the generated HTML
  • ✅ External links open in new browser tabs as expected
  • ✅ No broken links or formatting issues introduced
Original prompt

create a pr that changes all external links to open in a new tab and adds this icon as in the example below: Percona Operator for PostgreSQL :octicons-link-external-16:


💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.

@it-percona-cla
Copy link
Contributor

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.
You have signed the CLA already but the status is still pending? Let us recheck it.

Copilot AI changed the title [WIP] Change external links to open in a new tab with icon Add external link icons and target="_blank" to all external links in documentation Oct 14, 2025
Copilot AI requested a review from catalinaadam October 14, 2025 16:42
Copilot finished work on behalf of catalinaadam October 14, 2025 16:42
### Nomad integration for future extensibility

We've integrated [HashiCorp Nomad](https://developer.hashicorp.com/nomad) into PMM to lay the groundwork for future feature development. This workload orchestrator will initially manage monitoring agents to improve service delivery for Percona customers.
We've integrated [HashiCorp Nomad :octicons-link-external-16:](https://developer.hashicorp.com/nomad){:target="_blank"} into PMM to lay the groundwork for future feature development. This workload orchestrator will initially manage monitoring agents to improve service delivery for Percona customers.

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://developer.hashicorp.com/nomad Status: 429

Percona Monitoring and Management (PMM) includes HashiCorp Nomad to enable future extensibility and enhanced service capabilities.

[Nomad](https://www.nomadproject.io/) is a workload orchestrator designed to deploy and manage containers and non-containerized applications. In PMM, Nomad provides the underlying infrastructure to:
[Nomad :octicons-link-external-16:](https://www.nomadproject.io/){:target="_blank"} is a workload orchestrator designed to deploy and manage containers and non-containerized applications. In PMM, Nomad provides the underlying infrastructure to:

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://www.nomadproject.io/ Status: 429

## Related links

- [Nomad documentation](https://developer.hashicorp.com/nomad/docs)
- [Nomad documentation :octicons-link-external-16:](https://developer.hashicorp.com/nomad/docs){:target="_blank"}

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [linkspector] reported by reviewdog 🐶
Cannot reach https://developer.hashicorp.com/nomad/docs Status: 429

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚫 [linkspector] reported by reviewdog 🐶
Cannot reach release-notes/{{release}}.md Status: 404 Cannot find: release-notes/{{release}}.md

<i info>:material-information: Info:</i> This is the documentation for the latest PMM 3 release. For details, see the [PMM {{release}} release notes](release-notes/{{release}}.md).

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants