docs(navigation): standardize link targets to enhance customer experience

[leandrodamascena]

Issue number: #2260

Summary

Changes

This PR aims to enhance the user experience by implementing a standardized navigation approach for our documentation.

Currently, there are variations in how links are handled, with some opening in the same tab and others opening in a new tab using target="_blank". By establishing a consistent navigation standard, we can ensure a seamless and intuitive user experience. This PR proposes the following guidelines:

1 - Anchors - we will not use {target="_blank"}
2 - Links to other sections of the Powertools documentation - we will use {target="_blank"}
3 - Links to external Amazon/AWS documentation or Github AWS repositories - we'll use {target="_blank"}
4 - Third-party links - we will use {target="_blank"}

@heitorlessa, thanks for suggesting the plugin https://github.com/JakubAndrysek/mkdocs-open-in-new-tab, but there is a known issue with navigation.instant feature and we use this.

User experience

Please share what the user experience looks like before and after this change

Checklist

If your change doesn't seem to apply, please leave them unchecked.

• Meet tenets criteria
• I have performed a self-review of this change
• Changes have been tested
• Changes are documented
• PR title follows conventional commit semantics

Is this a breaking change?

RFC issue number:

Checklist:

• Migration process documented
• Implement warnings (if it can live side by side)

Acknowledgment

By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.

Disclaimer: We value your time and bandwidth. As such, any pull requests created on non-triaged issues might not be successful.

[codecov-commenter]

Codecov Report

Patch and project coverage have no change.

Comparison is base (824912b) 97.18% compared to head (c572651) 97.18%.

Additional details and impacted files

@@           Coverage Diff            @@
##           develop    #2420   +/-   ##
========================================
  Coverage    97.18%   97.18%           
========================================
  Files          153      153           
  Lines         7008     7008           
  Branches       513      513           
========================================
  Hits          6811     6811           
  Misses         156      156           
  Partials        41       41           

☔ View full report in Codecov by Sentry.
📢 Do you have feedback about the report comment? Let us know in this issue.

[heitorlessa]

looking 👀

[heitorlessa]

Thank you for this, great work! One ask I'd have is to create an issue in the mkdocs-material for guidance on how to resolve this properly with a plugin - we have no guarantees we might miss this at some point. We're also missing a section in MAINTAINERS and CONTRIBUTING to mention this standard.