Skip to content

Commit aa9877c

Browse files
committed
update docs
1 parent b9cfbe8 commit aa9877c

2 files changed

Lines changed: 4 additions & 5 deletions

File tree

docs/source/index.rst

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,6 @@ Enhance NUTS
4242
Since NUTS is written as a pytest plugin and in python, you can customize it yourself and write your own test classes. Please see the :doc:`development section <dev/index>` to see how NUTS is structured and how to write your own test classes.
4343

4444

45-
4645
Contents
4746
========
4847

docs/source/tutorial/firststeps.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
11
First Steps with NUTS
22
=====================
33

4-
This tutorial guides you through a minimal setup of NUTS.
4+
This tutorial guides you through a minimal setup of the NetTowel Unit Testing System (NUTS, or nuts).
55

6-
Two major components are needed for NUTS:
6+
Two major components are needed for nuts:
77

88
#. A network inventory
99
#. Test bundles
@@ -71,7 +71,7 @@ If you set up the above folders and files, you're ready to write test bundles.
7171

7272
A test bundle is a collection of tests are logically related to each other, for example tests that all revolve around "information on BGP neighbors". The test bundle describes which test definition should be collected and executed and provides data for those tests. The bundles are written as individual entries in a YAML file.
7373

74-
Currently only YAML files are supported as test bundle format, but other data sources could be integrated in later versions of NUTS.
74+
Currently only YAML files are supported as test bundle format, but other data sources could be integrated in later versions of nuts.
7575

7676
Structure of a Test Bundle
7777
**************************
@@ -93,7 +93,7 @@ Each test bundle contains the following structure:
9393
``label``: Optional. Additional identifier that can be used to distinguish between multiple occurrences of the same
9494
test class in a test bundle.
9595

96-
``test_execution``: Optional. NUTS uses nornir tasks to automatically interact with the network. This field contains additional information that is directly passed to the nornir task in the background. Therefore the key-value pairs must be consistent with the key-value pairs of the specific nornir task.
96+
``test_execution``: Optional. Nuts uses nornir tasks to automatically interact with the network. This field contains additional information that is directly passed to the nornir task in the background. Therefore the key-value pairs must be consistent with the key-value pairs of the specific nornir task.
9797
As an example, the test definition ``TestNapalmPing`` calls a nornir task to execute napalm's ping-command.
9898
This allows the additional ``count`` parameter in ``test execution``, since it is in turn pre-defined by napalm. Please see the :doc:`chapter on test bundles <../testbundles/alltestbundles>` for more detailed explanations.
9999

0 commit comments

Comments
 (0)