-
Notifications
You must be signed in to change notification settings - Fork 17
Define high-level organizational structure and re-organize into 2-level structure #276
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
Conversation
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.
Skimmed through the preview as suggested, and think the overall structure is safe to try.
Small side note: If there's a way to collapse the list of links on each section of the index, that would be a nice addition for people who want to know which section they should be looking at - those descriptions of each persona are useful for deciding which you are, but only if you can see them.
index.md
Outdated
## Hub users | ||
## Hub user guide | ||
|
||
For end-users that use a community hub. These are typically most individuals in our member communities - researchers, post-docs, students, etc. |
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.
For end-users that use a community hub. These are typically most individuals in our member communities - researchers, post-docs, students, etc. | |
For end-users that use a community hub. These are typically most individuals in our member communities - researchers, post-docs, students. If you have a question about using a hub, this section is for you. |
index.md
Outdated
|
||
## Hub administrators | ||
|
||
For hub administrators that control a JupyterHub's functionality, approve and onboard users, etc. |
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.
For hub administrators that control a JupyterHub's functionality, approve and onboard users, etc. | |
For hub administrators that control a JupyterHub's functionality, approve and onboard users, monitor usage, etc. If you're responsible for managing a hub, this section's for you. |
index.md
Outdated
## Community leaders and administrators | ||
|
||
For those administering and leading one or more communities. | ||
They care about the overall collaboration and cost structure of 2i2c's service, and make decisions about triggering services from 2i2c. |
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.
They care about the overall collaboration and cost structure of 2i2c's service, and make decisions about triggering services from 2i2c. | |
If you're responsible for the overall collaboration and cost structure, or need to make decisions about triggering services from 2i2c, this section is for you. |
OK after some feedback from @aprilmj , I've pushed a few changes to button-ify-all-the-things. I've now added an index page for each persona, so the left sidebar is much cleaner, and each index page has more information explaining what that persona is about. I've also updated the site landing page to explain the three personas. Along the way I've re-used @aprilmj's suggestions so lemme know what you think about that. ![]() |
fb8cf3e
to
81e1074
Compare
Oh my goodness, SO MANY BUTTONS! |
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.
I thoroughly enjoy ALL OF THE BUTTONS 🙌
Splitting the guide into user personas at the first level is brilliant, since I have definitely heard feedback that the docs were hard to navigate because there's so much content in your face at first. As a docs maintainer, finding the right place to put a piece of specific info should be smoother because of this.
Also, wait... is replicate your own hub new content? If so, nice job!!
I think there are a few bits that could be swapped around or updated, but that shouldn't block this high-level restructure:
- workshop and events should go in the admin and not leadership guide (and also hopefully updated soon)
- the contents of "Ending your service" feels like an admin action rather than a leadership action
- parts of the "Billing and cloud costs" section in the leadership guide is out of date
- the "Get started with a community hub" page of the admin guide should have "Customize your environment" in the list of bullets – this is probably the #1 question we get in support all the time
OK I've implemented each of these suggested changes - I added a note about GCP-specificity and we can update that over time. I'm going to merge this one in because it touches a lot of files. Hopefully this gives us a nicer foundation to extend and maintain. Thanks y'all for the feedback! If somebody notices something after the fact that they'd like to change, just open an issue or ping me and I'm happy to do a quick iteration. |
This PR does a big-ish reorganization of our content.
Find a preview here
Major changes
Overall, rearranges our site structure into the following pattern:
Here are some changes along the way
contribute/
)docs/
is all represented on our brochure site 2i2c-org.github.io#491Request for review
I don't think it's productive to review this whole thing line by line. Instead, I ask that you:
If there's nothing glaring, I suggest we merge this in and start iterating from there. We might also take a similar approach to the
infrastructure/
repository if we like this.