Skip to content

Commit

Permalink
Update docs for the Admin chapter
Browse files Browse the repository at this point in the history
  • Loading branch information
@atodorov
atodorov committed Oct 31, 2017
1 parent ae31f23 commit 619c283
Show file tree
Hide file tree
Showing 4 changed files with 55 additions and 62 deletions.
Binary file modified docs/source/_static/Click_Auth.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/source/_static/Click_Management.png
View file
Binary file not shown.
Binary file modified docs/source/_static/TC_Home.png
View file
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
117 changes: 55 additions & 62 deletions docs/source/guide/admin.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,16 @@
Administration
==============

The ADMIN tab allows administrators to manage:
The **ADMIN** menu allows administrators to manage:

- Entities
- Group and user permissions
- Test Plans and Test Cases
- Bug tracking systems
- and more ...

Kiwi TCMS admin interface is automatically generated by Django and allows the user
to add, edit and delete records in the databases.

|The Administration screen|

.. _configure-kiwi-base-url:
Expand All @@ -22,7 +24,7 @@ The first step you need to do is configure the base URL of your Kiwi TCMS
installation. This is used to construct links to test plans, test cases, etc.
The default value is ``127.0.0.1:8000`` which is suitable if you are running
in devel mode. To update the setting go to
``http://<your_domain_or_ip>/admin/sites/site/1/``!
``https://<your_domain_or_ip>/admin/sites/site/1/``!
In the text field enter the domain name or IR address, including port if
necessary and click the Save button!

Expand Down Expand Up @@ -58,6 +60,17 @@ created
* Tester - has all available permissions from the ``django_comments``,
``management``, ``testcases``, ``testruns`` and ``testplans`` applications.


**Default group permissions in Kiwi TCMS**

+----------------+----------------+----------------+----------------+----------------+
| Group | Test Plan | Test Case | Environment | Administration |
+================+================+================+================+================+
| Tester | Read / Write | Read / Write | Read / Write | - |
+----------------+----------------+----------------+----------------+----------------+
| Administrator | Read / Write | Read / Write | Read / Write | Read / Write |
+----------------+----------------+----------------+----------------+----------------+

Adding a group
^^^^^^^^^^^^^^

Expand All @@ -68,7 +81,7 @@ Procedure: Adding a group

To add a group:

#. From the **ADMIN** menu, click **Auth**.
#. From the **ADMIN** menu, click **Users and groups**.

|The Admin menu 1|

Expand Down Expand Up @@ -98,7 +111,7 @@ Procedure: Editing a group

To edit a group:

#. From the **ADMIN** menu, click **Auth**.
#. From the **ADMIN** menu, click **Users and groups**.
#. Click **Groups**.
#. From the Group list, click the group to edit.
#. Select the permission required. Click **Add** or **Remove** as
Expand All @@ -111,14 +124,14 @@ Users
Assigning administrator rights
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

A user with administrator rights can access the **ADMIN** tab.
A user with administrator rights can access the **ADMIN** menu.

Procedure: Assigning administrator rights
'''''''''''''''''''''''''''''''''''''''''

To assign administrator rights:

#. From the **ADMIN** menu, click **Auth**.
#. From the **ADMIN** menu, click **Users and groups**.
#. Click **Users**.
#. In the **Search Bar**, enter the username, and then click **Search**.
#. Click the **Username**.
Expand Down Expand Up @@ -147,7 +160,7 @@ Procedure: Assigning permissions

To assign permissions:

#. From the **ADMIN** menu, click **Auth**.
#. From the **ADMIN** menu, click **Users and groups**.
#. Click **Users**.
#. In the **Search Bar**, enter the username, and then click **Search**.
#. Click the **Username**.
Expand All @@ -171,7 +184,7 @@ Procedure: Adding a user to a group

To add a user to a group:

#. From the **ADMIN** menu, click **Auth**.
#. From the **ADMIN** menu, click **Users and groups**.
#. Click **Users**.
#. In the **Search Bar**, enter the username, and then click **Search**.
#. Click the **Username**.
Expand All @@ -188,7 +201,7 @@ Procedure: Updating personal information

To update personal information:

#. From the **ADMIN** menu, click **Auth**.
#. From the **ADMIN** menu, click **Users and groups**.
#. Click **Users**.
#. In the **Search Bar**, enter the username, and then click **Search**.
#. Click the **Username**.
Expand All @@ -203,15 +216,18 @@ To update personal information:
Deleting a user
^^^^^^^^^^^^^^^

Users can not be deleted from Kiwi TCMS. A user that is no longer required
must be disabled.
.. danger::

Users can be deleted from Kiwi TCMS however this will remove all database
records connected to this user. A user that is no longer required
must be disabled instead!

Procedure: Disabling a user
'''''''''''''''''''''''''''

To disable a user:

#. From the **ADMIN** menu, click **Auth**.
#. From the **ADMIN** menu, click **Users and groups**.
#. Click **Users**.
#. In the **Search Bar**, enter the username, and then click **Search**.
#. Click the **Username**.
Expand All @@ -221,24 +237,6 @@ To disable a user:

#. Click **Save**.

Access Control Lists
~~~~~~~~~~~~~~~~~~~~

Kiwi TCMS uses ACLs for the user groups: Guest, Tester, and Admin. The
permissions for each group can be controlled from the **Group** section
in the **AUTH** tab.

**Default ACLs in the TCMS.**

+----------------+----------------+----------------+----------------+----------------+
| Group | Test Plan | Test Case | Environment | Administration |
+================+================+================+================+================+
| Guest | Read | Read | - | - |
+----------------+----------------+----------------+----------------+----------------+
| Tester | Read / Write | Read / Write | Read / Write | - |
+----------------+----------------+----------------+----------------+----------------+
| Administrator | Read / Write | Read / Write | Read / Write | Read / Write |
+----------------+----------------+----------------+----------------+----------------+

Managing entities
-----------------
Expand Down Expand Up @@ -266,7 +264,7 @@ Procedure: Adding a build

To add a build:

#. From the **ADMIN** menu, click **Management**.
#. From the **ADMIN** menu, click **Everything else**.
#. Click **Builds**.
#. Click **Add build**.
#. In the **Add build** screen, perform the following actions:
Expand All @@ -289,7 +287,7 @@ Procedure: Editing a test build

To edit a test build:

#. From the **ADMIN** menu, click **Management**.
#. From the **ADMIN** menu, click **Everything else**.
#. Click **Test Build**.
#. Click the **ID** of the Test Build to be edited.
#. In the **Change Test Build** screen edit the following:
Expand All @@ -312,10 +310,7 @@ Procedure: Adding a classification

To add a classification:

#. From the **ADMIN** menu, click **Management**.

|The Admin menu 2|

#. From the **ADMIN** menu, click **Everything else**.
#. Click **Classifications**.
#. Click **Add classification**.
#. In the **Add classification** screen, perform the following actions:
Expand All @@ -333,7 +328,7 @@ Editing a classification

The name and description fields can be edited.

#. From the **ADMIN** menu, click **Management**.
#. From the **ADMIN** menu, click **Everything else**.
#. Click **Classification**.
#. Click the **ID** of the classification to edit.
#. In the **Change classification** screen edit the following:
Expand All @@ -348,14 +343,14 @@ Components
~~~~~~~~~~

A product is broken down into components. For example, two components of
RHEL 5 are glibc and gdm.
Kiwi TCMS are the web interface and the XML-RPC API service.

Procedure: Adding a component
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

To add a component:

#. From the **ADMIN** menu, click **Management**.
#. From the **ADMIN** menu, click **Everything else**.
#. Click **Components**.
#. Click **Add component**.
#. In the **Add component** screen, perform the following actions:
Expand All @@ -372,7 +367,7 @@ To add a component:

.. note::

**Creating entries** To create the fields Product, Initial Owner, or
To create the fields Product, Initial Owner, or
Initial QA Contact, click the green plus icon.

Editing a component
Expand All @@ -386,7 +381,7 @@ Procedure: Editing a component

To edit a component:

#. From the **ADMIN** menu, click **Management**.
#. From the **ADMIN** menu, click **Everything else**.
#. Click **Component**.
#. Click the **ID** of the component to be edited.
#. In the **Change component** screen edit the following:
Expand Down Expand Up @@ -414,7 +409,7 @@ Procedure: Adding a priority

To add a priority:

#. From the **ADMIN** menu, click **Management**.
#. From the **ADMIN** menu, click **Everything else**.
#. Click **Priorities**.
#. Click **Add priority**.
#. In the **Add priority** screen, perform the following actions:
Expand All @@ -437,7 +432,7 @@ Procedure: Editing a priority

To edit a priority:

#. From the **ADMIN** menu, click **Management**.
#. From the **ADMIN** menu, click **Everything else**.
#. Click **Priorities**.
#. From the **Id** column, click the priority to edit.
#. In the **Change priorities** screen, edit the following:
Expand All @@ -451,14 +446,14 @@ To edit a priority:
Products
~~~~~~~~

All testing is based around the products made by Red Hat.
All testing is based around products made by the organization.

Procedure: Adding a product
^^^^^^^^^^^^^^^^^^^^^^^^^^^

To add a product:

#. From the **ADMIN** menu, click **Management**.
#. From the **ADMIN** menu, click **Everything else**.
#. Click **Products**.
#. Click **Add product**.
#. In the **Add product** screen, perform the following actions:
Expand Down Expand Up @@ -486,7 +481,7 @@ Procedure: Editing a product

To edit a product:

#. From the **ADMIN** menu, click **Management**.
#. From the **ADMIN** menu, click **Everything else**.
#. Click **Products**.
#. Click the **ID** of the product to be edited.
#. In the **Change product** screen, edit the following:
Expand All @@ -510,7 +505,7 @@ Procedure: Adding a version

To add a version:

#. From the **ADMIN** menu, click **Management**.
#. From the **ADMIN** menu, click **Everything else**.
#. Click **Versions**.
#. Click **Add version**.
#. In the **Add version** screen, perform the following actions:
Expand All @@ -532,7 +527,7 @@ Procedure: Editing a version

To edit a version:

#. From the **ADMIN** menu, click **Management**.
#. From the **ADMIN** menu, click **Everything else**.
#. Click **Versions**.
#. Click the **ID** of the Version to be edited.
#. In the **Change version** screen, edit the following:
Expand Down Expand Up @@ -566,9 +561,9 @@ Procedure: Adding a Test Plan type

To add a Test Plan type:

#. From the **ADMIN** menu, click **Test Plans**.
#. Click **Test Plan Categories**.
#. Click **Add Test Plan Types**.
#. From the **ADMIN** menu, click **Everything else**.
#. Locate **Testplans** category.
#. Next to **Test Plan Types** click **Add** button.
#. In the **Add test plan type** screen, perform the following actions:

- Enter the **Name**.
Expand All @@ -583,7 +578,7 @@ Test plans

This screen provides a list of all the test plans in Kiwi TCMS. The **Add
test plan** link can be used to create a test plan. For more
information, see Creating a Test Plan.
information, see :ref:`creating-testplan`.

Managing Test Cases
-------------------
Expand All @@ -593,17 +588,16 @@ Cases.

|The Test Case management screen|

Test Case Bug Systems
Bug Trackers
~~~~~~~~~~~~~~~~~~~~~

The bug system for test cases is Red Hat Bugzilla. To view the details
click the **Test case bug systems**.
You can define bug tracking systems in this section!

Test Case categories
~~~~~~~~~~~~~~~~~~~~

A category is used to describe the type of test being performed. For
example, regression or bug verification.
example regression or bug verification.

Adding a Test Case category
^^^^^^^^^^^^^^^^^^^^^^^^^^^
Expand All @@ -615,9 +609,9 @@ Procedure: Adding a category

To add a category:

#. From the **ADMIN** menu, click **Test Cases**.
#. Click **Test case categories**.
#. Click **Add Test Case Category**.
#. From the **ADMIN** menu, click **Everything else**.
#. Locate **Testcases** category.
#. Next to **Test Case Category** click the **Add** button.
#. In the **Add test case category** screen, perform the following
actions:

Expand All @@ -634,7 +628,7 @@ Test cases

This screen provides a list of all the test cases in Kiwi TCMS. The **Add
test case** link can be used to create a test case. For more
information, see Creating a Test Case.
information, see :ref:`create-test-case`.

.. |The Administration screen| image:: ../_static/Admin_Home.png
.. |The Auth screen| image:: ../_static/Auth_Home.png
Expand All @@ -645,7 +639,6 @@ information, see Creating a Test Case.
.. |The Active checkbox| image:: ../_static/Disable_User.png
.. |The Management screen| image:: ../_static/Mgmt_Home.png
.. |The Add build screen| image:: ../_static/Add_Test_Build.png
.. |The Admin menu 2| image:: ../_static/Click_Management.png
.. |The Add classification screen| image:: ../_static/Add_Classification.png
.. |The Add component screen| image:: ../_static/Add_Component.png
.. |The Add priority screen| image:: ../_static/Add_Priority.png
Expand Down

0 comments on commit 619c283

Please sign in to comment.