Skip to content

Commit

Permalink
Add table of content for the Tutorial (Infra) (#710)
Browse files Browse the repository at this point in the history
* Rename base tutorial rst files

* Change rst markup of the test report tutorial

Switch to the same markup used for other rst files, otherwise the
generated HTML page does not behave the same (no links at the bottom to
the previous/next section).

* Update Tutorial table of content

* Add support page pointing to our mailing list

* Update "Project and community" section of the index

* Update index of the tutorial section

Fix CHECKBOX-791
  • Loading branch information
pieqq committed Sep 8, 2023
1 parent d47079a commit a1e16c3
Show file tree
Hide file tree
Showing 9 changed files with 28 additions and 16 deletions.
9 changes: 9 additions & 0 deletions docs/community/support.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
:orphan:

Getting support
===============

If you have any question related to Checkbox, please send an e-mail to our
`mailing list`_.

.. _mailing list: https://lists.ubuntu.com/mailman/listinfo/checkbox-devel
4 changes: 1 addition & 3 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -55,11 +55,9 @@ warmly welcomes community projects, contributions, suggestions, fixes and
constructive feedback.

* This project follows the `Ubuntu Code of Conduct`_
* :ref:`Get support <home>`
* :ref:`Join our online chat <home>`
* :doc:`Get support <community/support>`
* :doc:`Report bugs <community/bugs>`
* :doc:`Contribute <community/contributing>`
* :ref:`Thinking about using Checkbox for your next project? Get in touch! <home>`


.. toctree::
Expand Down
26 changes: 15 additions & 11 deletions docs/tutorial/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@ Tutorial
Checkbox is a complex piece of software.

This tutorial will introduce you to key concepts, tools, processes and
operations, starting from your first installation to a cloud deployment.
operations, starting from your first installation to the creation of your own
test cases.
Along the way it will give examples of good practice, and pointers to much
more detailed information.

Expand All @@ -13,27 +14,30 @@ tutorial. It’s a strongly-recommended investment of time if you’re new to
Checkbox - it will save you many more hours later on. Follow the tutorial steps
in sequence; they take you on a learning journey through the product.

The tutorial has been tested with a variety of users. We make every effort to
keep it up-to-date and ensure that it’s reliable - but if you encounter any
problems, we want to help you, so please let us know - `get support <#>`_.
The tutorial has been tested with a variety of users. We make every effort
to keep it up-to-date and ensure that it’s reliable - but if you encounter
any problems, we want to help you, so please let us know - :doc:`get support
<../community/support>`.

Core tutorial
Base tutorial
-------------

Follow the core tutorial steps in sequence; they take you on a learning
Follow the base tutorial steps in sequence; they take you on a learning
journey through the product.

.. toctree::
:maxdepth: 1

using-checkbox/basic-launcher
using-checkbox/test-output
using-checkbox/installing-checkbox
using-checkbox/running-checkbox
using-checkbox/test-report
using-checkbox/launcher
using-checkbox/manifest
using-checkbox/remote
using-checkbox/advanced-commands

Extended tutorial
-----------------

Once you have completed the core tutorial, the extended optional tutorial
sections can be followed in any order - they don’t depend on each other.

Follow the core tutorial steps in sequence; they take you on a learning journey
through the product.
File renamed without changes.
File renamed without changes.
5 changes: 3 additions & 2 deletions docs/tutorial/using-checkbox/test-report.rst
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
.. _test-report:

==================
Review Test Report
==================

Expand All @@ -19,7 +20,7 @@ respective contents.
.. _text-summary:

Text Summary
------------
============

You should see a text summary displayed in the console once all jobs are
completed. The result of each job is presented in the format: ``outcome:
Expand Down Expand Up @@ -62,7 +63,7 @@ will need to review submission files.
.. _submission-files:

Submission Files
----------------
================

In Checkbox, submission files encompass report files in various formats (HTML,
JSON, and JUnit XML) along with attachments like I/O logs and binary files.
Expand Down

0 comments on commit a1e16c3

Please sign in to comment.