Skip to content
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

Add Stages policy #227

Merged
merged 41 commits into from
Mar 4, 2024
Merged

Add Stages policy #227

merged 41 commits into from
Mar 4, 2024

Conversation

cwilso
Copy link
Contributor

@cwilso cwilso commented Feb 6, 2024

(This includes changes from previous PR #222.)

Copy link
Member

@tantek tantek left a comment

Choose a reason for hiding this comment

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

LGTM

Copy link
Member

@annevk annevk left a comment

Choose a reason for hiding this comment

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

Thanks again for working on this. I think this is a valuable addition to the WHATWG.

The inline comments note a couple instances, but I would suggest we generally replace "feature" / "proposal" / ... with "Contribution" and link that to https://whatwg.org/ipr-policy#21-contribution. Similarly linking "Contributor" to https://whatwg.org/ipr-policy#contributor would be good (and consistently calling the person making the Contribution a Contributor).

That more clearly establishes how this works within our existing set of policies.

Stages.md Outdated Show resolved Hide resolved
Stages.md Outdated Show resolved Hide resolved
Stages.md Outdated Show resolved Hide resolved
Stages.md Outdated Show resolved Hide resolved
Stages.md Outdated Show resolved Hide resolved
Stages.md Outdated Show resolved Hide resolved
@cwilso cwilso requested a review from annevk February 22, 2024 17:26
Copy link
Member

@annevk annevk left a comment

Choose a reason for hiding this comment

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

  1. 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".
  2. Terms like Contribution and Contributor need to be linked, as they are in other Markdown documents.
  3. Please search for ". " (two spaces) and replace with ". " (single space).
  4. 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.

If you want I'd be happy to do a pass and then you can leave feedback for me. Just say the word.

Stages.md Outdated Show resolved Hide resolved
Stages.md Outdated Show resolved Hide resolved
Stages.md Outdated Show resolved Hide resolved
Stages.md Outdated Show resolved Hide resolved
Stages.md Outdated Show resolved Hide resolved
Stages.md Outdated Show resolved Hide resolved
Stages.md Outdated Show resolved Hide resolved
Stages.md Outdated Show resolved Hide resolved
@cwilso
Copy link
Contributor Author

cwilso commented Feb 28, 2024

  • 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 97f07c1.

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

Done in 8d24ac2, b2b46b7, 580c083, 7dac695.

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

Done in 96f0352.

  • 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 a525b11, 38523d0, and 37ffba4.

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

@cwilso
Copy link
Contributor Author

cwilso commented Feb 28, 2024

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
Copy link
Member

annevk commented Feb 28, 2024

@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
Copy link
Member

annevk commented Feb 28, 2024

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 whatwg/whatwg.org#436 for this.

annevk added a commit to whatwg/whatwg.org that referenced this pull request Feb 28, 2024
Needed for whatwg/sg#227.

Also update .gitignore while here.
@zcorpan
Copy link
Member

zcorpan commented Feb 28, 2024

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; }

Copy link
Contributor

@diekus diekus left a comment

Choose a reason for hiding this comment

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

👍🏼

Copy link
Contributor Author

@cwilso cwilso left a comment

Choose a reason for hiding this comment

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

LGTM

@annevk annevk merged commit ae3af70 into main Mar 4, 2024
1 check passed
@annevk annevk deleted the stages-md branch March 4, 2024 07:34
annevk added a commit to whatwg/whatwg.org that referenced this pull request Mar 4, 2024
Needed for whatwg/sg#227.

Also update .gitignore while here.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Development

Successfully merging this pull request may close these issues.

5 participants