testrail_bot/control/templates/control/help.html

{% extends "base.html" %}
{% load static %}
{% block section %}
<h1 class="display-1 text-center">How to use</h1>
<div class="col-xs-8">
    <h3 class="display-3 text-center">Create Run</h3>
    <ul>
        <li>
            Open <a href="{% url 'create_run' %}"><code>Create New Test Run</code></a> page.
            <img style="width:100%" src="{% static 'control/help_1.png' %}"/>
        </li>
        <li>
            Fill input forms:
            <ol>
                <li>Enter Project name or use default <code>Mirantis Cloud Platform</code></li>
                <li>Enter Plan name without date or use default <code>[MCP2.0]OSCORE</code></li>
                <li>Enter full name of the run (not required field)<code>ussuri-core-ceph-ceph-dvr <[MCP2.0_USSURI]Tempest></code></li>
                <li>Enter ID of the run, for example(without letters) <code> 129304 </code></li>
                <li>Fill created_by_id column or use default <code>109</code></li>
                <li>(Optional) Enter custom filtration function.
                    If not used it should be empty. If used, the function definition should be like:
                    <pre>
def custom_filter(data):
    ...
    return modified_data</pre>
                </li>
                <li>Select <code>change ip to x.x.x.x</code> to replace all ip addresses to x.x.x.x</li>
                <li>Select <code>change uuid to xxxx</code> to change all uuids to xxxx</li>
                <li>Select <code>Use only last traceback to compare comments</code> to use data located after last <code>Traceback:</code></li>
                <li>Click save to save record and run it later</li>
            </ol>
        </li>

    </ul>
</div>
<div class="col-xs-8">
    <h3 class="display-3 text-center">Change Run</h3>
    <ul>
        <li>Open <a href="{% url 'index' %}"><code>Test Runs</code></a> page</li>
        <li>
            Select run that you want to change from list of available runs.
            <img style="width:100%" src="{% static 'control/help_2.png' %}"/>
        </li>
        <li>
            Change fields like it's described in Create Run How To.
        </li>
        <li>Click <code>Save</code></li>
    </ul>
</div>
<div class="col-xs-8">
    <h3 class="display-3 text-center">Submit Run</h3>
    <ul>
        <li>Open <a href="{% url 'index' %}"><code>Test Runs</code></a> page</li>
        <li>
            Select run that you want to change from list of available runs.
            <img style="width:100%" src="{% static 'control/help_2.png' %}"/>
        </li>
        <li>Click <code>Submit</code></li>
        <li>You will be redirected to report for this run, where you can view how test run is being processed.</li>
    </ul>
</div>
<div class="col-xs-8">
    <h3 class="display-3 text-center">Generate Report</h3>
    <ul>
        <li>Open <a href="{% url 'list_reports' %}"><code>Reports</code></a> page</li>
        <li>
            Select report that you want to view.
            <img style="width:100%" src="{% static 'control/help_3.png' %}"/>
        </li>
    </ul>
</div>
{% endblock %}