Commit 14de0c9a authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI

[cmdline][doc] fixing more links to the other packages

parent bf6f4b73
Pipeline #25432 passed with stage
in 11 minutes and 46 seconds
......@@ -45,7 +45,7 @@ be obtained by running the following command:
Creating a new database
=======================
To create a new database locally, create the necessary files (see :ref:`beat-new-database`) and place them on your prefix.
To create a new database locally, create the necessary files (see `database view python`_) and place them on your prefix.
Once done, use the following command to index the database:
.. code-block:: sh
......@@ -100,3 +100,5 @@ you're trying to interact with. Replace ``<your-token>`` by your user token
.. note::
At the moment only users with administrative privilege can push databases to the web serve however all users can create and modify databases locally.
.. include:: links.rst
......@@ -81,8 +81,8 @@ Executors
"Executors" are modules that execute each block in an experiment. On the BEAT
platform, there is only the one executor, which executes the experiment using
Docker containers with advanced scheduling and security features. When using ``beat.cmdline`` locally, however, you have the option of using either
the BEAT platform's executor, behind the ``--docker`` flag (for more information about using docker executors see :ref:`here <beat-core-local-development>`), or the "local"
executor (refer to :ref:`beat-installation` for information about local environment). The local executor, is
the BEAT platform's executor, behind the ``--docker`` flag (for more information about using docker executors see `here <beat core local development>`_), or the "local"
executor (refer to `beat installation`_ for information about local environment). The local executor, is
much simpler, aimed at providing a smooth development experience. However,
there are two important tradeoffs:
......@@ -125,3 +125,5 @@ There a two ways to plot data:
In both cases the 'output folder' option can be specified to save all the plots to a specific directory. By default, if nothing was specified, the plots will be saved under the experiment path.
Take into account that some extra options are available such as '--show' which will pop out the generated plots on your screen.
.. include:: links.rst
......@@ -26,7 +26,7 @@ Introduction
============
The user objects (data formats, toolchains, experiments, etc) are stored
locally in a directory with specific structure that is commonly referred to as
a **prefix** (see :ref:`prefix`). The user objects on the web platform are
a **prefix** (see `prefix`_). The user objects on the web platform are
also stored in a similar directory structure. It is possible to extract a
representation from the objects on the BEAT web server and interact with them
locally. Local object copies contain the same amount of information that is
......@@ -51,3 +51,5 @@ or remotely available objects. You'll find detailed information about
sub-commands on specific sub-sections of this documentation dedicated to that
particular type of object. In :ref:`beat-cmdline-configuration`, we cover basic usage and
configuration only.
.. include:: links.rst
.. _main beat website: https://www.beat-eu.org/platform/
.. _database view python: https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/databases.html#database-view
.. _prefix: https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/user.html#the-prefix
.. _beat core local development: https://www.idiap.ch/software/beat/docs/beat/docs/master/beat.core/doc/develop.html
.. _beat installation: https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/install.html
\ No newline at end of file
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment