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

Update Debian installation instructions #1410

Merged
merged 16 commits into from
Jul 1, 2020

Conversation

sarakonradi
Copy link
Contributor

This PR updates the installation instructions for Debian. It also creates separate Ubuntu and Debian tabs for added clarity.

It fixes #1349.

doc/installation/index.rst Outdated Show resolved Hide resolved
doc/installation/index.rst Outdated Show resolved Hide resolved
doc/installation/index.rst Show resolved Hide resolved
doc/installation/index.rst Outdated Show resolved Hide resolved
@sarakonradi
Copy link
Contributor Author

@steffengraber Thanks for your suggestions! I added the changes.

@terhorstd terhorstd added ZC: Documentation DO NOT USE THIS LABEL ZP: PR Created DO NOT USE THIS LABEL S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation. I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Feb 19, 2020
Copy link
Contributor

@steffengraber steffengraber left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Perfect!

@sarakonradi sarakonradi mentioned this pull request Mar 16, 2020
24 tasks
Copy link
Contributor

@terhorstd terhorstd left a 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.

https://github.com/nest/nest-simulator/blob/3e23c1f201a1bd9ffe357b01c166fd8779aa4191/doc/installation/index.rst

@sarakonradi
Copy link
Contributor Author

Indentation causes the file to not render well on Github, while all other pages do. They render fine with sphinx though.

https://github.com/nest/nest-simulator/blob/3e23c1f201a1bd9ffe357b01c166fd8779aa4191/doc/installation/index.rst

@terhorstd Yes, I noticed that too. The indentation is needed for the tabs to render with Sphinx and on RtD.

Our options are:

  1. We keep the tabs, since they work fine on RtD.
  2. We remove them and create separate files for the different operating systems.

What do you think?

@clinssen
Copy link
Contributor

clinssen commented Apr 2, 2020

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.

@terhorstd terhorstd added this to To do in Documentation Apr 2, 2020
@terhorstd terhorstd moved this from To do to In progress in Documentation Apr 2, 2020
@terhorstd
Copy link
Contributor

I agree with @clinssen, that we should not explicitly design files for github. The indentation is apparently required for ..tabs: to work.

Generally keeping or removing tabs and discussing adequate use-cases should be split from this PR.

doc/installation/index.rst Outdated Show resolved Hide resolved
doc/installation/index.rst Show resolved Hide resolved
Documentation automation moved this from In progress to Review Apr 3, 2020
@heplesser heplesser removed ZC: Documentation DO NOT USE THIS LABEL ZP: PR Created DO NOT USE THIS LABEL labels Apr 7, 2020
Copy link
Contributor

@terhorstd terhorstd left a 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.

doc/installation/index.rst Show resolved Hide resolved
doc/installation/index.rst Outdated Show resolved Hide resolved
doc/installation/index.rst Show resolved Hide resolved
Steffen and others added 6 commits June 25, 2020 12:21
Copy link
Contributor

@terhorstd terhorstd left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! 👍

@terhorstd terhorstd merged commit c3bbe44 into nest:master Jul 1, 2020
Documentation automation moved this from Review to Done Jul 1, 2020
@sarakonradi sarakonradi deleted the fix_issue_1349 branch September 21, 2020 08:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) S: Normal Handle this with default priority T: Maintenance Work to keep up the quality of the code and documentation.
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

Nest install - add-apt-repository fails
5 participants