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-release.git
The following commit(s) were added to refs/heads/main by this push:
new 67dcbe3 Restore the old tutorial page
67dcbe3 is described below
commit 67dcbe3cbcb7710c5a6c5b4d6958eac402a8de7d
Author: Sean B. Palmer <[email protected]>
AuthorDate: Wed Apr 23 17:06:56 2025 +0100
Restore the old tutorial page
---
atr/routes/root.py | 4 +-
atr/templates/includes/sidebar.html | 5 +-
atr/templates/tutorial.html | 95 ++++++++++++++++---------------------
3 files changed, 46 insertions(+), 58 deletions(-)
diff --git a/atr/routes/root.py b/atr/routes/root.py
index 9cf1254..c1cc9fa 100644
--- a/atr/routes/root.py
+++ b/atr/routes/root.py
@@ -104,7 +104,7 @@ async def index() -> response.Response | str:
return await quart.render_template("index-public.html")
[email protected]("/tutorial")
-async def tutorial() -> str:
[email protected]("/tutorial")
+async def tutorial(session: routes.CommitterSession) -> str:
"""Tutorial page."""
return await quart.render_template("tutorial.html")
diff --git a/atr/templates/includes/sidebar.html
b/atr/templates/includes/sidebar.html
index d6fe388..556b683 100644
--- a/atr/templates/includes/sidebar.html
+++ b/atr/templates/includes/sidebar.html
@@ -90,9 +90,8 @@
<h3>Documentation</h3>
<ul>
<li>
- <i class="fa-solid fa-house"></i>
- <a href="{{ as_url(routes.root.index) }}"
- {% if request.endpoint == 'root' %}class="active"{% endif
%}>About</a>
+ <i class="fa-solid fa-book"></i>
+ <a href="{{ as_url(routes.root.tutorial) }}">Tutorial</a>
</li>
</ul>
diff --git a/atr/templates/tutorial.html b/atr/templates/tutorial.html
index 1397399..485e26c 100644
--- a/atr/templates/tutorial.html
+++ b/atr/templates/tutorial.html
@@ -5,78 +5,67 @@
{% endblock title %}
{% block content %}
- <h1>Apache Trusted Release</h1>
-
+ <h1>Quick tutorial</h1>
<p>
ATR is a release management platform for <a
href="https://www.apache.org";>Apache Software
Foundation</a> projects. It provides a standardized workflow for PMC
members to submit,
verify, and track release candidates.
</p>
- {% if current_user %}
- <h2>Quick tutorial</h2>
- <p>
- This is a preview of an early version of ATR, and we would like testers
to try it out and give us feedback. This section provides a quick tutorial for
using ATR. The basic workflow on ATR is Release Candidate Draft -> Release
Candidate -> Release Preview -> Release. Note that, as the header says on every
page, this is a preview and you cannot yet create actual releases with ATR.
- </p>
-
- <h3>Release candidate draft</h3>
-
- <p>
- We recommend that you start by <a href="{{ as_url(routes.keys.ssh_add)
}}">uploading your SSH key</a>. This gives you rsync access which makes it
easier to upload your files. We plan to obtain your SSH key from your ASF
account via LDAP in the long run.
- </p>
+ <p>
+ This is a preview of an early version of ATR, and we would like testers to
try it out and give us feedback. This section provides a quick tutorial for
using ATR. The basic workflow on ATR is Release Candidate Draft -> Release
Candidate -> Release Preview -> Release. Note that, as the header says on every
page, this is a preview and you cannot yet create actual releases with ATR.
+ </p>
- <p>
- Once you've uploaded your SSH key, you may be able to <a href="{{
as_url(routes.draft.add) }}">add a release candidate draft</a>. Only Project
Management Committee (PMC) members can do this. Once a draft has been created,
all PMC members and committers can add files to the draft or delete files from
it.
- </p>
+ <h2>Release candidate draft</h2>
- <p>
- When you add files, ATR automatically runs some checks on the files.
You'll be able to browse the results of those checks. Note that our checks are
currently very basic, and we'll be adding more checks as we get feedback from
testers.
- </p>
+ <p>
+ We recommend that you start by <a href="{{ as_url(routes.keys.ssh_add)
}}">uploading your SSH key</a>. This gives you rsync access which makes it
easier to upload your files. We plan to obtain your SSH key from your ASF
account via LDAP in the long run.
+ </p>
- <p>When you're happy with the files in the draft, you can start a vote on
it.</p>
+ <p>
+ Once you've uploaded your SSH key, you may be able to <a href="{{
as_url(routes.draft.add) }}">add a release candidate draft</a>. Only Project
Management Committee (PMC) members can do this. Once a draft has been created,
all PMC members and committers can add files to the draft or delete files from
it.
+ </p>
- <h3>Release candidate</h3>
+ <p>
+ When you add files, ATR automatically runs some checks on the files.
You'll be able to browse the results of those checks. Note that our checks are
currently very basic, and we'll be adding more checks as we get feedback from
testers.
+ </p>
- <p>
- When you've promoted the draft to a release candidate, you can use ATR
to start a vote on the release candidate. Currently we allow any PMC member to
start the vote, but in the future we may limit this to designated release
managers. The ATR is designed to send the vote email itself, but we understand
that projects send very detailed vote announcement emails. We plan to make it
easier for you to send such announcement emails. We also plan to allow users to
send the vote email thems [...]
- </p>
+ <p>When you're happy with the files in the draft, you can start a vote on
it.</p>
- <p>
- The vote email is not actually sent out, because ATR cannot yet be used
to create releases. We are only testing the workflow.
- </p>
+ <h2>Release candidate</h2>
- <p>
- When you're happy with the release candidate, you can <a href="{{
as_url(routes.candidate.resolve) }}">record the vote resolution</a> to promote
the release candidate to a release preview.
- </p>
+ <p>
+ When you've promoted the draft to a release candidate, you can use ATR to
start a vote on the release candidate. Currently we allow any PMC member to
start the vote, but in the future we may limit this to designated release
managers. The ATR is designed to send the vote email itself, but we understand
that projects send very detailed vote announcement emails. We plan to make it
easier for you to send such announcement emails. We also plan to allow users to
send the vote email themsel [...]
+ </p>
- <h3>Release preview</h3>
+ <p>
+ The vote email is not actually sent out, because ATR cannot yet be used to
create releases. We are only testing the workflow.
+ </p>
- <p>
- When you've promoted the release candidate to a release preview, you can
review the files. We plan to make it possible to adjust the release preview
before it's promoted to a release.
- </p>
+ <p>
+ When you're happy with the release candidate, you can <a href="{{
as_url(routes.candidate.resolve) }}">record the vote resolution</a> to promote
the release candidate to a release preview.
+ </p>
- <p>
- When you're happy with the release preview, you can <a href="{{
as_url(routes.preview.announce) }}">announce the release preview</a>. This,
again, should be an action limited to designated release managers.
- </p>
+ <h2>Release preview</h2>
- <h3>Release</h3>
+ <p>
+ When you've promoted the release candidate to a release preview, you can
review the files. We plan to make it possible to adjust the release preview
before it's promoted to a release.
+ </p>
- <p>
- When you've promoted the release preview to a release, you can <a
href="{{ as_url(routes.release.releases) }}">browse the release</a>.
- </p>
+ <p>
+ When you're happy with the release preview, you can <a href="{{
as_url(routes.preview.announce) }}">announce the release preview</a>. This,
again, should be an action limited to designated release managers.
+ </p>
- <h2>Key features</h2>
- <ul>
- <li>Support for rsync or HTML form based file uploads</li>
- <li>Automatic checks of release artifacts</li>
- <li>Templated email vote announcements</li>
- </ul>
- {% else %}
+ <h2>Release</h2>
- <div class="alert alert-info d-flex align-items-center" role="alert">
- <i class="fas fa-exclamation-triangle me-2"></i>
- <div>Note: You need to login with your ASF account in order to use this
platform.</div>
- </div>
- {% endif %}
+ <p>
+ When you've promoted the release preview to a release, you can <a href="{{
as_url(routes.release.releases) }}">browse the release</a>.
+ </p>
+ <h2>Key features</h2>
+ <ul>
+ <li>Support for rsync or HTML form based file uploads</li>
+ <li>Automatic checks of release artifacts</li>
+ <li>Templated email vote announcements</li>
+ </ul>
{% endblock content %}
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
