Commits

Benoît Allard committed a095d1e

web/template: Add description to the lists.

Comments (0)

Files changed (7)

web/templates/binaries.html

 {% extends "list.html" %}
 
+{% block description %}
+<p>This is the list of <em>Binaries</em> BugLink knows. Binaries are the combination of <a href="{{ url_for('views.listbuilds') }}">Builds</a> and <a href="{{ url_for('views.listmodules') }}">Module</a>. This link is made when building a <a href="{{ url_for('views.listreleases') }}">Release</a>.</p>
+{% endblock %}
+
 {% block items %}
 {% for binary in binaries %}
   <li class="binary">

web/templates/builds.html

 {% extends "list.html" %}
 
+{% block description %}
+<p>This is the list of <em>Builds</em> BugLink knows. Builds are what happen when repositories comes together in a specific state (changeset). Builds are identified with a number, the <em>buildnumber</em>.</p>
+{% endblock %}
+
 {% block items %}
 {% for build in builds %}
   <li class="build">

web/templates/issues.html

 {% extends "list.html" %}
 
+{% block description %}
+<p>This is the list of <em>Issues</em> BugLink knows. To add issues to the list, you should link them with a changeset, either during development, or later on on this web interface (<tt>Edit</tt> > <tt>A link</tt>). Issues without changeset are only shown if they ever had a linked one.</p>
+{% endblock %}
+
 {% block items %}
 {% for issue in issues %}
   <li class="issue">

web/templates/list.html

 {% import "macros.j2" as macros %}
 
 {% block body %}
+{% block description %}{% endblock %}
 {{ macros.render_pagination(pagination)|safe }}
 <ul>
 {% block items %}<li>No items</li>{% endblock %}

web/templates/modules.html

 {% extends "list.html" %}
 
+{% block description %}
+<p>This is the list of <em>Modules</em> BugLink knows. A Module identify a possible outcome of a <a href="{{ url_for('views.listbuilds') }}">Build</a>, together, they form a <a href="{{ url_for('views.listbinaries') }}">Binary</a>. Modules are names for the artifacts that are delivered. While the artifact file name can be different on different platforms (<tt>libX.so</tt> vs. <tt>X.dll</tt> for instance), the module name remains the same.</p>
+{% endblock %}
+
 {% block items %}
 {% for module in modules %}
   <li class="module">

web/templates/releases.html

 {% extends "list.html" %}
 
+{% block description %}
+<p>This is the list of <em>Releases</em> BugLink knows. A Release is mostly grouping <a href="{{ url_for('views.listbinaries') }}">Binaries</a>. Some other data are taken from <a href="{{ url_for('views.listrepositories') }}">Repositories</a>. A Release is identified with a release number and a release candidate number. Some releases are only made for specific projects. BugLink provides a unique identifier for each release, uniquely identifying its components.</p>
+{% endblock %}
+
 {% block items %}
 {% for release in releases %}
   <li class="release">

web/templates/repositories.html

 {% extends "list.html" %}
 
+{% block description %}
+<p>This is the list of <em>Repositories</em> BugLink knows. A Repository lives in evolving states (changeset), and alllow for storage of raw data. Combined together they form <a href="{{ url_for('views.listbuilds') }}">Builds</a>. The raw data is also used during the making of a <a href="{{ url_for('views.listreleases') }}">Release</a>.</p>
+{% endblock %}
+
 {% block items %}
 {% for repo in repositories %}
   <li class="repository">