-
Notifications
You must be signed in to change notification settings - Fork 358
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
Update Debian installation instructions #1410
Conversation
@steffengraber Thanks for your suggestions! I added the changes. |
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.
Perfect!
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.
Indentation causes the file to not render well on Github, while all other pages do. They render fine with sphinx though.
@terhorstd Yes, I noticed that too. The indentation is needed for the tabs to render with Sphinx and on RtD. Our options are:
What do you think? |
Hi, I've run into similar issues before. Support for rendering Markdown or reStructuredText on GitHub is very restricted. This is by design (due to security implications) and is fair enough from GitHub's perspective, but I would recommend against designing files such that they render well on github.com. We should nevertheless aim for something that is as standards-compliant as rST/MD gets (pandoc support seems a good target and also implies good readthedocs compliance). For the particular case of tabs in the UI, I don't have any strongly held opinions about keeping them or removing them. |
I agree with @clinssen, that we should not explicitly design files for github. The indentation is apparently required for Generally keeping or removing tabs and discussing adequate use-cases should be split from this PR. |
Co-Authored-By: terhorstd <terhorstd@users.noreply.github.com>
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.
With the additional packages installed, it works for me on Debian 11. Nice!
These packages should then also be mentioned in the instructions.
I also added some suggestions to point the user to the right places to look for "NUMBER", etc.. I didn't check the formatting of those suggestions though, so if you accept them, please also verify they render well.
One warning could be mentioned, or taken care of in another PR. Only fix it here if it's clear and easy to fix.
Co-authored-by: terhorstd <terhorstd@users.noreply.github.com>
Co-authored-by: terhorstd <terhorstd@users.noreply.github.com>
…r into fix_issue_1349
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.
LGTM! 👍
This PR updates the installation instructions for Debian. It also creates separate Ubuntu and Debian tabs for added clarity.
It fixes #1349.