-
Notifications
You must be signed in to change notification settings - Fork 2.3k
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
Fixed troubleshooting header id and added pre-commit installation troubleshooting #2128
Conversation
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.
@davidpfarrell LGTM, but could you please give this a look over?
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.
Greetings !
I'm looking at the reStructuredText Markup Specification
page and can't find reference to this <#..>
usage - Can you point me to it? And/or maybe other online examples of this usage?
@@ -6,11 +6,19 @@ Troubleshooting Guide | |||
Table of Contents | |||
----------------- | |||
|
|||
* `I'm stuck in the LightDM login screen after setting up bash-it. <im-stuck-in-the-lightdm-login-screen-after-setting-up-bash-it>`_ | |||
* `I'm stuck in the LightDM login screen after setting up bash-it. <#id1>`_ | |||
* `Pre-commit installation is failed with "unrecognized option --gdwarf-5" error. <#id3>`_ |
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.
Why is it #id3
instead of #id2
?
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.
This is called id attribute scroll/focus. I checked that in restructured text, it is setting the id attribute to #id1
. Which is wrong in the current https://bash-it.readthedocs.io/en/latest/troubleshooting/im-stuck-in-the-lightdm-login-screen-after-setting-up-bash-it redirected to 404 whereas https://bash-it.readthedocs.io/en/latest/troubleshooting/#id1 takes to the correct heading on the troubleshooting page.
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.
These ids' are of the section headers generated by the rst. Even I am wondering why it didn't slugify the header text instead.
|
19d1c37
to
22cadca
Compare
Timeout |
Description
This pull request contains the two this
#id1
pre-commit
installation hereMotivation and Context
How Has This Been Tested?
Locally on Linux using docs build command
Screenshots (if appropriate):
Types of changes
Checklist:
clean_files.txt
and formatted it usinglint_clean_files.sh
.