Skip to content

Commit

Permalink
Fix errors in documentation (Infra) (#825)
Browse files Browse the repository at this point in the history
Fixed errors in documentation

- Bad route in CONTRIBUTING.md
- Removed TODO in launcher.rst
- Changed user and add last step to not upload the report in
  running-checkbox.rst
- Changed outcome and added correct report in rest-report.rst
  • Loading branch information
fernando79513 authored Nov 13, 2023
1 parent b904dc6 commit c65ee69
Show file tree
Hide file tree
Showing 5 changed files with 28 additions and 15 deletions.
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ Create and activate the Python virtual environment:
``` bash
$ cd ~/checkbox/checkbox-ng
$ ./mk-venv
$ . ~/checkbox-ng/venv/bin/activate
$ . ~/checkbox/checkbox-ng/venv/bin/activate
```

Activate the base providers in the virtual environment from within the virtual
Expand Down
Binary file added docs/_images/checkbox-tutorial-test-report.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions docs/tutorial/using-checkbox/launcher.rst
Original file line number Diff line number Diff line change
Expand Up @@ -215,7 +215,7 @@ in it:
stock_reports = text, submission_files
[test plan]
unit = com.canonical.certification::TODO
unit = com.canonical.certification::tutorial-base
forced = yes
[test selection]
Expand Down Expand Up @@ -261,7 +261,7 @@ and where it comes from. Run the following command:
[test plan]
filter=* (Default)
forced=True From config file: /home/user/.config/checkbox.conf
unit=com.canonical.certification::TODO From config file: /home/user/.config/checkbox.conf
unit=com.canonical.certification::tutorial-base From config file: /home/user/.config/checkbox.conf
[test selection]
exclude= (Default)
forced=True From config file: /home/user/.config/checkbox.conf
Expand Down
9 changes: 6 additions & 3 deletions docs/tutorial/using-checkbox/running-checkbox.rst
Original file line number Diff line number Diff line change
Expand Up @@ -393,13 +393,16 @@ Under the summary, you can see 3 additional lines:

.. code-block:: none
file:///home/pieq/.local/share/checkbox-ng/submission_2023-09-06T03.33.14.551448.html
file:///home/pieq/.local/share/checkbox-ng/submission_2023-09-06T03.33.14.551448.junit.xml
file:///home/pieq/.local/share/checkbox-ng/submission_2023-09-06T03.33.14.551448.tar.xz
file:///home/user/.local/share/checkbox-ng/submission_2023-09-06T03.33.14.551448.html
file:///home/user/.local/share/checkbox-ng/submission_2023-09-06T03.33.14.551448.junit.xml
file:///home/user/.local/share/checkbox-ng/submission_2023-09-06T03.33.14.551448.tar.xz
These are the test reports and submission archives generated by Checkbox
for this run.

You will also be asked if you want to submit the report. You can mark `no` for
the moment by pressing ``n`` and then hitting ``Enter``.

As text summary only provides an overview, for more in-depth
information, you will need to review submission files (the files such as
``submission_2023-09-06T03.33.14.551448.tar.xz`` in the output above).
Expand Down
28 changes: 19 additions & 9 deletions docs/tutorial/using-checkbox/test-report.rst
Original file line number Diff line number Diff line change
Expand Up @@ -28,11 +28,14 @@ summary``, and it looks like:

.. code-block:: none
☐ : Resource for NVDIMM detection
☑ : Display USB devices attached to SUT
☒ : Test USB 2.0 or 1.1 ports
☑ : Collect information about supported types of USB
☒ : Test USB 3.0 or 3.1 ports
☑ : A job that always passes
☒ : A job that always fails
⚠ : A job that always crashes
☑ : A job that depends on other job that passes
☐ : A job that is skipped because it depends on a job that fails
☑ : A job that generates different resources for tutorial purposes
☑ : A job that requires a resource and it is available
...
Checkout this table to map outcome symbols to their corresponding descriptions:

Expand Down Expand Up @@ -101,11 +104,18 @@ Now, let's explore each of the submission files together!
- System Information
- Tests Results
- Logs

.. figure:: ../../_images/checkbox-tutorial-test-report.png

Tutorial HTML report


You can expand entries in Tests Results and Logs sections to access more
detailed information. Additionally, you can utilize *search bar* to filter
specific tests for easier navigation. For instance, type "audio" in the
search bar to view all test results related to audio testing.
You can expand entries in Tests Results and Logs sections to access more
detailed information.

Additionally, if the report is more complex, you can utilize the *search bar* to
filter specific tests for easier navigation. For instance, if you type "audio"
in the search bar, you can view all test results related to audio testing.

.. figure:: ../../_images/checkbox-test-report.png

Expand Down

0 comments on commit c65ee69

Please sign in to comment.