8000 GOV add a documentation team (#26714) · scikit-learn/scikit-learn@e4fd1f4 · GitHub
[go: up one dir, main page]
Skip to content

Commit e4fd1f4

Browse files
adrinjalalijeremiedbb
adrinjalali
authored and
jeremiedbb
committed
GOV add a documentation team (#26714)
1 parent 7286da0 commit e4fd1f4

File tree

4 files changed

+53
-2
lines changed

4 files changed

+53
-2
lines changed

‎build_tools/generate_authors_table.py

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,17 +43,24 @@ def get_contributors():
4343
"""Get the list of contributor profiles. Require admin rights."""
4444
# get core devs and contributor experience team
4545
core_devs = []
46+
documentation_team = []
4647
contributor_experience_team = []
4748
comm_team = []
4849
core_devs_slug = "core-devs"
4950
contributor_experience_team_slug = "contributor-experience-team"
5051
comm_team_slug = "communication-team"
52+
documentation_team_slug = "documentation-team"
5153

5254
entry_point = "https://api.github.com/orgs/scikit-learn/"
5355

5456
for team_slug, lst in zip(
55-
(core_devs_slug, contributor_experience_team_slug, comm_team_slug),
56-
(core_devs, contributor_experience_team, comm_team),
57+
(
58+
core_devs_slug,
59+
contributor_experience_team_slug,
60+
comm_team_slug,
61+
documentation_team_slug,
62+
),
63+
(core_devs, contributor_experience_team, comm_team, documentation_team),
5764
):
5865
for page in [1, 2]: # 30 per page
5966
reply = get(f"{entry_point}teams/{team_slug}/members?page={page}")
@@ -67,6 +74,7 @@ def get_contributors():
6774

6875
# keep only the logins
6976
core_devs = set(c["login"] for c in core_devs)
77+
documentation_team = set(c["login"] for c in documentation_team)
7078
contributor_experience_team = set(c["login"] for c in contributor_experience_team)
7179
comm_team = set(c["login"] for c in comm_team)
7280
members = set(c["login"] for c in members)
@@ -96,11 +104,13 @@ def get_contributors():
96104
]
97105
comm_team = [get_profile(login) for login in comm_team]
98106
emeritus_comm_team = [get_profile(login) for login in emeritus_comm_team]
107+
documentation_team = [get_profile(login) for login in documentation_team]
99108

100109
# sort by last name
101110
core_devs = sorted(core_devs, key=key)
102111
emeritus = sorted(emeritus, key=key)
103112
contributor_experience_team = sorted(contributor_experience_team, key=key)
113+
documentation_team = sorted(documentation_team, key=key)
104114
comm_team = sorted(comm_team, key=key)
105115
emeritus_comm_team = sorted(emeritus_comm_team, key=key)
106116

@@ -110,6 +120,7 @@ def get_contributors():
110120
contributor_experience_team,
111121
comm_team,
112122
emeritus_comm_team,
123+
documentation_team,
113124
)
114125

115126

@@ -179,6 +190,7 @@ def generate_list(contributors):
179190
contributor_experience_team,
180191
comm_team,
181192
emeritus_comm_team,
193+
documentation_team,
182194
) = get_contributors()
183195

184196
with open(REPO_FOLDER / "doc" / "authors.rst", "w+", encoding="utf-8") as rst_file:
@@ -203,3 +215,8 @@ def generate_list(contributors):
203215
REPO_FOLDER / "doc" / "communication_team_emeritus.rst", "w+", encoding="utf-8"
204216
) as rst_file:
205217
rst_file.write(generate_list(emeritus_comm_team))
218+
219+
with open(
220+
REPO_FOLDER / "doc" / "documentation_team.rst", "w+", encoding="utf-8"
221+
) as rst_file:
222+
rst_file.write(generate_table(documentation_team))

‎doc/about.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,13 @@ in the FAQ.
3939

4040
:ref:`How you can contribute to the project <contributing>`
4141

42+
Documentation Team
43+
------------------
44+
45+
The following people help with documenting the project:
46+
47+
.. include:: documentation_team.rst
48+
4249
Contributor Experience Team
4350
---------------------------
4451

‎doc/documentation_team.rst

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
.. raw :: html
2+
3+
<!-- Generated by generate_authors_table.py -->
4+
<div class="sk-authors-container">
5+
<style>
6+
img.avatar {border-radius: 10px;}
7+
</style>
8+
<div>
9+
<a href='https://github.com/ArturoAmorQ'><img src='https://avatars.githubusercontent.com/u/86408019?v=4' class='avatar' /></a> <br />
10+
<p>Arturo Amor</p>
11+
</div>
12+
<div>
13+
<a href='https://github.com/lucyleeow'><img src='https://avatars.githubusercontent.com/u/23182829?v=4' class='avatar' /></a> <br />
14+
<p>Lucy Liu</p>
15+
</div>
16+
</div>

‎doc/governance.rst

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -86,6 +86,17 @@ For this, they can operate the scikit-learn accounts on various social networks
8686
and produce materials. They also have the required rights to our blog
8787
repository and other relevant accounts and platforms.
8888

89+
Documentation team
90+
~~~~~~~~~~~~~~~~~~
91+
92+
Members of the documentation team engage with the documentation of the project
93+
among other things. They might also be involved in other aspects of the
94+
project, but their reviews on documentation contributions are considered
95+
authoritative, and can merge such contributions.
96+
97+
To this end, they have permissions to merge pull requests in scikit-learn's
98+
repository.
99+
89100
Maintainers
90101
~~~~~~~~~~~
91102

0 commit comments

Comments
 (0)
0