Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Merge branch 'master' into dev

  • Loading branch information...
commit d65c140d52c03adefc20a6401b18276ab9590b4d 2 parents 9a3a954 + 85060a3
camd camd authored
50 docs/userguide/tutorial/create_cases.rst
View
@@ -18,11 +18,11 @@ update your SpeckDetector's firmware.
Steps
^^^^^
- #. navigate to ``manage | suites``
- #. click ``create a test suite``
- #. set your product to ``SpeckDetector``
- #. set name to ``Specks``
- #. enter a description that includes Markdown_ syntax::
+ #. Navigate to ``manage | suites``.
+ #. Click ``create a test suite``.
+ #. Set your product to ``SpeckDetector``.
+ #. Set name to ``Specks``.
+ #. Enter a description that includes Markdown_ syntax::
PRECONDITIONS
=============
@@ -32,9 +32,9 @@ Steps
=====
* [Specks of Life](http://example.com/)
- #. you won't have any available cases yet, so skip that and just
- click ``save suite``
- #. repeat these steps for a suite but name it ``Firmware``
+ #. You won't have any available cases yet, so skip that and just
+ click ``save suite``.
+ #. Repeat these steps for a suite but name it ``Firmware``.
Create test Cases
-----------------
@@ -43,49 +43,49 @@ Now we need to create some test cases for those suites.
Steps
^^^^^
- #. navigate to ``manage | cases``
- #. click ``create a test case``
- #. set your product to ``SpeckDetector``
- #. set version to ``1.0``
- #. set suite to ``Specks``
- #. :ref:`ID Prefix<test-case-edit-fields>` is optional, skip it for now
- #. set name to ``Detect a pollen speck``
- #. for ``instruction`` 1, enter::
+ #. Navigate to ``manage | cases``.
+ #. Click ``create a test case``.
+ #. Set your product to ``SpeckDetector``.
+ #. Set version to ``1.0``.
+ #. Set suite to ``Specks``.
+ #. :ref:`ID Prefix<test-case-edit-fields>` is optional, skip it for now.
+ #. Set name to ``Detect a pollen speck``.
+ #. For ``instruction`` 1, enter::
hold detector held away from pollen
- #. for ``expected`` 1, enter::
+ #. For ``expected`` 1, enter::
no detection lights
- #. tab to ``instruction`` 2, enter::
+ #. Tab to ``instruction`` 2, enter::
hold detector above a pollen speck
- #. tab to ``expected`` 2, enter::
+ #. Tab to ``expected`` 2, enter::
detector lights up word "pollen"
- #. click ``save test case``
+ #. Click ``save test case``.
That's one down. Whew! OK, now create another test case for the ``firmware``
suite with steps like this:
- #. name: ``update firmware``
- #. for ``instruction`` 1, enter::
+ #. Name: ``update firmware``.
+ #. For ``instruction`` 1, enter::
navigate to firmware update screen and select "update"
- #. for ``expected`` 1, enter::
+ #. For ``expected`` 1, enter::
see "a firmware update is available"
- #. tab to ``instruction`` 2, enter::
+ #. Tab to ``instruction`` 2, enter::
click "apply update"
- #. tab to ``expected`` 2, enter::
+ #. Tab to ``expected`` 2, enter::
firmware value should say the new version
40 docs/userguide/tutorial/create_product.rst
View
@@ -25,10 +25,10 @@ before continuing.
To create a new environment profile customized to your needs, follow these
steps:
- #. navigate to ``manage | environments``
+ #. Navigate to ``manage | environments``:
* |manage_environments|
- #. click ``create a profile``
- #. give your profile the name ``Speck Envs``
+ #. Click ``create a profile``.
+ #. Give your profile the name ``Speck Envs``.
#. .. note::
Depending on your setup, you may have several
@@ -36,14 +36,14 @@ steps:
If you see a category that applies to your product already, then expand
It to choose the elements that apply. If not, then click |add_category|
- to create a new one
+ to create a new one.
#. In our case, we'll need to create everything, so click |add_category|
- and type ``location`` and hit enter
- #. in the category, find the field that says |add_element| and type
- ``laboratory`` and hit "enter"
- #. add another element called ``field`` and hit enter
- #. make sure to check the ``location`` category and all its elements
- #. click ``save profile``
+ and type ``location`` and hit enter.
+ #. In the category, find the field that says |add_element| and type
+ ``laboratory`` and hit "enter".
+ #. Add another element called ``field`` and hit enter.
+ #. Make sure to select the ``location`` category checkbox and all its elements.
+ #. Click ``save profile``.
.. note::
@@ -56,9 +56,9 @@ steps:
To winnow down the list of environments to test:
- #. click the edit |edit_icon| icon next to your environment profile.
- #. exclude any environment by clicking the **X** next to it.
- #. click ``done editing``
+ #. Click the edit |edit_icon| icon next to your environment profile.
+ #. Exclude any environment by clicking the **X** next to it.
+ #. Click ``done editing``.
Create a Product
@@ -68,16 +68,16 @@ Now that you have your environment profile setup, let's create your product.
We will presume your product is called **SpeckDetector**.
It detects specks. Very handy.
- #. navigate to ``manage | products``:
+ #. Navigate to ``manage | products``:
* |manage_products|
- #. click ``create a product``
- #. fill out the name and description
- #. set version to 1.0. see :ref:`Product Versions <product-versions>`
+ #. Click ``create a product``.
+ #. Fill out the name and description.
+ #. Set version to 1.0. see :ref:`Product Versions <product-versions>`
for more info on how version naming works.
- #. set the environment to the environment profile you created earlier. Or
+ #. Set the environment to the environment profile you created earlier. Or
you can optionally leave it blank and add them later.
- #. click save
- #. you now have a product and version!
+ #. Click save.
+ #. You now have a product and version!
.. |manage_environments| image:: img/manage_environments.png
:height: 50px
22 docs/userguide/tutorial/create_runs.rst
View
@@ -21,11 +21,11 @@ suites you have created so far. Let's call this ``feature complete``.
Steps
^^^^^
- #. navigate to ``manage | runs``
- #. click ``create a test run``
- #. set your product version to ``SpeckDetector 1.0``
- #. set name to ``feature complete``
- #. enter a description that includes Markdown_ syntax. This information
+ #. Navigate to ``manage | runs``.
+ #. Click ``create a test run``.
+ #. Set your product version to ``SpeckDetector 1.0``.
+ #. Set name to ``feature complete``.
+ #. Enter a description that includes Markdown_ syntax. This information
will be displayed at the top of each page while running the tests::
LINKS
@@ -39,8 +39,8 @@ Steps
what a :ref:`run series<test-run-series>` is.
#. Leave the ``start`` date as today. If you want the run to expire, then
set the ``end`` date, too.
- #. drag both suites from ``available`` to ``included``
- #. click ``save run``
+ #. Drag both suites from ``available`` to ``included``.
+ #. Click ``save run``.
Activate your Run
@@ -54,11 +54,11 @@ Why not have test runs active all the time? Good question.
Steps
^^^^^
- #. navigate to ``manage | runs``
- #. find your test run ``feature complete``
- #. click the status icon
+ #. Navigate to ``manage | runs``.
+ #. Find your test run ``feature complete``.
+ #. Click the status icon.
* |run_activate|
- #. click "Activate"
+ #. Click "Activate".
.. |run_activate| image:: img/run_activate.png
:height: 150px
34 docs/userguide/tutorial/new_version.rst
View
@@ -14,14 +14,14 @@ version 2.0 of the **SpeckDetector**.
Steps
^^^^^
- #. navigate to ``Manage | Versions``
- #. click the "create a version" button
- #. set the product to the ``SpeckDetector``
- #. specify the version to copy Environments and Cases from. In our case,
- this will be ``1.0``
- #. type in the name of the new Version. In our case: ``2.0``
- #. codename is optional.
- #. click the "save productversion" button
+ #. Navigate to ``Manage | Versions``.
+ #. Click the "create a version" button.
+ #. Set the product to the ``SpeckDetector``.
+ #. Specify the version to copy Environments and Cases from. In our case,
+ this will be ``1.0``.
+ #. Type in the name of the new Version. In our case: ``2.0``.
+ #. Codename is optional.
+ #. Click the "save productversion" button.
Result
@@ -42,17 +42,17 @@ make copies of runs from one to the other.
Steps
^^^^^
- #. navigate to ``Manage | Runs``
- #. find the test run you want to use in 2.0
- #. click the clone button for that run
- #. The new run will have the name "Cloned: foo" and be in DRAFT mode
- #. edit the newly cloned run. **Note:** It must be in DRAFT mode to change
+ #. Navigate to ``Manage | Runs``.
+ #. Find the test run you want to use in 2.0.
+ #. Click the clone button for that run.
+ #. The new run will have the name "Cloned: foo" and be in DRAFT mode.
+ #. Edit the newly cloned run. **Note:** It must be in DRAFT mode to change
the product version field.
- #. Update the name as you wish
- #. change the Product Version field to the new version 2.0:
+ #. Update the name as you wish.
+ #. Change the Product Version field to the new version 2.0:
* |product_version|
- #. save as status active, or...
- #. activate the new run with the status drop-down.
+ #. Save as status active, or...
+ #. Activate the new run with the status drop-down.
Result
^^^^^^
41 docs/userguide/tutorial/start_testing.rst
View
@@ -13,53 +13,54 @@ There are a few ways to get to your test run to execute it.
Run Tests Steps
^^^^^^^^^^^^^^^
- #. navigate to ``run tests``
- #. in the finder, click ``SpeckDetector``
- #. click ``1.0``
- #. click ``feature complete``
+ #. Navigate to ``run tests``.
+ #. In the finder, click ``SpeckDetector``.
+ #. Click ``1.0``.
+ #. Click ``feature complete``.
#. This is a :ref:`run series<test-run-series>` so you will be asked to enter
a ``build``. Let's pretend this is your 5th feature complete build.
Here type: ``FC-5``
- #. set ``location`` to ``field``
- #. click ``run tests in feature complete``
+ #. Set ``location`` to ``field``.
+ #. Click ``run tests in feature complete``.
Manage Runs Steps
^^^^^^^^^^^^^^^^^
- #. navigate to ``manage | runs``
- #. find the ``feature complete`` run
- #. expand the arrow on the left to display the details of that run
- #. click the green button that says ``run tests in feature complete``
+ #. Navigate to ``manage | runs``.
+ #. Find the ``feature complete`` run.
+ #. Expand the arrow on the left to display the details of that run.
+ #. Click the green button that says ``run tests in feature complete``.
#. .. note::
if you want to send this URL to your testers in an email, then just
right-click that same button and select ``copy link location``.
- #. specify your environment, as above.
+ #. Specify your environment, as above.
"I got a URL!" Steps
^^^^^^^^^^^^^^^^^^^^
#. If somebody gave you a URL to their run or run series, then click on it.
- #. specify your environment, as above.
+ #. Specify your environment, as above.
Pass a Test
-----------
Some tests pass, some fail. This is the way of the world. Let's pass this
one.
- #. Click the title or expansion arrow of ``update firmware``
- #. Click ``pass test``
- #. that was easy
+ #. Click the title or expansion arrow of ``update firmware``.
+ #. Click ``pass test``.
+ #. That was easy.
Fail a Test
-----------
- #. Click the title or expansion arrow of ``Detect a pollen speck``
+ #. Click the title or expansion arrow of ``Detect a pollen speck``.
#. Click ``fail test`` next to the first step.
- #. you must provide some explanation for the failure::
+ #. You must provide some explanation for the failure::
- We applied the cortical electrodes but were unable to get
- a neural reaction from the pollen speck.
+ We applied the cortical electrodes but were
+ unable to get a neural reaction from the
+ pollen speck.
- #. speficying a bug URL is optional, but it's a good idea. I'll leave
+ #. Specifying a bug URL is optional, but it's a good idea. I'll leave
that up to you.
Please sign in to comment.
Something went wrong with that request. Please try again.