Skip to content

Conversation

hugovk
Copy link
Member

@hugovk hugovk commented Jan 24, 2024

Following PEP 732, rename WG to EB on the README.


📚 Documentation preview 📚: https://docs-community--99.org.readthedocs.build/en/99/

README.md Outdated
This repo serves as documentation for the Docs WG, which is funny, in a recursive kind of way.
This repo serves as documentation for the Docs EB, which is funny, in a recursive kind of way.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hm. The EB has its own repo (https://github.com/python/editorial-board) already, so we should probably say something here about how we expect to use the two separate repos.

@willingc may be able to say it better than me; my intuition tells me that it's something about governance vs. execution but I would need help turning that into a useful parapgraph.

(Also, I recommend removing the "which is funny, ..." part-- it's not that funny, and people who are tickled by that sort of stuff don't need to be told that it is. :-)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also isn't the EB supposed to be a subset -- not a replacement -- of the WG?

My understanding is that the WG still exists unchanged and this is the repo for the WG, and now there's also the EB (which is part of the WG) with its own separate repo.

(Also the fact that you are suggesting to remove "which is funny, ..." is funny, in a recursive kind of way 🙃 )

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@hugovk Maybe something like this may clear this up:

  • Add the image referenced by @ezio-melotti
  • Users of Python Documentation
  • Documentation Community Group (Working Group created in 2021 by the Python Steering Council)
  • Editorial Board (Approved in 2023 by Steering Council and described in PEP 732)

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah and I would remove the "which is funny". Although it is Ezio, I think we should lean into communicating to folks that will not get the reference 😉

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Something like this?

08829ea

We'll have to do something about the SVG's transparent background, because it doesn't show up in dark mode: https://github.com/python/docs-community/blob/08829ea88be291b9d99a5f1bea6a1747cec5cc95/README.md

image

The PEPs site adds a CSS class to invert it, we can't do that in a README. Maybe just set the background to solid white here?

Copy link
Collaborator

@willingc willingc left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @hugovk for the update

@willingc willingc merged commit 599ed08 into python:main Jan 29, 2024
@hugovk hugovk deleted the readme-wg-to-eb branch January 29, 2024 21:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants