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

Add info about viewing compiled docs via www at NERSC #740

Merged
merged 2 commits into from
Jan 19, 2024

Conversation

matthewhoffman
Copy link
Member

@matthewhoffman matthewhoffman commented Nov 30, 2023

This merge adds information about how to view compiled documentation via NERSC's web Science Gateway to avoid needing to scp the compiled documentation locally.

Checklist

  • Developer's Guide has been updated
  • Documentation has been built locally and changes look as expected

@matthewhoffman matthewhoffman added the documentation Improvements or additions to documentation label Nov 30, 2023
@matthewhoffman matthewhoffman requested a review from xylar November 30, 2023 23:30
@matthewhoffman
Copy link
Member Author

Additional information may need to be added about setting the permissions correctly on files and dirs in the www directory so they are visible from the internet. (cc: @andrewdnolan )

Copy link
Collaborator

@xylar xylar left a comment

Choose a reason for hiding this comment

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

Yep, that looks good. We could add similar instructions for Compy, Anvil and Chrysalis in the future since they all have web portals.

@matthewhoffman
Copy link
Member Author

@xylar , I'll add Anvil/Chrysalis to the PR, but I don't think my compy access is working. I also need to add the chmod command needed to make the docs visible to the web. Thanks to @andrewdnolan for pointing that out.

@xylar
Copy link
Collaborator

xylar commented Dec 1, 2023

A chmod shouldn't be necessary on Anvil/Chrysalis but it is on Perlmutter.

@xylar
Copy link
Collaborator

xylar commented Dec 1, 2023

I don't think we have a lot of Compy users, so that's fine,

@xylar
Copy link
Collaborator

xylar commented Jan 17, 2024

@matthewhoffman, maybe we can get this finished up (see suggestion above).

add info regarding chmod command and info for LCRC

Co-authored-by: Xylar Asay-Davis <[email protected]>
@matthewhoffman
Copy link
Member Author

@xylar , thanks for providing the suggestion for this. I committed a modified version of your suggestion and confirmed the instructions worked correctly on Anvil and the results look correct. I have not tried the updated instructions with the chmod command for Perlmutter, but I can try that tomorrow if it's back up if you haven't confirmed it's correct already.

@xylar
Copy link
Collaborator

xylar commented Jan 18, 2024

@matthewhoffman, yes, the command I added is one I use on Perlmutter all the time so I know that it is correct.

@matthewhoffman matthewhoffman merged commit 5fb7b4f into MPAS-Dev:main Jan 19, 2024
4 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants