This is an automated email from the ASF dual-hosted git repository.
sbp pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/tooling-trusted-releases.git
The following commit(s) were added to refs/heads/main by this push:
new 7cd09ad Update screenshots in the tutorial and ensure that the text
matches
7cd09ad is described below
commit 7cd09adfc4cbfbd0fe994a96279b4d545427501f
Author: Sean B. Palmer <[email protected]>
AuthorDate: Mon Oct 13 15:39:54 2025 +0100
Update screenshots in the tutorial and ensure that the text matches
---
atr/docs/developer-guide.html | 2 +-
atr/docs/developer-guide.md | 2 +-
atr/docs/user-guide.html | 2 +-
atr/docs/user-guide.md | 2 +-
atr/static/css/atr.css | 2 ++
atr/static/png/tutorial-compose-01.png | Bin 89982 -> 61614 bytes
atr/static/png/tutorial-compose-02.png | Bin 87170 -> 59516 bytes
atr/static/png/tutorial-compose-03.png | Bin 92193 -> 66474 bytes
atr/static/png/tutorial-compose-04.png | Bin 100021 -> 76630 bytes
atr/static/png/tutorial-finish-01.png | Bin 75899 -> 74009 bytes
atr/static/png/tutorial-finish-02.png | Bin 333906 -> 56698 bytes
atr/static/png/tutorial-projects-01.png | Bin 266896 -> 56425 bytes
atr/static/png/tutorial-projects-02.png | Bin 216170 -> 45015 bytes
atr/static/png/tutorial-projects-03.png | Bin 151003 -> 34610 bytes
atr/static/png/tutorial-releases-01.png | Bin 56619 -> 39053 bytes
atr/static/png/tutorial-vote-01.png | Bin 95402 -> 64999 bytes
atr/static/png/tutorial-vote-02.png | Bin 92268 -> 68499 bytes
atr/static/png/tutorial-vote-03.png | Bin 93220 -> 52054 bytes
atr/static/png/tutorial-vote-04.png | Bin 52250 -> 47398 bytes
atr/templates/tutorial.html | 8 ++++----
scripts/docs_check.py | 2 +-
21 files changed, 11 insertions(+), 9 deletions(-)
diff --git a/atr/docs/developer-guide.html b/atr/docs/developer-guide.html
index bab6ec6..7127f58 100644
--- a/atr/docs/developer-guide.html
+++ b/atr/docs/developer-guide.html
@@ -18,4 +18,4 @@
<li><a href="#introduction">Introduction</a></li>
</ul>
<h2 id="introduction">Introduction</h2>
-<p>This is a guide for developers of ATR, explaining how to make changes to
the ATR source code. For more information about how to contribute those changes
back to us, please read the <a href="how-to-contribute">contribution guide</a>
instead.</p>
+<p>This is a guide for developers of ATR, explaining how to make changes to
the ATR source code. For more information about how to contribute those changes
back to us, please read the <a href="how-to-contribute">contribution
guide</a>.</p>
diff --git a/atr/docs/developer-guide.md b/atr/docs/developer-guide.md
index 5d5e798..fe7667d 100644
--- a/atr/docs/developer-guide.md
+++ b/atr/docs/developer-guide.md
@@ -23,4 +23,4 @@
## Introduction
-This is a guide for developers of ATR, explaining how to make changes to the
ATR source code. For more information about how to contribute those changes
back to us, please read the [contribution guide](how-to-contribute) instead.
+This is a guide for developers of ATR, explaining how to make changes to the
ATR source code. For more information about how to contribute those changes
back to us, please read the [contribution guide](how-to-contribute).
diff --git a/atr/docs/user-guide.html b/atr/docs/user-guide.html
index c8ee1c9..f232dbc 100644
--- a/atr/docs/user-guide.html
+++ b/atr/docs/user-guide.html
@@ -7,4 +7,4 @@
<li><a href="#introduction">Introduction</a></li>
</ul>
<h2 id="introduction">Introduction</h2>
-<p>[TODO]</p>
+<p>This is a work in progress. Meanwhile, you can read the <a
href="/tutorial">ATR tutorial</a>.</p>
diff --git a/atr/docs/user-guide.md b/atr/docs/user-guide.md
index de2e363..cfac4de 100644
--- a/atr/docs/user-guide.md
+++ b/atr/docs/user-guide.md
@@ -12,4 +12,4 @@
## Introduction
-[TODO]
+This is a work in progress. Meanwhile, you can read the [ATR
tutorial](/tutorial).
diff --git a/atr/static/css/atr.css b/atr/static/css/atr.css
index b6e26cb..4561a0a 100644
--- a/atr/static/css/atr.css
+++ b/atr/static/css/atr.css
@@ -96,6 +96,8 @@ a code {
color: #aa0033;
}
+td code { color: #000000; }
+
summary {
cursor: pointer;
}
diff --git a/atr/static/png/tutorial-compose-01.png
b/atr/static/png/tutorial-compose-01.png
index e41579a..d58bf82 100644
Binary files a/atr/static/png/tutorial-compose-01.png and
b/atr/static/png/tutorial-compose-01.png differ
diff --git a/atr/static/png/tutorial-compose-02.png
b/atr/static/png/tutorial-compose-02.png
index eff7cef..e0801ee 100644
Binary files a/atr/static/png/tutorial-compose-02.png and
b/atr/static/png/tutorial-compose-02.png differ
diff --git a/atr/static/png/tutorial-compose-03.png
b/atr/static/png/tutorial-compose-03.png
index b3a59fb..93254d6 100644
Binary files a/atr/static/png/tutorial-compose-03.png and
b/atr/static/png/tutorial-compose-03.png differ
diff --git a/atr/static/png/tutorial-compose-04.png
b/atr/static/png/tutorial-compose-04.png
index 221f27d..5e482b1 100644
Binary files a/atr/static/png/tutorial-compose-04.png and
b/atr/static/png/tutorial-compose-04.png differ
diff --git a/atr/static/png/tutorial-finish-01.png
b/atr/static/png/tutorial-finish-01.png
index a387a05..9fc4de3 100644
Binary files a/atr/static/png/tutorial-finish-01.png and
b/atr/static/png/tutorial-finish-01.png differ
diff --git a/atr/static/png/tutorial-finish-02.png
b/atr/static/png/tutorial-finish-02.png
index e841880..64b42b0 100644
Binary files a/atr/static/png/tutorial-finish-02.png and
b/atr/static/png/tutorial-finish-02.png differ
diff --git a/atr/static/png/tutorial-projects-01.png
b/atr/static/png/tutorial-projects-01.png
index a1b228c..74c40f3 100644
Binary files a/atr/static/png/tutorial-projects-01.png and
b/atr/static/png/tutorial-projects-01.png differ
diff --git a/atr/static/png/tutorial-projects-02.png
b/atr/static/png/tutorial-projects-02.png
index 8a3f4d4..453c227 100644
Binary files a/atr/static/png/tutorial-projects-02.png and
b/atr/static/png/tutorial-projects-02.png differ
diff --git a/atr/static/png/tutorial-projects-03.png
b/atr/static/png/tutorial-projects-03.png
index c6ff5fb..29e1478 100644
Binary files a/atr/static/png/tutorial-projects-03.png and
b/atr/static/png/tutorial-projects-03.png differ
diff --git a/atr/static/png/tutorial-releases-01.png
b/atr/static/png/tutorial-releases-01.png
index 97f8380..167cb98 100644
Binary files a/atr/static/png/tutorial-releases-01.png and
b/atr/static/png/tutorial-releases-01.png differ
diff --git a/atr/static/png/tutorial-vote-01.png
b/atr/static/png/tutorial-vote-01.png
index 1b0ac1f..80505db 100644
Binary files a/atr/static/png/tutorial-vote-01.png and
b/atr/static/png/tutorial-vote-01.png differ
diff --git a/atr/static/png/tutorial-vote-02.png
b/atr/static/png/tutorial-vote-02.png
index ddd39bd..7cc4e34 100644
Binary files a/atr/static/png/tutorial-vote-02.png and
b/atr/static/png/tutorial-vote-02.png differ
diff --git a/atr/static/png/tutorial-vote-03.png
b/atr/static/png/tutorial-vote-03.png
index 041e123..20a41d4 100644
Binary files a/atr/static/png/tutorial-vote-03.png and
b/atr/static/png/tutorial-vote-03.png differ
diff --git a/atr/static/png/tutorial-vote-04.png
b/atr/static/png/tutorial-vote-04.png
index 5459df1..486c789 100644
Binary files a/atr/static/png/tutorial-vote-04.png and
b/atr/static/png/tutorial-vote-04.png differ
diff --git a/atr/templates/tutorial.html b/atr/templates/tutorial.html
index 145b9cd..75eb9cf 100644
--- a/atr/templates/tutorial.html
+++ b/atr/templates/tutorial.html
@@ -31,7 +31,7 @@
<h2 id="compose">Compose</h2>
<p>
- Use the <strong>Select release</strong> sidebar link [<code>1</code>],
then press the <strong>Start a new release</strong> button for any project
[<code>2</code>].
+ Use the <strong>Make releases</strong> sidebar link [<code>1</code>], then
press the <strong>Start a new release</strong> button for any project
[<code>2</code>].
</p>
<p>
<img src="{{ url_for('static', filename='png/tutorial-compose-01.png') }}"
@@ -81,14 +81,14 @@
alt="Illustration: Download the release candidate files." />
</p>
<p>
- A link allows review of the voting thread in the mailing list archives
[<code>1</code>]. ATR does not yet tally votes; you must do this manually. A
form on the page allows you to cast your vote on the mailing list
[<code>2</code>].
+ A link allows review of the voting thread in the mailing list archives
[<code>1</code>]. ATR will try to tally votes for you, but you must check the
results manually. A form on the page allows you to cast your vote on the
mailing list [<code>2</code>].
</p>
<p>
<img src="{{ url_for('static', filename='png/tutorial-vote-03.png') }}"
alt="Illustration: Review the voting thread, and cast your own vote."
/>
</p>
<p>
- When the voting period concludes and the mandate is clear, record the
outcome using the vote resolution form. Submitting this form also sends the
outcome of the vote to the mailing list. A successful vote promotes the release
candidate to the next phase; a failed vote returns it to the <em>Compose</em>
phase.
+ When the voting period concludes and the mandate is clear, record the
outcome using the vote resolution form, accessed by pressing the
<strong>Resolve vote</strong> button. Submitting this form also sends the
outcome of the vote to the mailing list. A successful vote promotes the release
candidate to the next phase; a failed vote returns it to the <em>Compose</em>
phase.
</p>
<p>
<img src="{{ url_for('static', filename='png/tutorial-vote-04.png') }}"
@@ -100,7 +100,7 @@
If the vote passes, the release enters the <em>Finish</em> phase. This
phase may allow minor content adjustments before the announcement and final
release. ATR currently supports moving files between directories, preserving
filenames. We plan to support more types of adjustments in future.
</p>
<p>
- During this phase you should distribute release artifacts to your package
distribution networks such as Maven Central, PyPI, or Docker Hub. We plan to
add tools to assist with this.
+ During this phase you should distribute release artifacts to your package
distribution networks such as Maven Central, PyPI, or Docker Hub. You currently
must do this manually, but you can record the results on ATR.
</p>
<p>
When the release is finished, press the <strong>Announce and
distribute</strong> button.
diff --git a/scripts/docs_check.py b/scripts/docs_check.py
index ba36ff1..ed204cb 100755
--- a/scripts/docs_check.py
+++ b/scripts/docs_check.py
@@ -58,7 +58,7 @@ def _extract_links(file_path: pathlib.Path) -> list[Link]:
text = match.group(1)
target = match.group(2)
- if target.startswith("/ref/"):
+ if target.startswith("/"):
continue
if target.startswith("http://";) or target.startswith("https://";):
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
