DOC first draft on the comms team(#21287)

* DOC: first draft on the comms * Extend table generation script to add the Communication team Co-authored-By: Adrin Jalali <[email protected]> Co-authored-by: Roman Yurchak <[email protected]> * DOC Update communication team details * Add Lauren Burke to the communication team Co-authored-by: Julien Jerphanion <[email protected]> Co-authored-by: Adrin Jalali <[email protected]> Co-authored-by: Roman Yurchak <[email protected]>
scikit-learn · Nov 18, 2021 · 26ed0a2 · 26ed0a2
1 parent 3f717cc
commit 26ed0a2
Show file tree

Hide file tree

Showing 4 changed files with 59 additions and 3 deletions.
diff --git a/build_tools/generate_authors_table.py b/build_tools/generate_authors_table.py
@@ -43,7 +43,14 @@ def get_contributors():
     # get core devs and triage team
     core_devs = []
     triage_team = []
-    for team_id, lst in zip((11523, 3593183), (core_devs, triage_team)):
+    comm_team = []
+    core_devs_id = 11523
+    triage_team_id = 3593183
+    comm_team_id = 5368696
+    for team_id, lst in zip(
+        (core_devs_id, triage_team_id, comm_team_id),
+        (core_devs, triage_team, comm_team),
+    ):
         for page in [1, 2]:  # 30 per page
             reply = get(f"https://api.github.com/teams/{team_id}/members?page={page}")
             lst.extend(reply.json())
@@ -59,6 +66,7 @@ def get_contributors():
     # keep only the logins
     core_devs = set(c["login"] for c in core_devs)
     triage_team = set(c["login"] for c in triage_team)
+    comm_team = set(c["login"] for c in comm_team)
     members = set(c["login"] for c in members)
 
     # add missing contributors with GitHub accounts
@@ -75,13 +83,15 @@ def get_contributors():
     core_devs = [get_profile(login) for login in core_devs]
     emeritus = [get_profile(login) for login in emeritus]
     triage_team = [get_profile(login) for login in triage_team]
+    comm_team = [get_profile(login) for login in comm_team]
 
     # sort by last name
     core_devs = sorted(core_devs, key=key)
     emeritus = sorted(emeritus, key=key)
     triage_team = sorted(triage_team, key=key)
+    comm_team = sorted(comm_team, key=key)
 
-    return core_devs, emeritus, triage_team
+    return core_devs, emeritus, triage_team, comm_team
 
 
 def get_profile(login):
@@ -145,7 +155,7 @@ def generate_list(contributors):
 
 if __name__ == "__main__":
 
-    core_devs, emeritus, triage_team = get_contributors()
+    core_devs, emeritus, triage_team, comm_team = get_contributors()
 
     with open(REPO_FOLDER / "doc" / "authors.rst", "w+") as rst_file:
         rst_file.write(generate_table(core_devs))
@@ -155,3 +165,6 @@ def generate_list(contributors):
 
     with open(REPO_FOLDER / "doc" / "triage_team.rst", "w+") as rst_file:
         rst_file.write(generate_table(triage_team))
+
+    with open(REPO_FOLDER / "doc" / "communication_team.rst", "w+") as rst_file:
+        rst_file.write(generate_table(comm_team))
diff --git a/doc/about.rst b/doc/about.rst
@@ -18,6 +18,7 @@ been leading the development.
 
 Governance
 ----------
+
 The decision making process and governance structure of scikit-learn is laid
 out in the :ref:`governance document <governance>`.
 
@@ -47,6 +48,15 @@ maintenance:
 
 .. include:: triage_team.rst
 
+Communication Team
+------------------
+
+The following people help with :ref:`communication around scikit-learn
+<communication_team>`.
+
+.. include:: communication_team.rst
+
+
 Emeritus Core Developers
 ------------------------
 

diff --git a/doc/communication_team.rst b/doc/communication_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/reshamas'><img src='https://avatars.githubusercontent.com/u/2507232?v=4' class='avatar' /></a> <br />
+    <p>Reshama Shaikh</p>
+    </div>
+    <div>
+    <a href='https://github.com/laurburke'><img src='https://avatars.githubusercontent.com/u/35973528?v=4' class='avatar' /></a> <br />
+    <p>Lauren Burke</p>
+    </div>
+    </div>
diff --git a/doc/governance.rst b/doc/governance.rst
@@ -48,8 +48,25 @@ Every new triager will be announced in the mailing list.
 Triagers are welcome to participate in `monthly core developer meetings
 <https://github.com/scikit-learn/administrative/tree/master/meeting_notes>`_.
 
+.. _communication_team:
+
+Communication team
+-------------------
+
+Members of the communication team help with outreach and communication
+for scikit-learn. The goal of the team is to develop public awareness of
+scikit-learn, of its features and usage, as well as branding.
+
+For this, they can operate the scikit-learn accounts on various social
+networks and produce materials.
+
+Every new communicator will be announced in the mailing list.
+Communicators are welcome to participate in `monthly core developer meetings
+<https://github.com/scikit-learn/administrative/tree/master/meeting_notes>`_.
+
 Core developers
 ---------------
+
 Core developers are community members who have shown that they are dedicated to
 the continued development of the project through ongoing engagement with the
 community. They have shown they can be trusted to maintain scikit-learn with