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

Restructure hub template doc, update diagram and add more info #282

Merged
merged 3 commits into from
Mar 3, 2021

Conversation

GeorgianaElena
Copy link
Member

Ref: #274
Closes #162

Copy link
Member

@yuvipanda yuvipanda left a comment

Choose a reason for hiding this comment

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

One comment, but text looks good! The image is empty?

docs/configure.md Outdated Show resolved Hide resolved
@yuvipanda
Copy link
Member

In addition, I think we need to document https://github.com/2i2c-org/pilot-hubs/blob/master/hub.py#L356. If you're using daskhub or ephemeral hub, config in hubs.yaml needs to be nested under a base-hub key. This is because base-hub is now a sub chart of daskhub, and jupyterhub (z2jh) is a sub chart of base-hub (https://helm.sh/docs/chart_template_guide/subcharts_and_globals/#overriding-values-from-a-parent-chart). Does this make sense?

Co-authored-by: Yuvi Panda <yuvipanda@gmail.com>
@GeorgianaElena
Copy link
Member Author

The image is empty?

It shouldn't be: https://github.com/GeorgianaElena/pilot-hubs/blob/docs/hub-templates/docs/images/config-flow.png

Does this make sense?

Yes! Ty!

@yuvipanda
Copy link
Member

Ah, GitHub shows the images like this:

image

But they're clearly there!

And they're pretty damn awesome! I'll merge this now :)

@yuvipanda yuvipanda merged commit b0bbc1f into 2i2c-org:master Mar 3, 2021

For example, the **ephemeral hub** is a special kind of hub that is built using the *ephemeral-hub template*
and has the following features:
```{figure} images/config-flow.png
Copy link
Member

Choose a reason for hiding this comment

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

@GeorgianaElena can you add a comment in these docs (with % ) that says where these images were created, and how a different team member could update them if they wanted to do so?

@GeorgianaElena GeorgianaElena deleted the docs/hub-templates branch March 9, 2021 10:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Document how hub templates work
3 participants