GOV add a documentation team (#26714)

scikit-learn · Aug 12, 2023 · 622d546 · 622d546
1 parent 3419e8c
commit 622d546
Show file tree

Hide file tree

Showing 4 changed files with 53 additions and 2 deletions.
diff --git a/build_tools/generate_authors_table.py b/build_tools/generate_authors_table.py
@@ -43,17 +43,24 @@ def get_contributors():
     """Get the list of contributor profiles. Require admin rights."""
     # get core devs and contributor experience team
     core_devs = []
+    documentation_team = []
     contributor_experience_team = []
     comm_team = []
     core_devs_slug = "core-devs"
     contributor_experience_team_slug = "contributor-experience-team"
     comm_team_slug = "communication-team"
+    documentation_team_slug = "documentation-team"
 
     entry_point = "https://api.github.com/orgs/scikit-learn/"
 
     for team_slug, lst in zip(
-        (core_devs_slug, contributor_experience_team_slug, comm_team_slug),
-        (core_devs, contributor_experience_team, comm_team),
+        (
+            core_devs_slug,
+            contributor_experience_team_slug,
+            comm_team_slug,
+            documentation_team_slug,
+        ),
+        (core_devs, contributor_experience_team, comm_team, documentation_team),
     ):
         for page in [1, 2]:  # 30 per page
             reply = get(f"{entry_point}teams/{team_slug}/members?page={page}")
@@ -67,6 +74,7 @@ def get_contributors():
 
     # keep only the logins
     core_devs = set(c["login"] for c in core_devs)
+    documentation_team = set(c["login"] for c in documentation_team)
     contributor_experience_team = set(c["login"] for c in contributor_experience_team)
     comm_team = set(c["login"] for c in comm_team)
     members = set(c["login"] for c in members)
@@ -96,11 +104,13 @@ def get_contributors():
     ]
     comm_team = [get_profile(login) for login in comm_team]
     emeritus_comm_team = [get_profile(login) for login in emeritus_comm_team]
+    documentation_team = [get_profile(login) for login in documentation_team]
 
     # sort by last name
     core_devs = sorted(core_devs, key=key)
     emeritus = sorted(emeritus, key=key)
     contributor_experience_team = sorted(contributor_experience_team, key=key)
+    documentation_team = sorted(documentation_team, key=key)
     comm_team = sorted(comm_team, key=key)
     emeritus_comm_team = sorted(emeritus_comm_team, key=key)
 
@@ -110,6 +120,7 @@ def get_contributors():
         contributor_experience_team,
         comm_team,
         emeritus_comm_team,
+        documentation_team,
     )
 
 
@@ -179,6 +190,7 @@ def generate_list(contributors):
         contributor_experience_team,
         comm_team,
         emeritus_comm_team,
+        documentation_team,
     ) = get_contributors()
 
     with open(REPO_FOLDER / "doc" / "authors.rst", "w+", encoding="utf-8") as rst_file:
@@ -203,3 +215,8 @@ def generate_list(contributors):
         REPO_FOLDER / "doc" / "communication_team_emeritus.rst", "w+", encoding="utf-8"
     ) as rst_file:
         rst_file.write(generate_list(emeritus_comm_team))
+
+    with open(
+        REPO_FOLDER / "doc" / "documentation_team.rst", "w+", encoding="utf-8"
+    ) as rst_file:
+        rst_file.write(generate_table(documentation_team))
diff --git a/doc/about.rst b/doc/about.rst
@@ -39,6 +39,13 @@ in the FAQ.
 
    :ref:`How you can contribute to the project <contributing>`
 
+Documentation Team
+------------------
+
+The following people help with documenting the project:
+
+.. include:: documentation_team.rst
+
 Contributor Experience Team
 ---------------------------
 

diff --git a/doc/documentation_team.rst b/doc/documentation_team.rst
@@ -0,0 +1,16 @@
+.. raw :: html
+
+    <!-- Generated by generate_authors_table.py -->
+    <div class="sk-authors-container">
+    <style>
+      img.avatar {border-radius: 10px;}
+    </style>
+    <div>
+    <a href='https://github.com/ArturoAmorQ'><img src='https://avatars.githubusercontent.com/u/86408019?v=4' class='avatar' /></a> <br />
+    <p>Arturo Amor</p>
+    </div>
+    <div>
+    <a href='https://github.com/lucyleeow'><img src='https://avatars.githubusercontent.com/u/23182829?v=4' class='avatar' /></a> <br />
+    <p>Lucy Liu</p>
+    </div>
+    </div>
diff --git a/doc/governance.rst b/doc/governance.rst
@@ -86,6 +86,17 @@ For this, they can operate the scikit-learn accounts on various social networks
 and produce materials. They also have the required rights to our blog
 repository and other relevant accounts and platforms.
 
+Documentation team
+~~~~~~~~~~~~~~~~~~
+
+Members of the documentation team engage with the documentation of the project
+among other things. They might also be involved in other aspects of the
+project, but their reviews on documentation contributions are considered
+authoritative, and can merge such contributions.
+
+To this end, they have permissions to merge pull requests in scikit-learn's
+repository.
+
 Maintainers
 ~~~~~~~~~~~