Skip to content
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

Closed
wants to merge 4 commits into from

Conversation

tbhaxor
Copy link
Contributor

@tbhaxor tbhaxor commented Mar 12, 2022

Description

This pull request contains the two this

  1. Fix for the id of the "LightDM" troubleshooting. #id1
  2. Add instructions to fix the pre-commit installation here

Motivation and Context

How Has This Been Tested?

Locally on Linux using docs build command

Screenshots (if appropriate):

image

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code follows the code style of this project.
  • If my change requires a change to the documentation, I have updated the documentation accordingly.
  • I have read the CONTRIBUTING document.
  • If I have added a new file, I also added it to clean_files.txt and formatted it using lint_clean_files.sh.
  • I have added tests to cover my changes, and all the new and existing tests pass.

Copy link
Member

@cornfeedhobo cornfeedhobo left a 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?

Copy link
Contributor

@davidpfarrell davidpfarrell left a 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?

docs/troubleshooting.rst Outdated Show resolved Hide resolved
@@ -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>`_
Copy link
Contributor

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 ?

Copy link
Contributor Author

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.

Copy link
Contributor Author

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.

@tbhaxor
Copy link
Contributor Author

tbhaxor commented May 6, 2022

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?

`Content <link>`_ is basically a syntax in rst which gets converted to [Content](link) in markdown or <a href="link">Content</a> in html. You can have any type of link

@tbhaxor tbhaxor force-pushed the improve/troubleshoot branch from 19d1c37 to 22cadca Compare May 6, 2022 17:45
@tbhaxor
Copy link
Contributor Author

tbhaxor commented Feb 23, 2023

Timeout

@tbhaxor tbhaxor closed this Feb 23, 2023
@tbhaxor tbhaxor deleted the improve/troubleshoot branch February 23, 2023 11:40
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants