sbp commented on code in PR #76:
URL:
https://github.com/apache/tooling-trusted-release/pull/76#discussion_r2078425854
##########
atr/templates/tutorial.html:
##########
@@ -55,7 +55,7 @@ <h2 id="compose">Compose</h2>
alt="Illustration: Review the results of your checks, and use the
Start voting button." />
</p>
<p>
- A form to start the vote is displayed. If necessary, use its ability to
preview the vote announcement email body. When you submit the form, ATR sends
an announcement message in your name to the chosen mailing list.
+ A form to start the vote appears. If necessary, use its ability to preview
the vote announcement email body. When you submit the form, ATR sends an
announcement message in your name to the chosen mailing list.
Review Comment:
I originally wrote "appears", but it sounded strange to me and I struggled
to find a replacement. I would certainly accept reverting it to "appears", but
alternative suggestions to choose from would be welcome.
##########
atr/templates/tutorial.html:
##########
@@ -18,7 +18,7 @@
{% block content %}
<h1>Tutorial for release managers</h1>
- <p>The ATR is under development; the current version may not precisely match
the screenshots below.</p>
+ <p>Adobe Trusted Releases (ATR) is under development; the current version
may not precisely match the screenshots below.</p>
Review Comment:
Should be `Apache` rather than `Adobe`.
##########
atr/templates/tutorial.html:
##########
@@ -64,7 +64,7 @@ <h2 id="compose">Compose</h2>
<h2 id="vote">Vote</h2>
<p>
- The <em>Vote</em> page is available to all project participants, and
displays the report results.
+ The <em>Vote</em> page is available to all project participants, and
displays the vote results.
Review Comment:
The _Vote_ page does not, perhaps counter-intuitively, display the vote
results yet. As the tutorial itself says, "ATR does not yet tally votes; you
must do this manually." We certainly plan this as a very important feature, but
it will involve heuristics and a lot of testing so it is deferred for now. The
reference to "report results" parallels the previous section: the reports are
the same as those displayed to the user during the _Compose_ phase. When the
_Compose_ phase is over, the reports are immutable during the _Vote_ phase.
They are displayed to the release manager(s) during the _Compose_ phase to help
inform them about what they need to change, fix, improve. They are then
displayed during the _Vote_ phase again to help inform project participants
what issues have been automatically detected. One thing we might consider is
allowing the release manager to annotate the check reports so that e.g.
participants are aware why errors have been manually, deliberately ignored.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: [email protected]
For queries about this service, please contact Infrastructure at:
[email protected]
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
