-
Notifications
You must be signed in to change notification settings - Fork 5
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
Improve wide review handling #21
Conversation
(with #15 merged, the tip could even be more easily fullfilled) |
Co-authored-by: r12a <ishida@w3.org>
Co-authored-by: r12a <ishida@w3.org>
Co-authored-by: r12a <ishida@w3.org>
Co-authored-by: r12a <ishida@w3.org>
Co-authored-by: r12a <ishida@w3.org>
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.
Looks like a good improvement. Made a bunch of mainly language-based suggestions to get away from using US-centric colloquialisms like "gotten" and "reach out" in the hope of reaching more geographically neutral English language, and being clearer about the intent.
Co-authored-by: Nigel Megitt <nigel.megitt@bbc.co.uk>
Co-authored-by: Nigel Megitt <nigel.megitt@bbc.co.uk>
Co-authored-by: Nigel Megitt <nigel.megitt@bbc.co.uk>
Co-authored-by: Nigel Megitt <nigel.megitt@bbc.co.uk>
Co-authored-by: Nigel Megitt <nigel.megitt@bbc.co.uk>
Co-authored-by: Nigel Megitt <nigel.megitt@bbc.co.uk>
Co-authored-by: Nigel Megitt <nigel.megitt@bbc.co.uk>
Co-authored-by: Nigel Megitt <nigel.megitt@bbc.co.uk>
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.
All my changes incorporated, thanks @plehegar - it looks like @r12a 's comments have also been incorporated, but I'm not clear because the comment is not shown as resolved. Changing my review to a "Comment" so it doesn't block merging, happy to mark as Approved after seeing it when it seems to be stable with respect to other reviewers' comments.
Alright, I believe I folded everything in. Next step are to rebase with the main branch, tweak to integrate the recent github template changes, get a +1 from @swickr , give it a few days in case other comments are coming, merge, and finally announce the update to the Chairs list. |
Co-authored-by: Nigel Megitt <nigel.megitt@bbc.co.uk>
Co-authored-by: Nigel Megitt <nigel.megitt@bbc.co.uk>
Co-authored-by: Nigel Megitt <nigel.megitt@bbc.co.uk>
Co-authored-by: r12a <ishida@w3.org>
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.
Great work on the text. Big improvement. Thanks @plehegar, @nigelmegitt , @r12a.
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.
This is starting to get long enough that it gets some things muddled. For example, there's this new section on when to ask for wide review as well as the existing verbiage in the HR section re: when to ask for HR review.
If we're breaking out the "when", perhaps we need to pull it out of the HR section, also? And, in case, this is getting long enough that we need some combination of TL;DR version or at least an early-in-the-doc clarification of what we mean by wide v. horizontal review. Or we need to see if we can clarify with a net reduction in words.
I'd prefer to leave it, as it's worth saying twice, and more likely to be noticed by those who just jump to the 'How to get horizontal review' section. But actually, i think it contains some additional information that is HR specific.
I suggest zapping the "Terminology & abbreviations" and "Enhancement Requests" sections. The former is a hangover from the original document that we never looked at closely. The second is about a link that doesn't actually work anyway. I'd also be happy to drop the FAQ section. That, too, is very old text that we never examined during the rewrite. That would produce a good net reduction of words on the page. |
(waiting on a review from @frivoal ) |
People don't know that the nature of changes. They see 2 documents with 2 different dates. Whatever dated version they picked needs to be clear to the Director. The Director needs to precisely review changes done to a specification since that spec was sent to wide review. Here is yet another messy instance in
The SOTD marker is meant to help us diffuse the information and draw extract attention. I guess, once I finally get around to finish the tooling on wide review, the marker would not be needed. I'm ok with removing/relaxing the requirement in this pull request. |
Let me paste the full contents of my comment to which @plehegar was replying:
And now my reply to #21 (comment) is as follows: When we send a request for wide review -- to the public or to an HRG -- we want to be linking to the Latest Version URL so that the reviewers, on the day they are reviewing, see our latest work. We do not want to be linking to a dated copy, because we don't want the reviewers to be working off of stale documents. If the Director wants to know what version was reviewed by an HRG, then that information should be requested from the HRG in their response to the review: please link to the dated URL of the version that you reviewed. Alternately the Director could use the date of the HRG response to identify the dated version that was reviewed. As long as Horizontal Review is requested against /TR (as it should be), there should be no problem identifying the version of the document that was reviewed. |
<p>The reviews provided by the <a | ||
href="https://www.w3.org/Guide/process/charter.html#horizontal-review">horizontal | ||
groups</a>, a subset of a full wide review, do receive special attention and | ||
much of the rest of this document focuses on how and when to conduct horizontal |
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.
Split the sentence after "and" here. :)
offered a reasonable opportunity to review the document.</p> | ||
|
||
<p>You <strong>must</strong> publish an updated technical report, with the Status of the Document | ||
indicating clearly that you're looking for <em>wide review</em>, before inviting |
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.
All of our publications are inviting review, that is why we publish them. Let's not add more junk to the SOTD.
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.
Except that the other groups need a clearer signal that wide review is expected before moving to CR. It's not junk, it gets picked up by our tools for the past few years.
We should also update the HR request templates to encourage working drafts |
Merging this pull request since it encodes current practices. Additional issues are welcome separately. |
This clarifies further how to get wide review (#12).
Hopefully this helps.
cc @nigelmegitt @frivoal @fantasai
Preview, HTML diff
Preview | Diff