← 返回首页
PEP 732 – The Python Documentation Editorial Board | peps.python.org Following system colour scheme Selected dark colour scheme Selected light colour scheme

Python Enhancement Proposals

Toggle light / dark / auto colour theme PEP 732 – The Python Documentation Editorial Board

PEP 732 – The Python Documentation Editorial Board

Author: Joanna Jablonski Sponsor: Mariatta Wijaya Discussions-To: Discourse thread Status: Active Type: Process Topic: Governance Created: 14-Oct-2023 Post-History: 20-Oct-2023 Resolution: Discourse message Table of Contents

Abstract

This PEP:

Motivation

The Steering Council approved the creation of a Documentation Working Group in March 2021 to set direction for the docs. This group is now called the Editorial Board to differentiate it from the Documentation Working Group that was created since then to focus on more tactical work.

The purpose of the Python documentation is to serve the present and future end users of Python. As such, the core development community and the greater Python documentation contributors work together to achieve this:

Specification

Mandate

The editorial board will:

Responsibilities

The board has authority to make decisions about Python’s documentation, as scoped below. For example, it can:

Scope

The Editorial board oversees the content and strategy for the following:

In scope Not in scope
CPython documentation (docs.python.org) Code comments in CPython codebase
CPython devguide (devguide.python.org) CPython docstrings
Translations of CPython docs PEPs (peps.python.org)
PyPA documentation
www.python.org
The Python Wiki (wiki.python.org)

Composition

The Python Documentation Editorial Board is composed of five members.

Editorial Board Members

The initial Editorial Board members are:

Editorial Board Member Qualifications

Editorial board members should have:

Members of the Editorial Board should have experience in education, communication, technical writing, Python’s documentation, accessibility, translation, or community management.

Term

Editorial Board members serve for an indefinite term, though it is generally expected that there will be changes in Editorial Board composition each year. Editorial Board members will confirm annually whether they wish to continue as a board member. Members may resign at any time.

If a board member drops out of touch and cannot be contacted for a month or longer, then the rest of the board may vote to replace them.

Changes to the Editorial Board’s Size

Annually after each major Python release, the Editorial Board will review whether the board’s size should change. This provides flexibility if the needs of the documentation community change over time. A simple majority is needed to make a decision to increase the board’s size where quorum is 80% of the current board.

As the sponsoring organization of the Documentation Editorial Board, the Steering Council may change the number of members of the Board at any time, including appointing new members or dismissing existing members.

Vacancies

If a vacancy exists on the board for any reason, the Documentation Editorial Board will publicly announce a call for prospective board members. Prospective board members would submit a brief document stating qualifications and their motivation to serve. The sitting members of the Editorial Board will select new board members by a simple majority where quorum is 80% of the current board.

Amendments

This PEP serves as a charter for the Docs Editorial Board. Changes to its operation can be made either through a new PEP or through a change to this PEP. In either case, the change would be decided upon by the Steering Council after discussion in the community.

PEP Acceptance

PEP 732 was accepted by the Python Steering Council on December 11, 2023.

The Steering Council commented that, while they don’t disagree with the scoping set out in the PEP, it would probably make sense for the Editorial Board to consider expanding the scope to include docstrings in the standard library, once the Board is sufficiently established and the higher priorities have been taken care of.

Contact

To ask the Editorial Board for a decision, community members may open an issue in the python/editorial-board repository.

Copyright

This document is placed in the public domain or under the CC0-1.0-Universal license, whichever is more permissive.

Contents


Page Source (GitHub)

Source: https://github.com/python/peps/blob/main/peps/pep-0732.rst

Last modified: 2025-02-01 07:28:42 UTC