← Back to branch summary

~pieq/checkbox/1624968-updated-docking-tests

« back to all changes in this revision

Viewing changes to checkbox-ng/docs/index.rst

  • Committer: Sylvain Pineau
  • Author(s): Maciej Kisielewski
  • Date: 2016-08-25 10:42:15 UTC
  • mfrom: (4473.1.14 launchpad/docs-rework)
  • Revision ID: sylvain_pineau-20160825104215-q33dadyxasqt33jf
"automatic merge of lp:~kissiel/checkbox/docs-rework/ by tarmac [r=cypressyew,jocave][bug=][author=kissiel]"

Show diffs side-by-side

added added

removed removed

Lines of Context:
checkbox-ng/docs/index.rst
1
 
.. CheckboxNG documentation master file, created by
 
1
.. Checkbox documentation master file, created by
2
2
   sphinx-quickstart on Wed Feb 13 11:18:39 2013.
3
3
   You can adapt this file completely to your liking, but it should at least
4
4
   contain the root `toctree` directive.
5
5
 
6
 
CheckboxNG
 
6
Checkbox
7
7
==========
8
8
 
9
 
CheckboxNG is a hardware testing tool useful for certifying laptops, desktops
10
 
and servers with Ubuntu. It is a new version of :term:`Checkbox` that is built
11
 
directly on top of :term:`PlainBox`
 
9
Checkbox is a flexible test automation software.
 
10
It's the main tool used in Ubuntu Certification program.
12
11
 
13
 
CheckboxNG *replaces* Checkbox, where applicable. 
 
12
You can use checkbox without any modification to check if your system is
 
13
behaving correctly or you can develop your own set of tests to check your
 
14
needs. See :ref:`tutorials` for details.
14
15
 
15
16
.. warning::
16
17
 
20
21
Installation
21
22
^^^^^^^^^^^^
22
23
 
23
 
CheckboxNG can be installed from a :abbr:`PPA (Personal Package Archive)`
 
24
Checkbox can be installed from a :abbr:`PPA (Personal Package Archive)`
24
25
(recommended) or :abbr:`pypi (python package index)` on Ubuntu Precise (12.04)
25
26
or newer.
26
27
 
27
28
.. code-block:: bash
28
29
 
29
 
    $ sudo add-apt-repository ppa:checkbox-dev/ppa && sudo apt-get update && sudo apt-get install checkbox-ng 
 
30
    $ sudo add-apt-repository ppa:hardware-certification/public && sudo apt-get update && sudo apt-get install checkbox-ng
30
31
 
31
32
Running stable release update tests
32
33
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
33
34
 
34
 
CheckboxNG has special support for running stable release updates tests in an
35
 
automated manner. This runs all the jobs from the *sru.whitelist* and sends the
 
35
Checkbox has special support for running stable release updates tests in an
 
36
automated manner. This runs all the jobs from the *sru.test plan* and sends the
36
37
results to the certification website.
37
38
 
38
39
To run SRU tests you will need to know the so-called :term:`Secure ID` of the
52
53
.. toctree::
53
54
   :maxdepth: 2
54
55
 
 
56
   tutorials.rst
55
57
   bugs.rst
56
58
   stack.rst
57
 
   changelog.rst
58
 
   scripts/index.rst
59
 
   profiles.rst
60
59
   launcher-tutorial.rst
61
60
   configs.rst
62
 
   release.rst
 
61
   snappy.rst
 
62
   testing-snappy.rst
63
63
 
64
64
Indices and tables
65
65
==================