-
Notifications
You must be signed in to change notification settings - Fork 10
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 infrastructure docs and diagrams #307
base: main
Are you sure you want to change the base?
Conversation
The latest updates on your projects. Learn more about Vercel for Git ↗︎
|
This is a first pass on the writing, I still need to update the bottom part as I think its confusing |
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.
@viniciusdc This covers a lot of really great information! I left a few suggestions on content and also did a grammatical review. Thanks for opening this!
- The Hub initiates a proxy, | ||
- Jhub-apps is launched and registered with JupyterHub, | ||
- The proxy initially routes all requests to the Hub, | ||
- Jhub-apps modifies the Hub's homepage to include its URL, extending the service | ||
selection options for users, who can now choose from a variety of frameworks. | ||
- The Hub continues to handle logins and server spawning, | ||
- Jhub-apps adjusts the request handling to direct users to the appropriate single-user server environments based on their selections. |
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.
The commas in this section throw me off. Given that this is a long list of items and, I think, these things are sequential, could it instead move to a numbered list and the trailing punctuation removed?
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.
yes not a problem, I tried to follow what jupyterhub did https://jupyterhub.readthedocs.io/en/latest/reference/technical-overview.html#how-the-subsystems-interact, though I kept iterating this list and ended up like this, thanks for catching it!
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.
refactored this a bit
Co-authored-by: Kim Pevey <kcpevey@quansight.com>
@viniciusdc is this ready for review again? |
I am just refactoring that last part, will ping you shortly |
sorry for the delay here @kcpevey, I finished my updates on this, its now ready for a final review. I am happy with how the last sections ended up now :) |
Reference Issues or PRs
closes #255
What does this implement/fix?
Put a
x
in the boxes that applyTesting
Documentation
Access-centered content checklist
Text styling
H1
or#
in markdown).Non-text content
Any other comments?