Skip to content
This repository has been archived by the owner on Jan 19, 2022. It is now read-only.

Commit

Permalink
Browse files Browse the repository at this point in the history
Merge pull request #28 from rbillings/tutorial
Tidied up my nits about capitalization, end sentences with periods, typo...
  • Loading branch information
camd committed Apr 2, 2013
2 parents aa52420 + c2524d1 commit 85060a3
Show file tree
Hide file tree
Showing 5 changed files with 94 additions and 93 deletions.
50 changes: 25 additions & 25 deletions docs/userguide/tutorial/create_cases.rst
Expand Up @@ -18,11 +18,11 @@ update your SpeckDetector's firmware.


Steps Steps
^^^^^ ^^^^^
#. navigate to ``manage | suites`` #. Navigate to ``manage | suites``.
#. click ``create a test suite`` #. Click ``create a test suite``.
#. set your product to ``SpeckDetector`` #. Set your product to ``SpeckDetector``.
#. set name to ``Specks`` #. Set name to ``Specks``.
#. enter a description that includes Markdown_ syntax:: #. Enter a description that includes Markdown_ syntax::


PRECONDITIONS PRECONDITIONS
============= =============
Expand All @@ -32,9 +32,9 @@ Steps
===== =====
* [Specks of Life](http://example.com/) * [Specks of Life](http://example.com/)


#. you won't have any available cases yet, so skip that and just #. You won't have any available cases yet, so skip that and just
click ``save suite`` click ``save suite``.
#. repeat these steps for a suite but name it ``Firmware`` #. Repeat these steps for a suite but name it ``Firmware``.


Create test Cases Create test Cases
----------------- -----------------
Expand All @@ -43,49 +43,49 @@ Now we need to create some test cases for those suites.


Steps Steps
^^^^^ ^^^^^
#. navigate to ``manage | cases`` #. Navigate to ``manage | cases``.
#. click ``create a test case`` #. Click ``create a test case``.
#. set your product to ``SpeckDetector`` #. Set your product to ``SpeckDetector``.
#. set version to ``1.0`` #. Set version to ``1.0``.
#. set suite to ``Specks`` #. Set suite to ``Specks``.
#. :ref:`ID Prefix<test-case-edit-fields>` is optional, skip it for now #. :ref:`ID Prefix<test-case-edit-fields>` is optional, skip it for now.
#. set name to ``Detect a pollen speck`` #. Set name to ``Detect a pollen speck``.
#. for ``instruction`` 1, enter:: #. For ``instruction`` 1, enter::


hold detector held away from pollen hold detector held away from pollen


#. for ``expected`` 1, enter:: #. For ``expected`` 1, enter::


no detection lights no detection lights


#. tab to ``instruction`` 2, enter:: #. Tab to ``instruction`` 2, enter::


hold detector above a pollen speck hold detector above a pollen speck


#. tab to ``expected`` 2, enter:: #. Tab to ``expected`` 2, enter::


detector lights up word "pollen" 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`` That's one down. Whew! OK, now create another test case for the ``firmware``
suite with steps like this: suite with steps like this:


#. name: ``update firmware`` #. Name: ``update firmware``.
#. for ``instruction`` 1, enter:: #. For ``instruction`` 1, enter::


navigate to firmware update screen and select "update" navigate to firmware update screen and select "update"


#. for ``expected`` 1, enter:: #. For ``expected`` 1, enter::


see "a firmware update is available" see "a firmware update is available"


#. tab to ``instruction`` 2, enter:: #. Tab to ``instruction`` 2, enter::


click "apply update" click "apply update"


#. tab to ``expected`` 2, enter:: #. Tab to ``expected`` 2, enter::


firmware value should say the new version firmware value should say the new version


Expand Down
40 changes: 20 additions & 20 deletions docs/userguide/tutorial/create_product.rst
Expand Up @@ -25,25 +25,25 @@ before continuing.
To create a new environment profile customized to your needs, follow these To create a new environment profile customized to your needs, follow these
steps: steps:


#. navigate to ``manage | environments`` #. Navigate to ``manage | environments``:
* |manage_environments| * |manage_environments|
#. click ``create a profile`` #. Click ``create a profile``.
#. give your profile the name ``Speck Envs`` #. Give your profile the name ``Speck Envs``.
#. .. note:: #. .. note::


Depending on your setup, you may have several Depending on your setup, you may have several
:ref:`environment elements<environment-elements>` in your system already. :ref:`environment elements<environment-elements>` in your system already.


If you see a category that applies to your product already, then expand 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| 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| #. In our case, we'll need to create everything, so click |add_category|
and type ``location`` and hit enter and type ``location`` and hit enter.
#. in the category, find the field that says |add_element| and type #. In the category, find the field that says |add_element| and type
``laboratory`` and hit "enter" ``laboratory`` and hit "enter".
#. add another element called ``field`` and hit enter #. Add another element called ``field`` and hit enter.
#. make sure to check the ``location`` category and all its elements #. Make sure to select the ``location`` category checkbox and all its elements.
#. click ``save profile`` #. Click ``save profile``.


.. note:: .. note::


Expand All @@ -56,9 +56,9 @@ steps:


To winnow down the list of environments to test: To winnow down the list of environments to test:


#. click the edit |edit_icon| icon next to your environment profile. #. Click the edit |edit_icon| icon next to your environment profile.
#. exclude any environment by clicking the **X** next to it. #. Exclude any environment by clicking the **X** next to it.
#. click ``done editing`` #. Click ``done editing``.




Create a Product Create a Product
Expand All @@ -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**. We will presume your product is called **SpeckDetector**.
It detects specks. Very handy. It detects specks. Very handy.


#. navigate to ``manage | products``: #. Navigate to ``manage | products``:
* |manage_products| * |manage_products|
#. click ``create a product`` #. Click ``create a product``.
#. fill out the name and description #. Fill out the name and description.
#. set version to 1.0. see :ref:`Product Versions <product-versions>` #. Set version to 1.0. see :ref:`Product Versions <product-versions>`
for more info on how version naming works. 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. you can optionally leave it blank and add them later.
#. click save #. Click save.
#. you now have a product and version! #. You now have a product and version!


.. |manage_environments| image:: img/manage_environments.png .. |manage_environments| image:: img/manage_environments.png
:height: 50px :height: 50px
Expand Down
22 changes: 11 additions & 11 deletions docs/userguide/tutorial/create_runs.rst
Expand Up @@ -21,11 +21,11 @@ suites you have created so far. Let's call this ``feature complete``.


Steps Steps
^^^^^ ^^^^^
#. navigate to ``manage | runs`` #. Navigate to ``manage | runs``.
#. click ``create a test run`` #. Click ``create a test run``.
#. set your product version to ``SpeckDetector 1.0`` #. Set your product version to ``SpeckDetector 1.0``.
#. set name to ``feature complete`` #. Set name to ``feature complete``.
#. enter a description that includes Markdown_ syntax. This information #. Enter a description that includes Markdown_ syntax. This information
will be displayed at the top of each page while running the tests:: will be displayed at the top of each page while running the tests::


LINKS LINKS
Expand All @@ -39,8 +39,8 @@ Steps
what a :ref:`run series<test-run-series>` is. what a :ref:`run series<test-run-series>` is.
#. Leave the ``start`` date as today. If you want the run to expire, then #. Leave the ``start`` date as today. If you want the run to expire, then
set the ``end`` date, too. set the ``end`` date, too.
#. drag both suites from ``available`` to ``included`` #. Drag both suites from ``available`` to ``included``.
#. click ``save run`` #. Click ``save run``.




Activate your Run Activate your Run
Expand All @@ -54,11 +54,11 @@ Why not have test runs active all the time? Good question.


Steps Steps
^^^^^ ^^^^^
#. navigate to ``manage | runs`` #. Navigate to ``manage | runs``.
#. find your test run ``feature complete`` #. Find your test run ``feature complete``.
#. click the status icon #. Click the status icon.
* |run_activate| * |run_activate|
#. click "Activate" #. Click "Activate".


.. |run_activate| image:: img/run_activate.png .. |run_activate| image:: img/run_activate.png
:height: 150px :height: 150px
Expand Down
34 changes: 17 additions & 17 deletions docs/userguide/tutorial/new_version.rst
Expand Up @@ -14,14 +14,14 @@ version 2.0 of the **SpeckDetector**.
Steps Steps
^^^^^ ^^^^^


#. navigate to ``Manage | Versions`` #. Navigate to ``Manage | Versions``.
#. click the "create a version" button #. Click the "create a version" button.
#. set the product to the ``SpeckDetector`` #. Set the product to the ``SpeckDetector``.
#. specify the version to copy Environments and Cases from. In our case, #. Specify the version to copy Environments and Cases from. In our case,
this will be ``1.0`` this will be ``1.0``.
#. type in the name of the new Version. In our case: ``2.0`` #. Type in the name of the new Version. In our case: ``2.0``.
#. codename is optional. #. Codename is optional.
#. click the "save productversion" button #. Click the "save productversion" button.




Result Result
Expand All @@ -42,17 +42,17 @@ make copies of runs from one to the other.


Steps Steps
^^^^^ ^^^^^
#. navigate to ``Manage | Runs`` #. Navigate to ``Manage | Runs``.
#. find the test run you want to use in 2.0 #. Find the test run you want to use in 2.0.
#. click the clone button for that run #. Click the clone button for that run.
#. The new run will have the name "Cloned: foo" and be in DRAFT mode #. 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 #. Edit the newly cloned run. **Note:** It must be in DRAFT mode to change
the product version field. the product version field.
#. Update the name as you wish #. Update the name as you wish.
#. change the Product Version field to the new version 2.0: #. Change the Product Version field to the new version 2.0:
* |product_version| * |product_version|
#. save as status active, or... #. Save as status active, or...
#. activate the new run with the status drop-down. #. Activate the new run with the status drop-down.


Result Result
^^^^^^ ^^^^^^
Expand Down
41 changes: 21 additions & 20 deletions docs/userguide/tutorial/start_testing.rst
Expand Up @@ -13,53 +13,54 @@ There are a few ways to get to your test run to execute it.


Run Tests Steps Run Tests Steps
^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^
#. navigate to ``run tests`` #. Navigate to ``run tests``.
#. in the finder, click ``SpeckDetector`` #. In the finder, click ``SpeckDetector``.
#. click ``1.0`` #. Click ``1.0``.
#. click ``feature complete`` #. Click ``feature complete``.
#. This is a :ref:`run series<test-run-series>` so you will be asked to enter #. 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. a ``build``. Let's pretend this is your 5th feature complete build.
Here type: ``FC-5`` Here type: ``FC-5``
#. set ``location`` to ``field`` #. Set ``location`` to ``field``.
#. click ``run tests in feature complete`` #. Click ``run tests in feature complete``.




Manage Runs Steps Manage Runs Steps
^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^
#. navigate to ``manage | runs`` #. Navigate to ``manage | runs``.
#. find the ``feature complete`` run #. Find the ``feature complete`` run.
#. expand the arrow on the left to display the details of that 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`` #. Click the green button that says ``run tests in feature complete``.
#. .. note:: #. .. note::
if you want to send this URL to your testers in an email, then just 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``. 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 "I got a URL!" Steps
^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^
#. If somebody gave you a URL to their run or run series, then click on it. #. 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 Pass a Test
----------- -----------
Some tests pass, some fail. This is the way of the world. Let's pass this Some tests pass, some fail. This is the way of the world. Let's pass this
one. one.


#. Click the title or expansion arrow of ``update firmware`` #. Click the title or expansion arrow of ``update firmware``.
#. Click ``pass test`` #. Click ``pass test``.
#. that was easy #. That was easy.


Fail a Test 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. #. 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 We applied the cortical electrodes but were
a neural reaction from the pollen speck. 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. that up to you.




Expand Down

0 comments on commit 85060a3

Please sign in to comment.