docs(navigation): standardize link targets to enhance customer experience#2420
Merged
heitorlessa merged 6 commits intoJun 8, 2023
Conversation
leandrodamascena
requested review from
rubenfonseca
and removed request for
a team
boring-cyborg
Bot
added
dependencies
pull-request-size
Bot
added
the
size/L
1 task
leandrodamascena
requested review from
heitorlessa
and removed request for
rubenfonseca
Codecov ReportPatch and project coverage have no change.
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. |
heitorlessa
changed the title
Contributor
|
looking 👀 |
heitorlessa
approved these changes
Jun 8, 2023
Contributor
|
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. |
sthulb
pushed a commit
that referenced
this pull request
Jun 19, 2023
…ence (#2420) Co-authored-by: erikayao93 <erikayao@amazon.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
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.instantfeature and we use this.User experience
Checklist
If your change doesn't seem to apply, please leave them unchecked.
Is this a breaking change?
RFC issue number:
Checklist:
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.