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

Added Governance Page to list the maintainers and dev meetings of various OCaml projects #1239

Merged
merged 1 commit into from
Nov 13, 2023

Conversation

tmattio
Copy link
Collaborator

@tmattio tmattio commented May 31, 2023

The page lists the teams that compose the ecosystem (Compiler, Packaging, Infrastructure, Platform) and working groups (e.g. Multicore)

This is very WIP, the list of maintainers has been scraped from GitHub teams on the OCaml organisation. I'm opening the PR early to get some early feedback and facilitate communication to get an accurate list of teams and maintainers.

Governance Page Team Working Group
screencapture-localhost-8080-governance-2023-06-23-11_40_04 screencapture-localhost-8080-governance-compiler-2023-06-23-11_40_34 screencapture-localhost-8080-governance-wg-eio-2023-06-23-11_40_48

@sabine
Copy link
Collaborator

sabine commented May 31, 2023

I like this. It makes it so much clearer who is a maintainer.

There's a problem with the Email links, they go to 404 pages on ocaml.org.

Would be good to merge after the placeholder texts have been pruned and the lists of maintainers have been completed. Even without the working groups section, if that requires more work. Incremental progress is good.

@tmattio tmattio force-pushed the governance branch 2 times, most recently from faa569d to ec4a1d3 Compare May 31, 2023 21:46
@kayceesrk
Copy link
Contributor

This is great. Thanks @tmattio.

@tmattio
Copy link
Collaborator Author

tmattio commented Jun 17, 2023

@sabine do you think you'd have time to take over the UI part of this? I can work with the different teams and working groups to get correct data on the maintainers, communication channels, etc.

From a UI perspective, we can aim to get a minimal version in. The most important information to display for each team and subteam, I think, is:

  • The list of maintainers
  • The communication channels (mailing lists, GitHub, slack channels, discord, etc.)
  • The dev meetings if they are open
  • The dev meetings notes
  • The main repositories they are responsible for

@sabine
Copy link
Collaborator

sabine commented Jun 17, 2023

Yes. Bring sufficiently complete enough data here and I will fix this up and get it live.

@sabine sabine force-pushed the governance branch 2 times, most recently from 8644cc7 to 33991db Compare June 23, 2023 08:51
@avsm
Copy link
Member

avsm commented Jun 23, 2023

This looks great. Might we be able to use the GitHub API to map the various team ids from the groups there? The links to email lists on lists.ocaml.org will not currently work either.

@tmattio
Copy link
Collaborator Author

tmattio commented Jun 23, 2023

This looks great. Might we be able to use the GitHub API to map the various team ids from the groups there?

That was our idea too, yes! For this, we'd need a few things:

  • Move some of the Platform repositories in the Active stage to the OCaml GH organisation (following the Platform governance). In particular ppxlib, ocamlformat, opam-publish and utop
  • Create missing teams for the dev teams that don't have one (e.g. opam-dev)
  • Move the project permissions to be managed at the GH team level and not at the repository level

Since the GH teams haven't been used uniformly and some of them might be outdated, we were thinking of first agreeing on what the current state of the world is with the different project maintainers, and then open an issue on ocaml/infrastructure to request the migration of the projects and updates on the teams.

Happy to proceed differently if you see a better way to do it though.

@tmattio tmattio marked this pull request as ready for review June 23, 2023 09:46
sabine added a commit that referenced this pull request Jun 23, 2023
sabine added a commit that referenced this pull request Jun 23, 2023
@avsm
Copy link
Member

avsm commented Jun 25, 2023

Harmonising the GitHub permissions and ensuring this list stays in sync with reality that way sounds good to me. Note that there are several sub-organisatiosn involved as well -- ocaml-opam, ocaml-ppx, and ocaml-dune. I have admin on all of those to setup tokens as needed for the API scraping.

@tmattio tmattio force-pushed the governance branch 5 times, most recently from 3cbb631 to 0395408 Compare June 25, 2023 17:27
data/governance.yml Outdated Show resolved Hide resolved
data/governance.yml Outdated Show resolved Hide resolved
Copy link
Collaborator

@christinerose christinerose left a comment

Choose a reason for hiding this comment

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

Minor capitalisation/formatting suggestions & a few grammatical corrections. Some of the. Names would normally be in monospace, so I suggested as much; however, if monospace isn’t possible in its final view, then format them as if they were in monospace. If there was a way to visually differentiate them, like bold or italics, then it would be beneficial (but not necessary)

data/governance.yml Outdated Show resolved Hide resolved
data/governance.yml Outdated Show resolved Hide resolved
data/governance.yml Outdated Show resolved Hide resolved
data/governance.yml Outdated Show resolved Hide resolved
data/governance.yml Outdated Show resolved Hide resolved
data/governance.yml Outdated Show resolved Hide resolved
data/governance.yml Show resolved Hide resolved
data/governance.yml Outdated Show resolved Hide resolved
data/governance.yml Show resolved Hide resolved
data/governance.yml Outdated Show resolved Hide resolved
sabine added a commit that referenced this pull request Aug 23, 2023
sabine added a commit that referenced this pull request Aug 23, 2023
sabine added a commit that referenced this pull request Aug 23, 2023
sabine added a commit that referenced this pull request Aug 29, 2023
sabine added a commit that referenced this pull request Sep 7, 2023
sabine added a commit that referenced this pull request Oct 5, 2023
sabine added a commit that referenced this pull request Oct 5, 2023
sabine added a commit that referenced this pull request Oct 9, 2023
sabine added a commit that referenced this pull request Oct 10, 2023
sabine added a commit that referenced this pull request Oct 12, 2023
sabine added a commit that referenced this pull request Oct 12, 2023
sabine added a commit that referenced this pull request Oct 16, 2023
sabine added a commit that referenced this pull request Oct 17, 2023
sabine added a commit that referenced this pull request Oct 17, 2023
sabine added a commit that referenced this pull request Oct 20, 2023
sabine added a commit that referenced this pull request Oct 24, 2023
sabine added a commit that referenced this pull request Oct 26, 2023
Co-authored-by: Asaad Mahmood <[email protected]>
Co-authored-by: MirzaBabarBaig <[email protected]>
Co-authored-by: Cuihtlauac Alvarado <[email protected]>
Co-authored-by: Sabine Schmaltz <[email protected]>
Co-authored-by: Thibaut Mattio <[email protected]>
Co-authored-by: Christine Rose <[email protected]>
Co-authored-by: Riku Silvola <[email protected]>
@tmattio
Copy link
Collaborator Author

tmattio commented Nov 13, 2023

The need for that page presented itself again recently.

As mentioned in the review, it would be better to fetch this information from the GitHub API, but until we have up-to-date teams on the different GitHub organisations that we can use to populate the data, I think the page provides enough value that we can keep it updated manually. Therefore, I'll go ahead and merge it now.

While I've tried to get feedback from the maintainers and I believe the list of maintainers represents the current state of the world, it's possible that there are accuracies. If you notice such inaccuracies, first, apologies in advance, and second, please don't hesitate to reach out to or send a pull request!

As a next step for this page:

  • We should try to automate it by using GitHub API (see Use GitHub teams to manage project permissions infrastructure#55)
  • Now that the page is there, we can start adding the existing working groups. For instance, OCaml Wasm, Windows, or any other currently running working group.
  • Let's make the information complete and accurate if it's not already the case. If you notice missing maintainers, missing dev meetings, or anything that needs updating, a PR is welcome.

@tmattio tmattio merged commit 72a48da into main Nov 13, 2023
2 of 3 checks passed
@tmattio tmattio deleted the governance branch November 13, 2023 18:35
sabine added a commit to balat/ocaml.org that referenced this pull request Dec 12, 2023
Co-authored-by: Asaad Mahmood <[email protected]>
Co-authored-by: MirzaBabarBaig <[email protected]>
Co-authored-by: Cuihtlauac Alvarado <[email protected]>
Co-authored-by: Sabine Schmaltz <[email protected]>
Co-authored-by: Christine Rose <[email protected]>
Co-authored-by: Riku Silvola <[email protected]>
@sabine sabine changed the title Add governance page Expanded Governance Page to list the maintainers and dev meetings of various OCaml projects Dec 13, 2023
@sabine sabine changed the title Expanded Governance Page to list the maintainers and dev meetings of various OCaml projects Added Governance Page to list the maintainers and dev meetings of various OCaml projects Dec 13, 2023
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.

9 participants