Commit ff0d3219 authored by Samuel GAIST's avatar Samuel GAIST
Browse files

Merge branch 'docedit' into 'master'

[doc] fixed external and internal links

See merge request !69
parents d010ceaf 360cf47a
Pipeline #31462 passed with stages
in 15 minutes and 6 seconds
......@@ -55,7 +55,7 @@ be obtained by running the following command:
Creating a new database
=======================
To create a new database locally, create the necessary files (see `database view python`_) and place them on your prefix.
To create a new database locally, create the necessary files (see "Databases" in section "Getting Started with BEAT" in `BEAT documentation`_) and place them on your prefix.
Once done, use the following command to index the database:
.. code-block:: sh
......
......@@ -91,8 +91,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 `here <https://www.idiap.ch/software/beat/docs/beat/docs/master/beat.core/doc/develop.html>`_), or the "local"
executor (refer to `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 :ref:`here <beat-core-local-development>`), or the "local"
executor (refer to "Installation Instruction" in `BEAT documentation`_ for information about local environment). The local executor, is
much simpler, aimed at providing a smooth development experience. However,
there are two important tradeoffs:
......
......@@ -37,7 +37,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 `Prefix`_). The user objects on the web platform are
a **prefix** (see "The Prefix" in section "A Hands-On-Tutorial" of `BEAT documentation`_). 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
......
......@@ -30,6 +30,4 @@
.. _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 installation: https://www.idiap.ch/software/beat/docs/beat/docs/master/beat/install.html
\ No newline at end of file
.. _BEAT documentation: https://www.idiap.ch/software/beat/documentation
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