-
Notifications
You must be signed in to change notification settings - Fork 182
Add external link icons and target="_blank" to all external links in documentation #4665
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: v3-doc-prod
Are you sure you want to change the base?
Conversation
|
|
…cumentation Co-authored-by: catalinaadam <[email protected]>
| ### 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. |
There was a problem hiding this comment.
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: |
There was a problem hiding this comment.
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"} |
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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
pmm/documentation/docs/index.md
Line 3 in 5f7c99a
| <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). |
This PR updates all external links in the PMM documentation to improve user experience by:
:octicons-link-external-16:icon{:target="_blank"}attributeProblem
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:
Changes Made
Examples
Before:
After:
Visual Result
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
mkdocs build --strictOriginal prompt
💬 Share your feedback on Copilot coding agent for the chance to win a $200 gift card! Click here to start the survey.