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

Document OpenGitOps teams #148

Merged
merged 12 commits into from
Apr 7, 2023
Merged

Conversation

scottrigby
Copy link
Member

@scottrigby scottrigby commented Mar 7, 2023

Hello everyone 👋 After chatting with @staceypotter more (and after this has come up in many previous meetings), I decided to take a stab at this. Please let me know what you think, make any suggestions, and let's get something in so new people don't have to ask this question to find out about how to be involved in OpenGitOps teams.

Preview: https://github.com/scottrigby/ogo-project/blob/document-teams/TEAMS.md

What this PR does

  • Adds a file to document OpenGitOps teams
  • Clarifies processes around adding new members to a team
  • Disables markdown lint rule MD033 - Inline HTML, to better visually list members

Problem

People consistently ask for info on how to contribute to the GitOps WG, how to join the teams (subgroups), and who is currently involved in each team. We have some transparency for all of this:

  • Teams are listed in the template for the twice-monthly recorded WG meeting, which generally starts with a report from each of the active groups. But not everyone can join these meetings, and it's not clear at a glance looking at the project Git repo what and why these exist, or any of the above informatino
  • We use GitHub teams to help with any permissions we may need for each team, and also so that volunteers can officially list their membership on their GitHub profile. However, there is no discovery for this, because the way GitHub teams work is only existing org members can see the list of other team members

Proposed solution

Add an accessible, easy-to-read markdown file in the project root explaining all of the relevant info about OpenGitOps teams.

To-do

  • Add missing info to this file. For example, the volunteers for each language translation
  • Consider splitting the table of teams into sections for proposed, active, paused and inactive
  • Get feedback via this PR. Does this feel clear to people what the existing teams are, how to volunteer officially, how to propose new teams, and the processes around adding new members and teams?

Follow-up

  • Follow-up: update GOVERNANCE.md to reflect and link here for information about teams instead of "committees"
  • Follow-up: consider adding a directory/README per team. These could define each team's scope/purpose, clearly link to any relevant meeting info, and list the members there instead of all in one big document like this. This would also open the possibility of allowing direct team access to their file(s) via a GitHub CODEOWNERS file

Signed-off-by: Scott Rigby <[email protected]>
…mport this into the website and people would still know which file to make a PR against

Signed-off-by: Scott Rigby <[email protected]>
TEAMS.md Outdated Show resolved Hide resolved
TEAMS.md Outdated Show resolved Hide resolved
TEAMS.md Outdated Show resolved Hide resolved
scottrigby and others added 3 commits March 16, 2023 13:14
Co-authored-by: Niklas <[email protected]>
Signed-off-by: Scott Rigby <[email protected]>
Co-authored-by: Niklas <[email protected]>
Signed-off-by: Scott Rigby <[email protected]>
Thanks for catching this Niklas :-)

Co-authored-by: Niklas <[email protected]>
Signed-off-by: Scott Rigby <[email protected]>
TEAMS.md Outdated Show resolved Hide resolved
Signed-off-by: Scott Rigby <[email protected]>
TEAMS.md Outdated Show resolved Hide resolved
Removing for now until we set up these teams. Tracked in open-gitops#149

Signed-off-by: Scott Rigby <[email protected]>
TEAMS.md Outdated Show resolved Hide resolved
Copy link
Member

@niklasmtj niklasmtj left a comment

Choose a reason for hiding this comment

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

Looks great! Thank you!

TEAMS.md Outdated Show resolved Hide resolved
Copy link

@staceypotter staceypotter left a comment

Choose a reason for hiding this comment

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

This looks great @scottrigby! Thanks so much for putting it together, and sorry for my extremely late review! <3

Copy link
Member

@roberthstrand roberthstrand left a comment

Choose a reason for hiding this comment

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

👏

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.

6 participants