Python Documentation Editorial Board

This repo contains activity updates, process, and planning information for the Python Documentation Editorial Board.

See PEP 732.

Changelog

We have a "changelog" of decisions: CHANGELOG.md.

Updates

These updates provide high level information about the Editorial Board's activities:

• 2024-01

Process

The Editorial Board's private meetings are monthly on the second Monday at 1:30pm Pacific.

If you have a general request or question, please use the Documentation category in Discourse.

If you need Editorial Board assistance, please file an issue on this repo.

Reference

These links give context on the editorial board:

• PEP 732
• PEP 732 Discourse discussion
• Language Summit 2021 presentation
• Language Summit 2020 presentation

These links give context on existing documentation landing pages:

• CPython Documentation Landing page (docs.python.org)
• PSF (python.org) website landing page
• Documentation Experience presentation - Review navigation of PSF website related to docs

Writing new content

Hugo is not needed to be installed in order to write a new meeting minutes.

Write the meeting minutes a markdown file under content/updates/*.md, commit, and create the pull request. A preview will then be generated on Netlify.

The meeting minutes should be written using template provided in archetypes/updates.md.

If you have Hugo installed, a new meeting minutes file can be created by typing on the command line:

hugo new content content/updates/newupdate.md

This will create the file under content/updates/newupdate.md, and you can continue editing it.

(replace "newupdate.md" with the desired filename.)

Updating the Meeting Attendee List

The list of attendees is pulled from the "members" field in the frontmatter. By default, it lists all members of the Python Docs Editorial Board. If a member did not attend the meeting, remove from this list.

Building the static site locally

1. First install Hugo.

2. Run the command at the root of the repository:

hugo server

Writing new changelog

Use the template in archetypes/changelog.md.

The file can also be created using the command:

hugo new content content/changelog/newchangelog.md

It will create a new file under content/changelog/newchangelog.md. (Replace "newchangelog.md" with the desired filename).