search

whatwg / sg

A place to raise issues with the WHATWG Steering Group
https://whatwg.org/policies
Other
64 stars 39 forks source link

Centralize truth #111

Closed annevk closed 4 years ago

annevk commented 4 years ago

See whatwg/meta#57 and #75.

whatwg/whatwg.org#303 is the corresponding change to whatwg.org to generate documents from the new JSON database.

annevk commented 4 years ago

One thing that would be good to add is sorting of everything that is a list.

annevk commented 4 years ago

@whatwg/sg I forgot to ping you all, but this is ready for review now. https://github.com/whatwg/whatwg.org/pull/303 is the corresponding change that ensures the new db.json is the source of truth for all our "list of things" on various whatwg.org pages. We also want to use it for participate.whatwg.org and potentially for other services (about time to get the Twitter bots back up) in the future.

This will make it easier to add new Workstreams and other things and be somewhat confident everything is updated as needed.

annevk commented 4 years ago

Thanks, I addressed those comments and also added list sorting which caught one thing that wasn't sorted. I could also address the remaining nits, including those from @domenic if desired, but not all seem in scope / worth doing to me so I'd need some additional encouragement.

othermaciej commented 4 years ago

We discussed this issue in an SG call. We'd like to see what the generated workstreams page will look like.

annevk commented 4 years ago

Sure thing, https://html5.org/temp/workstreams.html is the (current) output. It would be hosted at https://whatwg.org/workstreams.

foolip commented 4 years ago

@whatwg/sg if two more of us can review this, we can go ahead and merge.

(We decided in https://github.com/whatwg/sg/issues/117 that for editorial changes one approval is enough, and that for things that change policy (which this touches) we'll use the supermajority, so 3 approvals.)

othermaciej commented 4 years ago

OK, two comments after seeing the generated output.

(1) Can we change the output to be formatted more like Workstreams.md? The new format is needlessly less compact, so only fits 3 Workstream descriptions in the space of 4 in the .md format, the indents seem unnecessary (particularly so the multiple levels of indents) and the lack of distinctive font weight makes it harder to scan for headings.

(2) Where does the intro text on the generated workstreams page come from? I presume not from Workstreams.md any more, since that whole file gets deleted in this PR. If it's hardcoded in the generation script, that's probably not good. If it's a separate file now in the whatwg.org website repo, that would be better, but ideally the SG should have the ability to update that intro text if it ever seems useful to do so. Could we instead keep the source of the intro in this repo?

annevk commented 4 years ago

@domenic adjusted styling somewhat so https://html5.org/temp/workstreams.html is now shorter. I created Workstreams Introduction.md so you can still edit the introduction here. Hopefully all is well now.

dbaron commented 4 years ago

Looks good to me as well -- thanks for getting this done.