-
Notifications
You must be signed in to change notification settings - Fork 31
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
Update team membership docs and refactor #517
Conversation
I think this is really great, and looks like an excellent update to the structure. Very clear! |
@choldgraf i saw you had added Some notes about the changes in that commit:
|
This looks great, since this changes so many files, I suggest we go for a merge sooner rather than later to avoid conflicts etc. @choldgraf if you think the commit I pushed is acceptable, then +1 for also pressing merge! |
I'm fine with using whatever makefile structure is it is a standard across our repositories! Re: the make.bat, i agree with that too. Though personally I think it'd be nice if we used either tox or nox for these kinds of automation things, but that is outside the scope of this PR. For merging quickly, as long as there are no objections I'm also good to go! We will need to iterate further as we learn more anyway |
@choldgraf I'll go for a merge here then! I'm thinking that its sufficient for a merge at this point now that this has been open for 8 days and have been reviewed and approved by two others, at least because its mainly some refactoring beyond the already agreed upon change. |
This is certainly a subjective aspect, but I'm quite opinionated against making a change away from the use of docs/Makefile (specifically about how we build our docs etc).
|
I definitely don't have as strong of opinions about |
@choldgraf ah it's about the virtual environment part, i thought it was only about "run commands" part. I guess nox + makefile can be used as well then, where tox nox etc could be part of the setup of the python environment. The current Makefile for our docs doesn't do anything related to setup of the environment, it is expected you have done |
yeah the nice thing about tox or nox is that they come bundled with isolated environments. So the first time you run |
We recently discussed updating our team membership structure, and agreed that a good approach would be to remove the "team colors" and instead focus on team names that are more intuitive to understand:
As I was trying to make those changes, I found it hard to update this information without also disentangling some of our other team compass docs. In that process I also noticed several other improvements that could be made to the team compass docs, and so I took the liberty of making some general refactoring improvements.
There are a lot of changes here so below is a quick guide to where to look for the most relevant parts:
Main change: team membership description
Updated the team structure page and our governance page to reflect the discussion in #497 . I haven't added people to one team or another yet, this PR is mostly about describing the teams themselves, their roles / responsibilities, etc.
Most relevant files to look at:
Other cleanup:
Meetings
meetings/
top-level folderContributors page
_data/
folder to make it explicit that it isn't a "content page"Consolidation / theme
I am happy to iterate more on this PR, though I know it's a lot so let me know if anybody would like more specific explanation on a subset of changes etc.