Skip to content
Snippets Groups Projects
Commit cdda03c3 authored by Jayesh's avatar Jayesh :cat2:
Browse files

Improve language in add-forge-now help text

Related to T4087
parent 1ffff63f
No related branches found
No related tags found
No related merge requests found
......@@ -85,7 +85,7 @@ Add forge now – Software Heritage archive
<label for="swh-input-forge-url" class="swh-required-label">Forge URL</label>
<input type="text" class="form-control" id="swh-input-forge-url" name="forge_url" required>
<small class="form-text text-muted">
Remote URL of the forge to list.
Remote URL of the forge.
</small>
</div>
</div>
......@@ -95,7 +95,7 @@ Add forge now – Software Heritage archive
<label for="swh-input-forge-contact-name" class="swh-required-label">Forge contact name</label>
<input type="text" class="form-control" name="forge_contact_name" id="swh-input-forge-contact-name" required>
<small class="form-text text-muted">
Name of the Forge administrator.
Name of the forge administrator.
</small>
</div>
......@@ -146,11 +146,11 @@ Add forge now – Software Heritage archive
</div>
</form>
<p>
Once a add request has been submitted, you can follow its current status in
Once an add-forge-request is submitted, its status can be viewed in
the <a id="swh-show-forge-add-requests-list" href="#browse-requests">
submitted requests list</a>. This process is depending on human interactions
and might take a few days to be handled (it primarily depends on the response
time of the forge).
submitted requests list</a>. This process involves a moderator approval and
might take a few days to handle (it primarily depends on the response
time from the forge).
</p>
{% endif %}
</div>
......@@ -168,11 +168,12 @@ Add forge now – Software Heritage archive
<div id="add-forge-browse-request-error"></div>
</div>
<div id="swh-add-forge-requests-help" class="tab-pane fade show">
<p style="margin-top: 1rem;">Prior to submit an "Add forge now" request, we ask
you to fill in the following parameters:</p>
<p style="margin-top: 1rem;">
For submitting an "Add forge now" request", you have to provide the following details:
</p>
<ul>
<li><b>Forge type:</b> the type of supported forge the software archive is able to list.
Currently, the supported types are:
<li><strong>Forge type:</strong>Type of the forge you would like to add.
Supported forge types in software heritage currently are:
<ul>
<li><code>cgit</code>, for <a href="https://git.zx2c4.com/cgit/">cgit</a> forges</li>
<li><code>gitea</code>, for <a href="https://gitea.io/en-us/">gitea</a> forges</li>
......@@ -181,75 +182,67 @@ Add forge now – Software Heritage archive
...
</ul>
</li>
<li><b>Forge url:</b> the url of the selected forge. This must be unique.
<li><strong>Forge url:</strong>The URL of the selected forge. This must be unique.
</li>
<li><b>Forge contact name:</b> Contact name of the forge administrator we
intend to ingest.
<li><strong>Forge contact name:</strong>Contact name of the forge administrator
</li>
<li><b>Forge contact email:</b> Contact email of the forge administrator so an
email can be send to the forge. The intent is to notify the forge prior to
actually start the ingestion.
<li><strong>Forge contact email:</strong>Contact email of the forge administrator. An email
will be sent to the given address to notify about the request.
</li>
<li><b>Consent checkbox:</b> This checkbox's purpose is to know whether we can
<li><strong>Consent checkbox:</strong> This checkbox's purpose is to know whether we can
explicitly mention the user's login within the email sent to the forge. If
not checked, the user's name won't be mentioned in the email at all.
</li>
<li><b>Comment:</b> (Optionally) For the user to mention something more about
<li><strong>Comment:</strong> (Optionally) For the user to mention something more about
their request to the add-forge-now moderator.
</li>
</ul>
<p style="margin-top: 1rem;">Once submitted, your "add forge" request can either be:
<p style="margin-top: 1rem;">
Once submitted, your "add forge" request can be in one
of the following states
</p>
<ul>
<li>
<strong>Pending:</strong>
the request was submitted and is waiting for a moderator
to check its validity.
The request was submitted and is waiting for a moderator
to validate
</li>
<li>
<strong>Waiting for feedback:</strong>
the request was processed by a moderator
and the forge was contacted, the request is waiting for feedback from the
forge.
The request was processed by a moderator and the forge was contacted.
</li>
<li>
<strong>Feedback to handle:</strong>
the forge has responded to the request and
there is feedback to handle for the request.</li>
The forge has responded to the request and
there is feedback to handle for the request.
</li>
<li>
<strong>Accepted:</strong>
the request has been accepted and waiting to be
scheduled.
The request has been accepted.
</li>
<li>
<strong>Scheduled:</strong>
the request has been scheduled is considered
done.
The requested forge listing has been scheduled.
</li>
<li>
<strong>First listing done:</strong>
The first listing of the forge is
completed.
The first listing of the requested forge has been completed
</li>
<li>
<strong>First origin loaded:</strong>
The first origin or repository processed by
loader and archived (using a search query).
The first repositories (or origins) from the requested forge have been loaded and archived.
</li>
<li><strong>Rejected:</strong> the request is not a valid request and is rejected by a
Software Heritage moderator.</li>
<li><strong>Rejected:</strong>The request is invalid. It is rejected by a moderator with an explanation.</li>
<li><strong>Denied:</strong> the forge has requested not to archive the forge.</li>
<li><strong>Denied:</strong>The forge administrator(s) denied the request to list their forge.</li>
<li><strong>Suspended:</strong> the request is for a forge with a non supported
VCS.</li>
<li><strong>Suspended:</strong>The forge listing is not supported yet.</li>
</ul>
</div>
</div>
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment