Commit e969f824 authored by Zohreh MOSTAANI's avatar Zohreh MOSTAANI

[web][doc] remove more extra infor from platform user guide

parent ccf0ac54
This diff is collapsed.
......@@ -36,7 +36,7 @@ configuration page, the declaration of this experiment transmitted to the
scheduler, that now must run the experiment until it finishes, you press the
``stop`` button, or an error condition is produced.
As it is described in the :ref:`toolchains` section, the scheduler first breaks
As it is described in the :ref:`beat-system-toolchains` section, the scheduler first breaks
the toolchain into a sequence of executable blocks with dependencies. For
example: block ``B`` must be run after block ``A``. Each block is then
scheduled for execution depending on current resource availability. If no more
......
......@@ -38,8 +38,7 @@ communicate in an orderly manner. For more detailed information see :ref:`beat-s
operator. The first value is the **username**.
The ``system`` user, provides a number of pre-defined formats such as
integers, booleans, floats and arrays
<https://www.beat-eu.org/platform/dataformats/system/>`_. You may also
integers, booleans, floats and arrays (see `here <https://www.beat-eu.org/platform/dataformats/system/>`_). You may also
browse `publicly available data formats`_ to see all available data formats
from the ``system`` and other users.
......
......@@ -31,23 +31,11 @@ Libraries
functions. Instead of re-implementing every function from scratch, you can
reuse functions already implemented by other users and published in the form of
|project| libraries. Similarly, you can create and publish your own libraries
of functions that you consider may be useful to other users.
of functions that you consider may be useful to other users. For more information see :ref:`beat-system-libraries`
Usage of libraries in encouraged in the |project| platform. Besides saving you
time and effort, this also promotes reproducibility in research.
.. note:: **Naming Convention**
Libraries are named using three values joined by a ``/`` (slash) operator:
* **username**: indicates the author of the library
* **name**: indicates the name of the library
* **version**: indicates the version (integer starting from ``1``) of the
library
Each tuple of these three components defines a *unique* name inside the
platform. For a grasp, you may browse `publicly available libraries`_.
You can access the Libraries section from your home-page on |project| by
clicking the ``User Resources`` tab and selecting ``Libraries`` from the
drop-down list. You should see a page similar to that shown below:
......@@ -98,8 +86,7 @@ To create a library you will need to provide the following information:
Of course, functions implemented in a new library may also call functions from
other shared libraries in the |project| platform. You can indicate the
dependencies on other libraries via the ``External library usage`` section (to
open this section, click on the ``v`` symbol on the right).
dependencies on other libraries via the ``External library usage`` section.
To save your work, click on the green ``Save`` button (in the top-right region
of the page). After you have saved your library, you will be able to use
......
......@@ -58,7 +58,7 @@ This is a panel with two buttons. The green button which says ``Show``, makes a
pop-up window appear showing your current API token. You may use this token
(64-byte character string) in outside programs that communicate with the
platform programmatically. For example, our command-line interface requires a
token to be able to pull/push contributions for the user.
token to be able to pull/push contributions for the user (see :ref:`beat-cmdline-configuration`).
If your token is compromised, you may change it by clicking on the ``Modify``
button. A pop-up window will appear confirming the modification. You may cancel
......
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