Skip to content
Permalink
Browse files

Merge pull request #551 from ejoerns/topic/getting-started-overview-l…

…inking

doc: Link 'Overview' Chapters From 'Getting Started' Chapter
  • Loading branch information
jluebbe committed Jan 6, 2020
2 parents c6b660b + d873d11 commit 0cdf2933f4aa4cf167ffe3795f6c59b84293725a
Showing with 15 additions and 4 deletions.
  1. +7 −4 doc/getting_started.rst
  2. +8 −0 doc/overview.rst
@@ -3,6 +3,8 @@ Getting Started

This section of the manual contains introductory tutorials for installing
labgrid, running your first test and setting up the distributed infrastructure.
For an overview about the basic design and components of `labgrid`, read the
:ref:`overview` first.

Installation
------------
@@ -162,11 +164,12 @@ The HTML documentation is written to ``doc/.build/html/``.
Setting Up the Distributed Infrastructure
-----------------------------------------

The labgrid distributed infrastructure consists of three components:
The labgrid :ref:`distributed infrastructure <remote-resources-and-places>`
consists of three components:

#. Coordinator
#. Exporter
#. Client
#. :ref:`overview-coordinator`
#. :ref:`overview-exporter`
#. :ref:`overview-client`

The system needs at least one coordinator and exporter, these can run on the
same machine. The client is used to access functionality provided by an
@@ -1,3 +1,5 @@
.. _overview:

Overview
========

@@ -220,6 +222,8 @@ implementation `Autobahn <http://autobahn.ws/>`_ and the `Crossbar
The following sections describe the resposibilities of each component. See
:ref:`remote-usage` for usage information.

.. _overview-coordinator:

Coordinator
~~~~~~~~~~~

@@ -281,6 +285,8 @@ client host has currently acquired the place.
The resource matches are only evaluated while a place is being acquired and cannot be
changed until it is `released` again.

.. _overview-exporter:

Exporter
~~~~~~~~
An exporters registers all its configured resources when it connects to the
@@ -300,6 +306,8 @@ published as declared in the configuration file.
This is useful to register externally configured resources such as network
power switches or serial port servers with a labgrid coordinator.

.. _overview-client:

Client
~~~~~~
The client requests the current lists of resources and places from the

0 comments on commit 0cdf293

Please sign in to comment.
You can’t perform that action at this time.