-
-
Notifications
You must be signed in to change notification settings - Fork 26
README: Rename Working Group to Editorial Board #99
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
Conversation
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. |
There was a problem hiding this comment.
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. :-)
There was a problem hiding this comment.
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 🙃 )
There was a problem hiding this comment.
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)
- Referred to as the Documentation Community or docs-community (to minimize confusion we will stop referring to this as a Working Group
- Repo (this repo): https://github.com/python/docs-community
- Editorial Board (Approved in 2023 by Steering Council and described in PEP 732)
- Referred to as Editorial Board or EB
- Repo: https://github.com/python/editorial-board
There was a problem hiding this comment.
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 😉
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Something like this?
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

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?
for more information, see https://pre-commit.ci
There was a problem hiding this 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
Following PEP 732, rename WG to EB on the README.
📚 Documentation preview 📚: https://docs-community--99.org.readthedocs.build/en/99/