Documentation Community Team Meeting (August 2022)#

  • Date: 2022-08-01

  • Time: [21:00 UTC]

  • This HackMD: https://hackmd.io/@encukou/pydocswg1

  • Discourse thread: https://discuss.python.org/t/documentation-community-meeting-august-1/17847

  • Calendar for future meetings: (send your e-mail to Mariatta for a calendar invitation)

  • How to participate:

By participating in this meeting, you are agreeing to abide by and uphold the PSF Code of Conduct. Please take a second to read through it!

Roll call#

  • Mariatta / @Mariatta

  • Petr Viktorin / @encukou

  • Hugo van Kemenade / @hugovk

  • Ned Batchelder / @nedbat

  • Ezio Melotti / @ezio-melotti

  • CAM Gerlach / @CAM-Gerlach

  • Jim DeLaHunt / @JDLH

  • Daniele Procida

  • Pradyun Gedam

  • Erlend Aasland / @erlend-aasland

Discussion#

How to edit HackMD doc?#

  • Log in (with GitHub or something)

  • Then use the pencil button at the top of the page

Diataxis Workshop#

  • 70 ppl signed up, ~35 are accepted.

  • Could let a few more ppl in, but it’s probably best to repeat sometime later.

  • Thanks Mariatta, Ned & CAM.

New Python Docs theme#

  • Pradyun talks about Lutra, a new theme for “big” docs. (Pradyun’s existing theme, Furo, is for “smaller docs” – it puts everything in the sidebar)

    • Can we see the sample?

    • https://pradyunsg-cpython-lutra-testing.readthedocs.io/en/latest/

    • CAM: How’s this different from Furo?

        1. Didn’t want to do too many things with Furo – it does what it does well

        1. Freedom from backwards compatibility concerns

    • Mariatta: Can it handle CPython docs build process?

      • Pradyun is looking into the docs-build script

    • Daniele: You showed us two different modes of Lutra

      • Pradyun: there are 5 modes. Configured in conf.py

    • Ned: the different modes seem complicated, when Python docs will use just one mode

    • Pradyun: I imagine python-docs-theme will customize this further, e.g. use the python.org header

    • Daniele: furo works for smaller sites, but its navigation model is powerful, allowing the user to internalize the information architecture. In Lutra’s mode, which one also prioritize docs architecture within its navigation model?

      • Pradyun: all of them, just exposed in slightly different ways.

    • CAM: Enabling and following a model that more closely matches the existing structure of the Python Docs (at least initially), even if it isn’t ideal, is important for ensuring acceptance of the new theme and reducing friction to an acceptable level given how much this is already changing.

    • Ned: what’s the plan here? Pradyun will write a doc, etc

      • Pradyun: working on it, hopefully this weekend

    • Petr: Who will write a PEP?

    • Ned: Why do we need a PEP?

    • Daniele: when it comes to adopting diataxis, but it’s a decision that should be taken after the workshops. After the workshops people will have clearer idea and implications of what it will mean for the docs. If there is a strong consensus, that’s when we should work that decision into a PEP. It needs to be really understood by the people making small changes. The PEP of styling is the same.

    • Petr: Diataxis is more about direction, should be more of a Discourse discussion other than a PEP

    • Ned: How much decision-making we need ahead of time before starting working with Diataxis.

    • Petr: the purpose of the PEP is to make sure you consider everything about the problem, make sure everybody that should be heard is heard, make sure everything is documented. If you can get to that goal some other way, then we don’t need a PEP.

    • Daniele: it’s like a deciding: Are we going to climb up that mountain? Which mountain? Once we decided on which mountain, we better make sure we’re equipped for that, we don’t need all the plans, but still need agreement.

    • Ned: What are we writing in this PEP? It can be just one paragraph, or 10 pages.

    • Petr: There is a PEP template (PEP 12).

    • Ned: How is a PEP … ?

    • Daniele: We need to have a clear picture of where we want to go.

    • Petr: let’s leave this for after the workshop

    • Pradyun: PEP is our tool for consensus building.

    • Hugo: With PEP 676: work was done ahead before the PEP, and we didn’t really know who was going to make the decision of it, and after the PEP there was more clarity of who makes the decision.

    • CAM: a PEP can be design docs or detailed plan, but can also be a rationale.

    • Pradyun: We don’t want to put in process that makes it more diffcult for people to contribute.

Next meeting#

The docs team meets on the first Monday of every month.

We have a recurring Google Calendar event for the meeting. Let Mariatta know your email address and she can invite you.