search

whatwg / sg

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

Add Stages policy #227

Closed cwilso closed 7 months ago

cwilso commented 8 months ago

(This includes changes from previous PR https://github.com/whatwg/sg/pull/222.)

cwilso commented 7 months ago
  • Cross-document links should be done as we do in other Markdown documents. The idea is that you can click around the Markdown documents and essentially stay in that "unpublished universe".

Done in https://github.com/whatwg/sg/pull/227/commits/97f07c14fe808db86ffda2a22fa163dc6cf78bfb.

  • Terms like Contribution and Contributor need to be linked, as they are in other Markdown documents.

Done in https://github.com/whatwg/sg/pull/227/commits/8d24ac275f61c3a4cedc2ce45e1125a5a2250e73, https://github.com/whatwg/sg/pull/227/commits/b2b46b7bcc2c36f05d80de89ce0be860472b4351, https://github.com/whatwg/sg/pull/227/commits/580c0838a3df5c73116dcd8bce566b599efc643d, https://github.com/whatwg/sg/pull/227/commits/7dac6951f60543ec0d74bbfcc9c66929d2cc36a9.

  • Please search for ". " (two spaces) and replace with ". " (single space).

Done in https://github.com/whatwg/sg/pull/227/commits/96f035231d9984138693c84b361b951b133ca4e9.

  • There's still quite a few occurrences of "feature" or "proposal" that should be "Contribution". And similar for "Contributor"-like terms. Generally the less unique terms we use the better.

Fixed in https://github.com/whatwg/sg/pull/227/commits/a525b11076293334bc9a96614db2adfc310b814b, https://github.com/whatwg/sg/pull/227/commits/38523d048c8a61e0b7f4b10c3b6ff5218ee0f5fb, and https://github.com/whatwg/sg/pull/227/commits/37ffba494b35898c948a2839ddd195124c523b98.

Note there are still some intentional occurrences of "feature" and "proposal", when they are not specifically referring to the Contribution.

cwilso commented 7 months ago

Anne, you are more than welcome to take a pass at this directly if you would prefer. Given your comment at last week's WHATNOT meeting, I'm going to go ahead and merge this soon, and we can further iterate if necessary.

annevk commented 7 months ago

@cwilso I'd like to be the one merging this unless you take responsibility for rolling it out on whatwg.org. I ran convert_policy.py myself and ran into an error, so I suspect you haven't actually tried that. (Thankfully the table seems to work fine.)

Please take a look at the changes I pushed.

annevk commented 7 months ago

I think we might need some kind of styling for the table actually. https://html5.org/temp/whatwg-stages.html looks pretty awful.

Minimally something like

table { border-collapse: collapse }
table td { vertical-align: top; }
table tr:nth-child(even), table thead tr { background: rgb(250, 250, 250); }

@domenic @zcorpan any thoughts on that?

I've put up https://github.com/whatwg/whatwg.org/pull/436 for this.

zcorpan commented 7 months ago

Agreed more styling is needed, and I think some borders and padding aids readability further. On a narrow screen, the table overflows to the right, so setting a white background color is good.

table { border-collapse: collapse; background-color: white; }
table td { vertical-align: top; }
table td, table th { border: 1px solid #aaa; padding: 0.5em; }
table tr:nth-child(even), table thead tr { background: rgb(250, 250, 250); }
table td > :first-child { margin-top: 0; }
table td > :last-child { margin-bottom: 0; }