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

Reorg charter documentation #204

Merged
merged 18 commits into from
Oct 26, 2023
Merged

Reorg charter documentation #204

merged 18 commits into from
Oct 26, 2023

Conversation

ianbjacobs
Copy link
Contributor

I've tried to simplify the explanations by:

  1. Separating high-level process from implementation details
  2. Separating "new" from "existing"

I've endeavored not to lose any requirements and also to take into account other edits that have happened this week re: Director-free.

dontcallmedom and others added 13 commits February 15, 2021 17:41
* Clarity around role of FSA compared to WG participation
* Change "consensus" to "support"
* Added a link to validate-repos
Co-authored-by: Fuqiao Xue <xfq@w3.org>
* Removed an extra sentence (not needed, IMO, given sentence that follows)
minor editorial
1) Separate high-level process from implementation details
2) Separate "new charters" from "existing charters"
3) Use short labels for process steps to make clearer what has to happen
4) Further clarify roles of Strategy Team and TiLT
@ianbjacobs
Copy link
Contributor Author

Note: I did not spend much time on the "Implementation" section of the document other than to try to fold in @xueyuanjia edits.

<dl>
<dt>Evaluate readiness</dt>
<dd>Let the proponents know if the charter is not well-formed (per the template), if it is perceived to be harmful to the Web, or if it is not a priority at the current time.</dd>
<dt>Send advance notice to AC</dt>
Copy link
Contributor

@xueyuanjia xueyuanjia Oct 26, 2023

Choose a reason for hiding this comment

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

I'd suggest to change "Send advance notice to AC" to "Work with W3C Communications Team to send advance notice to AC". We normally don't expect team contacts to directly send advance notices, and sending emails to (different from <ac-forum>) seems restricted to a sub-group of the Team.

Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<dt>Send advance notice to AC</dt>
<dt>Work with W3C Communications Team to send <a href="adv-notice.html">advance notice to AC</a></dt>

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Hi @xueyuanjia,
I agree with the point that the team contact does not do the advance notice. But I would like to avoid mentioning details in the short label, and I would like to keep the short label very short. I propose instead: "Request advance notice to AC."

process/charter.html Outdated Show resolved Hide resolved
<p>If TiLT resolves to extend a charter, the Strategy or Project Lead (or delegate) sends e-mail to the
W3C Communications Team in the form of an extension announcement; see the
<a href="https://www.w3.org/new-doc-from-template?location=%2FTeam%2Ftemplates&amp;template=%2Fafs%2Fw3.org%2Fpub%2FWWW%2FTeam%2FTemplates%2Fcharter-extension.html&amp;submit=Continue...">charter extension template</a>.</p>
<p><a href="https://lists.w3.org/Archives/Member/w3c-ac-members/2014JulSep/0018.html">Since July 2014</a>, the Team seeks a baseline level of support from Members before approving a charter.</p>
Copy link
Member

Choose a reason for hiding this comment

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

At this point, I think this notice can be removed. No need to link to the reason why a paragraph is there.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done.

<dl>
<dt>Evaluate readiness</dt>
<dd>Let the proponents know if the charter is not well-formed (per the template), if it is perceived to be harmful to the Web, or if it is not a priority at the current time.</dd>
<dt>Send advance notice to AC</dt>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<dt>Send advance notice to AC</dt>
<dt>Work with W3C Communications Team to send <a href="adv-notice.html">advance notice to AC</a></dt>

<p class="timeline"><em>Timeline:</em> this takes 5 weeks minimum. Formal objections to a charter will
add more time.</p>
<ul>
<li>Request the advance notice (via the <a href="#pipeline">pipeline</a>) as soon as you have something to point to.</li>
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
<li>Request the advance notice (via the <a href="#pipeline">pipeline</a>) as soon as you have something to point to.</li>
<li>Work with W3C Communications Team to send <a href="adv-notice.html">advance notice to AC</a> (via the <a href="#pipeline">pipeline</a>) as soon as you have something to point to.</li>

@@ -294,7 +289,7 @@ <h3>5.1 Organizing the Call for Review</h3>
<ol>
<li>A URI to the proposed charter (Note: avoid using github.io links); this charter is public during the AC review.</li>
Copy link
Member

Choose a reason for hiding this comment

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

We don't want to send github.io links for AC review.

Suggested change
<li>A URI to the proposed charter (Note: avoid using github.io links); this charter is public during the AC review.</li>
<li>A URI to the proposed charter (don't use github.io links); this charter is public during the AC review.</li>

@plehegar
Copy link
Member

Some minor tweaks but looks great otherwise

@ianbjacobs
Copy link
Contributor Author

@plh, I made changes based on your comments (mostly incorporating the suggestions).

@@ -292,9 +285,9 @@ <h3>5.1 Organizing the Call for Review</h3>
be sent <strong>at least three business days before</strong> the anticipated start
date of the review. The request must include:
<ol>
<li>A URI to the proposed charter (Note: avoid using github.io links); this charter is public during the AC review.</li>
<li>A URI to the proposed charter; please don't use github.io links. This charter is public during the AC review.</li>
Copy link
Member

Choose a reason for hiding this comment

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

I think the underlying concern is less about github.io but that the content may change while it is still under review (including horizontal review).

Thus, focus should instead be on immutable snapshots of a proposed charter. This should either be on:

  • W3C controlled space (e.g., a W3C Team controlled GitHub repository); or
  • W3C URI space (w3.org); or
  • a well-known trusted third-party service (e.g., archive.org).

This not only ensures that review are based on fixed content but also would prohibit changes to the proposed charter by anyone that is either unauthorised or did not have the consent of the group that's proposing the charter, e.g., see solid/solid-wg-charter#47 (comment) where it talks about this exact issue:

The proposed WG charter is still under horizontal review and making changes along the lines proposed in this PR without CG's consent is unacceptable behaviour.

Copy link
Contributor

Choose a reason for hiding this comment

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

Team practice is to always put a copy of the proposed charter in W3C url space for ac review.

Personally I use a naming convention so the Foo WG charter will be like foo-2023-ac.html which also makes it easier to get review of post-ac changes by sending a diff between that and foo-2023.html.

But yes the point is to avoid changing the document which is under AC review.

Copy link
Contributor

Choose a reason for hiding this comment

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

@csarven see my proposed change, does that address your concern?

@@ -292,9 +285,9 @@ <h3>5.1 Organizing the Call for Review</h3>
be sent <strong>at least three business days before</strong> the anticipated start
date of the review. The request must include:
<ol>
<li>A URI to the proposed charter (Note: avoid using github.io links); this charter is public during the AC review.</li>
<li>A URI to the proposed charter; please don't use github.io links. This charter is public during the AC review.</li>
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
<li>A URI to the proposed charter; please don't use github.io links. This charter is public during the AC review.</li>
<li>A URI to the proposed charter; use a w3.org link, not a github.io links. This charter is public, and must not be altered, during the AC review.</li>

Copy link
Member

Choose a reason for hiding this comment

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

s/links/link

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Now says: "A w3.org URI to the proposed charter (not a github.io URI). This charter is public, and must not be altered, during the AC review."

Note: Outside of this sentence, the term "URI" is used 10 times and "URL" is used 0 times. Therefore I went with URI.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Thanks @svgeesus and @csarven for this discussion.

Don't alter charter during review
@plehegar plehegar merged commit 3fcf6f2 into main Oct 26, 2023
@plehegar plehegar deleted the charter-20231025 branch October 26, 2023 16:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants