atr/templates/tutorial.html

{% extends "layouts/base.html" %}

{% block title %}
  Tutorial for release managers ~ ATR
{% endblock title %}

{% block stylesheets %}
  {{ super() }}
  <style>
      img {
          border: 1px solid #cccccc;
          box-shadow: 0 0 1rem rgba(0, 0, 0, 0.2);
          margin: 1rem 0;
          max-width: 75%;
      }
  </style>
{% endblock stylesheets %}

{% 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 class="btn-group my-3" role="group" aria-label="Tutorial sections">
    <a href="#compose" class="btn btn-outline-secondary">Compose</a>
    <a href="#vote" class="btn btn-outline-secondary">Vote</a>
    <a href="#finish" class="btn btn-outline-secondary">Finish</a>
    <a href="#releases" class="btn btn-outline-secondary">Releases</a>
  </p>

  <h2 id="compose">Compose</h2>
  <p>
    Activate the <strong>Select release</strong> sidebar link [<code>1</code>], then use 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') }}"
         alt="Illustration: Follow the sidebar link, and use the button." />
  </p>
  <p>
    Use the <strong>Upload files</strong> button on the empty <em>Compose</em> page to add files.
  </p>
  <p>
    <img src="{{ url_for('static', filename='png/tutorial-compose-02.png') }}"
         alt="Illustration: Use the Upload files button to add files." />
  </p>
  <p>
    Upload files via the browser, <code>svn</code>, or <code>rsync</code>. To use <code>rsync</code>, first submit an SSH key to ATR. We plan to read this from LDAP in future.
  </p>
  <p>
    After upload, ATR checks your files. Review the check results on the <em>Compose</em> page [<code>1</code>]. Use the <strong>Show report</strong>, <strong>Show warnings</strong>, or <strong>Show errors</strong> buttons for a detailed review of the check results.
  </p>
  <p>
    When the files are present and the check results are satisfactory, use the <strong>Start voting</strong> button to proceed [<code>2</code>].
  </p>
  <p>
    <img src="{{ url_for('static', filename='png/tutorial-compose-03.png') }}"
         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.
  </p>
  <p>
    <img src="{{ url_for('static', filename='png/tutorial-compose-04.png') }}"
         alt="Illustration: Use the form to start a vote." />
  </p>

  <h2 id="vote">Vote</h2>
  <p>
    The <em>Vote</em> page is available to all project participants, and displays the report results.
  </p>
  <p>
    <img src="{{ url_for('static', filename='png/tutorial-vote-01.png') }}"
         alt="Illustration: Anybody can review the reports." />
  </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>].
  </p>
  <p>
    <img src="{{ url_for('static', filename='png/tutorial-vote-02.png') }}"
         alt="Illustration: Review the voting thread, and case your own vote." />
  </p>
  <p>
    When the voting period concludes and the mandate is clear, record the outcome using the vote resolution form. This action 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-03.png') }}"
         alt="Illustration: Use the vote resolution form to progress to the next phase." />
  </p>

  <h2 id="finish">Finish</h2>
  <p>
    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.
  </p>
  <p>
    ATR currently supports moving files between directories, preserving filenames. We plan to support more types of changes in future.
  </p>
  <p>
    When the release is finished, use the <strong>Announce and distribute</strong> button.
  </p>
  <p>
    <img src="{{ url_for('static', filename='png/tutorial-finish-01.png') }}"
         alt="Illustration: Use the Announce and distribute button." />
  </p>
  <p>
    Using the announcement form sends a message to your selected mailing list. Destination options are limited during the testing phase.
  </p>
  <p>
    <img src="{{ url_for('static', filename='png/tutorial-finish-02.png') }}"
         alt="Illustration: The announcement form sends a message to your selected mailing list." />
  </p>

  <h2 id="releases">Releases</h2>
  <p>When a release is finished, it is listed alongside any other finished releases for a project.</p>
  <p>
    <img src="{{ url_for('static', filename='png/tutorial-releases-01.png') }}"
         alt="Illustration: Finished releases are shown for each individual project." />
  </p>
  <p>Each entry provides a link to download the artifacts.</p>
  <p>
    <img src="{{ url_for('static', filename='png/tutorial-releases-02.png') }}"
         alt="Illustration: It is possible to browse the files within a finished release." />
  </p>
  <p>This completes the ATR workflow, from private draft to finished public release.</p>
{% endblock content %}