-
Notifications
You must be signed in to change notification settings - Fork 33
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
Reorganize documentation to be more modular and cleanly grouped #587
Conversation
Another ping for @consideRatio since I'm on a roll w/ documentation today :-D and maybe @sgibson91 who might have thoughts via her CSL role |
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.
One nitpick over word choice but shouldn't be a blocker. (Which I have just realised that I forgot to add... 🤦🏻♀️ )
Co-authored-by: Erik Sundell <[email protected]>
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.
Thanks for the feedback y'all - will take another quick pass and resolve these
OK I just took another pass after @consideRatio's feedback, and made a few other significant changes:
cc @minrk - I saw that you Approved while I was making these edits, so just FYI to make sure you notice this |
--- | ||
Currently, the bot will only check the following repositories: | ||
* [binderhub](https://github.com/jupyterhub/binderhub) | ||
* [jupyterhub](https://github.com/jupyterhub/jupyterhub) | ||
* [the-littlest-jupyterhub](https://github.com/jupyterhub/the-littlest-jupyterhub) | ||
--- |
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.
These kinds of lists are unsustainable to maintain overall I think, where its better to link to the configuration where one can see what repositories its active for.
No change requested though as its not unproblematic in this case to not be mistaken about the current state sometime in the future when this is outdated.
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 agree w you. If there's a place where this is configured I'm happy to link it in this PR. If it's more complex then let's open an issue for a future fix?
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 was thinking it was you who had written these lines now, but it was just relocated - let's not add an action point for such a trivial thing!
I'll go ahead and push some commits as I wanted to ensure that existing links redirect instead of break, so I'll be adding the sphinx extension rediraffe. |
b274f11
to
7f9cb41
Compare
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 added three commits, this LGTM to me.
@choldgraf can you review the added commits?
Also, could I be added to https://readthedocs.org/projects/jupyterhub-team-compass/ as well?
Thanks - the redirects look great to me. Also I appreciate you added the date for them, so we can decide if we want to delete them after some time has passed. I added you as a maintainer for this repo on RTD. |
Wieeee!!! Great improvements! |
I was looking into where information for the mybinder.org cloud credit information could go, and found that it was a bit hard for me to figure out the "natural" grouping of information. We have:
About our team
, which as a list of team members below the fold, as well as information about team structureTeam resources
, which is a combination of team policy, information, and helpful guidesGovernance
, which is about decision-making, but also includes amilestones
section even though these aren't really "binding" from a decision-making standpointContribute
, which is more like a general contribution guide for newcomersSo, this PR tries to do a few things with the goal of making information easier to find, more naturally grouped, and easier to decide where to update or add new information. Here's a summary:
About the team
page is now just a list of our current team members, and it links to aTeam information
parent page for information about the team structure.Team resources
page is now broken down into sub-sections. One forGovernance and structure
, one forTeam guides
, that describes some common processes and policy we follow, and one forTeam coordination
, which has information about accounts and shared infrastructure + planning.mybinder.org
infrastructure, since that's a special-case within the team.Governance
to theTeam resources
page, so we have our policy all defined in one place.Contribute
asNew contributors guide
so that it's clear what kind of information belongs there (we might consider moving this somewhere else depending on Sketching ideas for the content of a Community Handbook #572 )conf.py
to use the latest pydata configuration, and also removed a bunch ofsphinx-quickstart
cruft so that it is simplerI don't believe any of the content has changed, this is just rearranging
Questions I have