-
Notifications
You must be signed in to change notification settings - Fork 369
Update jetstream docs #1038
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
base: main
Are you sure you want to change the base?
Update jetstream docs #1038
Conversation
81a600c
to
b9f7a6e
Compare
not sure why |
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.
Jetstream 2 -> Jetstream2
Fixes #971 |
@julianpistorius rewrote it after your feedback, I think it is just better to avoid the boot script entirely. The user has to ssh into the instance anyway to setup HTTPS, so let's just do that. The format of the init script is quite awkward, too easy to mess it up. |
8a38ee7
to
a4858da
Compare
for more information, see https://pre-commit.ci
…stream installation guide
for more information, see https://pre-commit.ci
Makes sense! Thank you @zonca. I'll have another look. |
@julianpistorius waiting for your second review before marking this as ready |
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.
Apologies for the delay @zonca!
I made some suggestions. I haven't tested them locally yet. 🤞
Generally I fixed a few links and clarified wording.
My only remaining concerns are that according to the contributing guide:
(Tutorials) should cross-link a lot to other parts of the documentation, avoid forcing the user to learn to SSH if possible & have lots of screenshots.
- We're forcing the user to learn SSH
- We don't have any screenshots anymore
SSH: We could tell them where the passphrase is, and/or point them at the Web Shell.
Screenshots: I made a few screenshots which are in my branch, and still show in my closed PR's files if you want to steal those.
Let me know what you think. Thanks again!
1. A Jetstream account with an XSEDE allocation; for more information, | ||
see the [Jetstream Allocations help page](http://wiki.jetstream-cloud.org/Jetstream+Allocations). | ||
see the [Jetstream Allocations help page](https://jetstream-cloud.org/allocations/). |
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.
Fixed the link, and added a second one.
1. A Jetstream account with an XSEDE allocation; for more information, | |
see the [Jetstream Allocations help page](http://wiki.jetstream-cloud.org/Jetstream+Allocations). | |
see the [Jetstream Allocations help page](https://jetstream-cloud.org/allocations/). | |
1. An ACCESS ID, and membership in an allocation with access to Jetstream2 resources; for more information, | |
see the [Jetstream2 Allocations Overview page](https://docs.jetstream-cloud.org/alloc/overview/) and the [Get started with Jetstream2 guide](https://jetstream-cloud.org/get-started/). |
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.
cannot apply this suggestion, possibly becuase it changes the number of lines?
Co-authored-by: Julian Pistorius <[email protected]>
for more information, see https://pre-commit.ci
Co-authored-by: Julian Pistorius <[email protected]>
Co-authored-by: Julian Pistorius <[email protected]>
Co-authored-by: Julian Pistorius <[email protected]>
Co-authored-by: Julian Pistorius <[email protected]>
Co-authored-by: Julian Pistorius <[email protected]>
for more information, see https://pre-commit.ci
Co-authored-by: Julian Pistorius <[email protected]>
Thank you @zonca! Is it ready for another look? |
Yes, the only leftover was one thing that I could not apply using the GitHub interface |
1 similar comment
Yes, the only leftover was one thing that I could not apply using the GitHub interface |
Maybe you can do a pull request towards my Branch in my own repository so I can just merge it in? |
Updated the tutorial to deploy on Jetstream 2, tested on Ubuntu 24.04.
I'll have the Jetstream team review this first, then I'll mark this ready for your review.