-
-
Notifications
You must be signed in to change notification settings - Fork 1.7k
PEP 732: The Python Documentation Editorial Board #3489
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
Merged
Merged
Changes from 6 commits
Commits
Show all changes
16 commits
Select commit
Hold shift + click to select a range
862ea59
Create pep-NNNN.rst
jablonskidev 25f36b6
Add venn diagram
jablonskidev c7e22b8
Move to pep-0732 and fix creation date in the future
gvanrossum 71f09de
Fix image reference
gvanrossum c9cf8bf
Merge pull request #1 from gvanrossum/pep-732
jablonskidev ce307c1
Changed date and spelling
jablonskidev 61fdba0
Update peps/pep-0732.rst
jablonskidev 5912723
Update peps/pep-0732.rst
jablonskidev d52c110
Update peps/pep-0732.rst
jablonskidev 9416ecf
Update peps/pep-0732.rst
jablonskidev 2b771f1
Update peps/pep-0732.rst
jablonskidev dae7345
Add Mariatta for PEP 732
jablonskidev 530e55d
Move image file and update reference in rst
jablonskidev 978f5f7
Merge branch 'main' into main
Mariatta ddd3400
Update peps/pep-0732.rst
jablonskidev aa02e37
Add prefix to filename and update rst
jablonskidev File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,163 @@ | ||
| PEP: 732 | ||
| Title: The Python Documentation Editorial Board | ||
| Author: Joanna Jablonski | ||
| Sponsor: Mariatta Wijaya | ||
| Status: Draft | ||
| Type: Process | ||
| Topic: Governance | ||
| Content-Type: text/x-rst | ||
| Created: 14-Oct-2023 | ||
|
|
||
|
|
||
| Abstract | ||
| ======== | ||
|
|
||
| This PEP: | ||
|
|
||
| * Establishes the Python Documentation Editorial Board | ||
| * Proposes how the editorial board will work | ||
|
|
||
| Motivation | ||
| ========== | ||
|
|
||
| The Steering Council approved the creation of a | ||
| `Documentation Working Group <https://github.com/python/docs-community/blame/main/docs/workgroup/workgroup_charter.rst>`_ | ||
| in March 2021. | ||
|
|
||
| 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: | ||
|
|
||
| .. image:: pep-0732/docs-pep-concentric.drawio.svg | ||
jablonskidev marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
|
|
||
| Specification | ||
| ============= | ||
|
|
||
| Mandate | ||
| ------- | ||
|
|
||
| The editorial board will: | ||
|
|
||
| * Ensure processes are in place to maintain and improve the quality of Python's documentation | ||
| * Foster Python documentation as a community resource to serve the current and future users | ||
| * Act in alignment with the `Python Software Foundation mission <https://www.python.org/psf/mission/#:~:text=The%20mission%20of%20the%20Python,donation%20or%20becoming%20a%20member.>`_, which is to advance the Python programming language, and to support and facilitate the growth of a diverse and international community of Python programmers | ||
jablonskidev marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| * Ensure that contributing to documentation is accessible, inclusive, and sustainable | ||
| * Establish appropriate decision-making processes for documentation content | ||
| * Seek to achieve consensus among contributors prior to making decisions | ||
| * Be the final arbiter for documentation content decisions | ||
|
|
||
| Responsiblities | ||
| --------------- | ||
|
|
||
| The board has authority to make decisions about Python’s | ||
| documentation, as scoped below. For example, it can: | ||
|
|
||
| * Set big-picture strategy for Python’s documentation | ||
| * Set the intended structure for documentation | ||
| * Make style and editorial decisions for both writing and design | ||
| * Handle documentation governance (for example, delegation of decision-making to subject-matter experts, resolution of disagreements, decisions.) | ||
jablonskidev marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| Scope | ||
| ----- | ||
|
|
||
| The Editorial board oversees the content and strategy for the following: | ||
|
|
||
| .. list-table:: | ||
| :widths: 50 50 | ||
| :header-rows: 1 | ||
|
|
||
| * - 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 | ||
|
|
||
| Composition | ||
| ~~~~~~~~~~~ | ||
|
|
||
| The Python Documentation Editorial Board is composed of five members. | ||
|
|
||
| Editorial Board Members | ||
| ~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| The initial Editorial Board members are: | ||
|
|
||
| * Mariatta Wijaya | ||
| * Ned Batchelder | ||
| * Joanna Jablonski | ||
| * Guido van Rossum | ||
| * Carol Willing | ||
|
|
||
| Editorial Board Member Qualifications | ||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | ||
|
|
||
| Editorial board members should have: | ||
|
|
||
| * A good grasp of the philosophy of the Python project | ||
| * A background in Python education and developer-facing documentation | ||
| * A solid track record of being constructive and helpful | ||
| * A history of making significant contributions to Python | ||
| * A willingness to dedicate time to improving Python's docs | ||
|
|
||
| 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. | ||
|
|
||
| Copyright | ||
| ========= | ||
|
|
||
| This document has been placed in the public domain or under the | ||
| CC0-1.0-Universal license, whichever is more permissive. | ||
jablonskidev marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.