search

python / docs-community

Community management for documentation contributors and the Docs Workgroup
https://docs-community.readthedocs.io/en/latest/
Creative Commons Zero v1.0 Universal
45 stars 25 forks source link

Update how minutes archive is displayed #137

Closed StanFromIreland closed 5 days ago

StanFromIreland commented 5 days ago

I was reading the minutes when and the layout is quite weird. Usually such things are in reverse chronological order as the more recent minutes are much more relevant. I have added some html that displays all the minutes (Why were some hidden?) In a grid similar to that of the Python Boards Minutes archive.

image

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

hugovk commented 5 days ago

Why were some hidden?

Done in https://github.com/python/docs-community/pull/116 to unclutter the homepage.

If we have a table, I don't want to have to manually edit HTML by hand each month, so could we hook up something like https://github.com/nedbat/cog to generate an HTML or RST table with something like https://github.com/prettytable/prettytable?

See also https://github.com/python/steering-council/blob/main/Makefile and https://github.com/python/steering-council/blob/76edc79468908cd6df4f80f5705978f0f4a9be21/README.md?plain=1#L31 for how Cog is used for a similar task.

And please could you move the typo fixes to another PR? We can merge that quickly.

StanFromIreland commented 5 days ago

@hugovk

There is no need to edit the html? It links to the auto built html files from the markdown files. Adding new files remains the same you just have to link to the built version which is html.

hugovk commented 5 days ago

I mean we'd need to edit this bit when adding a new month?

https://github.com/StanFromIreland/docs-community/blob/6c8c75827c6d4c2585c39a3cb818b6e3ca24779d/docs/monthly-meeting/index.rst?plain=1#L51

True, we have to edit this bit right now:

https://github.com/python/docs-community/blob/6d05d4f6dfa5b0cf20d82fdd0182b84b7cd505d2/docs/monthly-meeting/index.rst?plain=1#L29

HTML is a little bit more fiddly. If changing it, now would be a nice time to add some automation.

StanFromIreland commented 5 days ago

I guess we could add some automation but I'm not really sure how to go about that or what exactly it is we want? It will just be the same as before, adding one line every month.

I could simply add the next few entries as comments and we will just uncomment them as they are needed?

StanFromIreland commented 5 days ago

Closing to split PRs into the display and the typos