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

Improve doc install pages #3067

Merged
merged 10 commits into from
Mar 7, 2024

Conversation

jessica-mitchell
Copy link
Contributor

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

@jessica-mitchell jessica-mitchell added T: Enhancement New functionality, model or documentation P: Blocked Work on this can not continue, see comments for the particular reason S: Normal Handle this with default priority I: No breaking change Previously written code will work as before, no one should note anything changing (aside the fix) labels Jan 17, 2024
@jessica-mitchell jessica-mitchell added this to In progress in Documentation via automation Jan 17, 2024
@jessica-mitchell
Copy link
Contributor Author

@ddahmen @heplesser @steffengraber @clinssen

output here

Changes made

  • removed HPC card and instructions
  • moved minimal configuration to cmake options
  • Add EBRAINS install free in separate PR

TODO

improve HPC install instructions

Copy link
Contributor

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

Copy link
Contributor

@heplesser heplesser left a 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

Documentation automation moved this from In progress to Review Mar 1, 2024
@jessica-mitchell
Copy link
Contributor Author

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

@jessica-mitchell jessica-mitchell removed the P: Blocked Work on this can not continue, see comments for the particular reason label Mar 4, 2024
Copy link
Contributor

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

@jessica-mitchell
Copy link
Contributor Author

jessica-mitchell commented Mar 5, 2024

@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

@heplesser
Copy link
Contributor

@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!

@clinssen
Copy link
Contributor

clinssen commented Mar 5, 2024

@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?

Copy link
Contributor

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

doc/htmldoc/installation/index.rst Outdated Show resolved Hide resolved
@jessica-mitchell jessica-mitchell merged commit f619983 into nest:master Mar 7, 2024
24 checks passed
Documentation automation moved this from Review to Done Mar 7, 2024
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: Enhancement New functionality, model or documentation
Projects
Documentation
  
Done
Development

Successfully merging this pull request may close these issues.

None yet

3 participants