-
Notifications
You must be signed in to change notification settings - Fork 369
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
Improve doc install pages #3067
Improve doc install pages #3067
Conversation
@ddahmen @heplesser @steffengraber @clinssen Changes made
TODO improve HPC install instructions |
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.
@jessica-mitchell Looks good to me! I suggest to create a new issue to remind us of the need to provide better HPC installation instructions.
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.
Actually, I noticed that in the #3066 version, we have page https://nest-simulator--3066.org.readthedocs.build/en/3066/installation/admin.html#admin-install. On it, the link under "Configure HPC Systems" leads to a page without useful information, but the other links, namely
- https://nest-simulator--3066.org.readthedocs.build/en/3066/hpc/optimizing_nest.html#optimize-performance
- links to docker instructions
provide useful information. It would be good if we could keep links to them from the install page.
So the docker instructions are already on the install page, but I added a card about configuring HPC systems there |
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.
@jessica-mitchell Would you mind moving the "Configure HPC" card to the top row? It looks rather strange with the open space on the top right.
This will be fixed in the PR that adds the EBRAINS card #3121 |
Good! |
It has disappeared entirely in that PR, is that the intention? |
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.
Thanks for the updates! I would suggest to add a subheader for "Install related tools" or such for NEST Desktop and NESTML, to prevent confusion.
This PR builds on #3066 focusing on the install pages, to make it easier to access the various methods we have for installation, the index page is updated with links and nestml and nest-desktop are clearly marked as well as projects to look at as well.
It cannot be merged until #3066 so will be labeled blocked