Use menuTitle for more user-friendly lists of topics #2290
Merged
Conversation
This file contains 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
osg-grafana
approved these changes
Jul 4, 2022
jhesketh
approved these changes
Jul 4, 2022
|
Thanks for the review! The link is technically valid but is incorrectly determined by the tool to be invalid. |
|
Ah, I see 👍. It might be worth putting in the PR message a link to the dependant PR. Eg:
|
pracucci
approved these changes
Jul 4, 2022
docs/sources/operators-guide/monitoring-grafana-mimir/_index.md
Outdated
Show resolved
Hide resolved
Signed-off-by: Jack Baldry <[email protected]>
Grafana Mimir is already inferred by context Signed-off-by: Jack Baldry <[email protected]>
I believe the section was intended to enumerate the components but it is empty as there are no subdirectories of this page. Signed-off-by: Jack Baldry <[email protected]>
pracucci
force-pushed
the
jdb/2022-06-menuTitle
branch
from
74f653f to
a1b7b13
Compare
|
I rebased this PR. |
Signed-off-by: Marco Pracucci <[email protected]>
I rebased but the link is still reported. I fixed the link to move on. We can look at it separately, even if I think it's a nice property being explicit with what we want to link (the index file). |
Signed-off-by: Marco Pracucci <[email protected]>
I just realized the link was broken for real. It should have been |
Co-authored-by: Marco Pracucci <[email protected]>
masonmei
pushed a commit
to udmire/mimir
that referenced
this pull request
Jul 11, 2022
* Use menuTitle for more user-friendly lists of topics Signed-off-by: Jack Baldry <[email protected]> * Reduce stuttering in menu titles Grafana Mimir is already inferred by context Signed-off-by: Jack Baldry <[email protected]> * Replace empty section with link to components I believe the section was intended to enumerate the components but it is empty as there are no subdirectories of this page. Signed-off-by: Jack Baldry <[email protected]> * Fixed link reported by doc-validator Signed-off-by: Marco Pracucci <[email protected]> * Fixed link Signed-off-by: Marco Pracucci <[email protected]> * Apply code review suggestions Co-authored-by: Marco Pracucci <[email protected]> Co-authored-by: Marco Pracucci <[email protected]>
grafanabot
pushed a commit
that referenced
this pull request
Jul 11, 2022
* Use menuTitle for more user-friendly lists of topics Signed-off-by: Jack Baldry <[email protected]> * Reduce stuttering in menu titles Grafana Mimir is already inferred by context Signed-off-by: Jack Baldry <[email protected]> * Replace empty section with link to components I believe the section was intended to enumerate the components but it is empty as there are no subdirectories of this page. Signed-off-by: Jack Baldry <[email protected]> * Fixed link reported by doc-validator Signed-off-by: Marco Pracucci <[email protected]> * Fixed link Signed-off-by: Marco Pracucci <[email protected]> * Apply code review suggestions Co-authored-by: Marco Pracucci <[email protected]> Co-authored-by: Marco Pracucci <[email protected]> (cherry picked from commit 6f5e325)
dimitarvdimitrov
pushed a commit
that referenced
this pull request
Jul 11, 2022
* Use menuTitle for more user-friendly lists of topics Signed-off-by: Jack Baldry <[email protected]> * Reduce stuttering in menu titles Grafana Mimir is already inferred by context Signed-off-by: Jack Baldry <[email protected]> * Replace empty section with link to components I believe the section was intended to enumerate the components but it is empty as there are no subdirectories of this page. Signed-off-by: Jack Baldry <[email protected]> * Fixed link reported by doc-validator Signed-off-by: Marco Pracucci <[email protected]> * Fixed link Signed-off-by: Marco Pracucci <[email protected]> * Apply code review suggestions Co-authored-by: Marco Pracucci <[email protected]> Co-authored-by: Marco Pracucci <[email protected]> Co-authored-by: Jack Baldry <[email protected]> (cherry picked from commit 6f5e325)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
What this PR does
Uses the
menuTitleparameter of thesectionshortcode to reduce stuttering throughout the documentation.Titles include "Grafana Mimir" as context when the page turns up on search engine results but when you are in the documentation, this is already implied.
Checklist