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.

Sign up for GitHub

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
Closed

Fixed troubleshooting header id and added pre-commit installation troubleshooting #2128

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
2113a60
fix (docs): id and link of the header element
tbhaxor Mar 12, 2022
d813713
fix (docs): add troubleshooting for pre-commit error #1696
tbhaxor Mar 12, 2022
22cadca
fix (docs): trailing ^ in troubleshooting.rst
tbhaxor May 6, 2022
878e4e3
Merge branch 'master' into improve/troubleshoot
tbhaxor May 8, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 9 additions & 1 deletion docs/troubleshooting.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.


I'm stuck in the LightDM login screen after setting up bash-it
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Possible issue**\ : `#672 <https://github.com/Bash-it/bash-it/issues/672>`_

**Solution**\ : Check `this comment <https://github.com/Bash-it/bash-it/issues/672#issuecomment-257870653>`_ for detailed information about the cause and solution for this issue.

Pre-commit installation is failed with "unrecognized option --gdwarf-5" error
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

**Possible issue**\ : You might have an incompatible version of GCC is installed. Supported versions are below ``gcc-10``

**Solution** Export the different gcc version using ``export CC=gcc-8``. For more information, check `this comment <https://github.com/Bash-it/bash-it/issues/1696#issuecomment-1035968473>`__.