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

Reorganize documentation to be more modular and cleanly grouped #587

Merged
merged 9 commits into from
Nov 25, 2022

Conversation

choldgraf
Copy link
Member

@choldgraf choldgraf commented Nov 24, 2022

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 structure
  • Team resources, which is a combination of team policy, information, and helpful guides
  • Governance, which is about decision-making, but also includes a milestones section even though these aren't really "binding" from a decision-making standpoint
  • Contribute, which is more like a general contribution guide for newcomers

So, 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:

  • Our About the team page is now just a list of our current team members, and it links to a Team information parent page for information about the team structure.
  • Our Team resources page is now broken down into sub-sections. One for Governance and structure, one for Team guides, that describes some common processes and policy we follow, and one for Team coordination, which has information about accounts and shared infrastructure + planning.
    • I created a dedicated page about mybinder.org infrastructure, since that's a special-case within the team.
  • I've moved Governance to the Team resources page, so we have our policy all defined in one place.
  • I've explicitly labeled Contribute as New 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 )
  • Also some housekeeping: I've updated conf.py to use the latest pydata configuration, and also removed a bunch of sphinx-quickstart cruft so that it is simpler

I don't believe any of the content has changed, this is just rearranging

Questions I have

  • Is it actually helpful to collapse "governance" into "team information"?
  • Should we instead have a separate section for "governance and policy" and differentiate this from "team information and guides?"
  • Should the contributing guide be combined into two sub-sections, one for the team and one for other contributors?

@choldgraf
Copy link
Member Author

choldgraf commented Nov 24, 2022

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

Copy link
Member

@sgibson91 sgibson91 left a 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... 🤦🏻‍♀️ )

docs/index.rst Outdated Show resolved Hide resolved
docs/building-blocks/index.rst Outdated Show resolved Hide resolved
docs/conf.py Outdated Show resolved Hide resolved
Co-authored-by: Erik Sundell <[email protected]>
Copy link
Member Author

@choldgraf choldgraf left a 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

docs/index.rst Outdated Show resolved Hide resolved
@choldgraf
Copy link
Member Author

choldgraf commented Nov 25, 2022

OK I just took another pass after @consideRatio's feedback, and made a few other significant changes:

  • Top-level sections now cleanly delineate what are Team policies and practices from What are team guides and information. I hope this makes it clearer that are expectations vs. just helpful information.
  • I've renamed and moved a couple of files / folders to make this easier to navigate and maintain. There is now a practices/ folder (for expected practicies/standards) and a resources/ folder (for helpful information).
  • I've consolidated and removed a few redundant sections so it's clearer what information is the "source of truth" / what should be updated.

cc @minrk - I saw that you Approved while I was making these edits, so just FYI to make sure you notice this

Comment on lines +31 to +36
---
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)
---
Copy link
Member

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.

Copy link
Member Author

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?

Copy link
Member

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!

@consideRatio
Copy link
Member

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.

Copy link
Member

@consideRatio consideRatio left a 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?

@choldgraf
Copy link
Member Author

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.

@consideRatio consideRatio merged commit c19000a into jupyterhub:main Nov 25, 2022
@consideRatio
Copy link
Member

Wieeee!!! Great improvements!

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.

4 participants