Commit c7a4fe84 authored by Samuel GAIST's avatar Samuel GAIST Committed by Flavio TARSETTI

[doc][toolchains] Remove edition part

parent 5761e6b7
Pipeline #43878 passed with stage
in 16 minutes and 30 seconds
......@@ -28,7 +28,8 @@
============
Toolchains are the backbone of experiments within the |project| platform. They
determine the data flow for experiments in the |project| platform. For more information about toolchains see the "Toolchains" section of "Getting Started with BEAT" in `BEAT documentation`_.
determine the data flow for experiments in the |project| platform. For more information
about toolchains see the "Toolchains" section of "Getting Started with BEAT" in `BEAT documentation`_.
The *Toolchains* tab
......@@ -62,6 +63,13 @@ And some more buttons if you own the toolchain:
has not been used in an experiment**).
Sharing a toolchain
-------------------
Like any other object in the |project| platform, you may also share your
toolchain your with other users. To do this, click on the green arrow in
the top right region on the page showing the toolchain you want to share.
.. note:: **Sharing status**
The sharing status of an toolchain is represented to the left of its name,
......@@ -85,60 +93,4 @@ And some more buttons if you own the toolchain:
more information on our :ref:`faq`).
Create a new toolchain
-----------------------
To create a new toolchain, you have to select the tab 'Toolchains' and then to
click on the button ``New``.
You should see a webpage similar to what is displayed below:
.. image:: img/new-toolchain.*
Then you have to type a name in the ``Name`` bar. Now you can create your
toolchain on the canvas. To do that, you have to select the different blocks
(dataset, block or analyzer) to the left of the canvas and to set them on the
canvas. On each block, you can modify the name by double-clicking on it, add
some inputs or outputs by clicking on the ``+`` and remove some inputs or
outputs by clicking on the ``-``. Finally, you have to link the different
blocks. To do that, you have to click on the output of a block and then to
click on the input of another block.
To delete a block or a link, you have to select it by left-clicking on it and
to use the keyboard key ``delete``. To undo the last operation, you can type
``Ctrl+z`` (``Cmd+z`` on a Mac) or click the undo and redo buttons on the top
bar of the editor. To move the canvas, you can:
* use the middle mouse button
* use the left mouse button with the ``Alt`` key
* use the mouse wheel
Whenever you want, you can save your toolchain by clicking on the ``save``
button (green floppy disk), located on the top bar of the editor.
.. _modifytoolchain:
Modify a toolchain
------------------
There exist three ways to modify an existing toolchain:
* Fork: to fork an existing toolchain and to modify it. You have to rename
the toolchain and its version number will be re-initialized to 1.
* Edit: to modify one of your toolchains which has no associated experiment.
The toolchain will keep the same name and the same version number.
* New version: to modify one of your toolchain which may have some
experiments. The toolchain will keep the same name and its version number
will be incremented.
To modify a toolchain, you have to open the ``Toolchains`` tab by clicking on
the ``Toolchains`` link, then to move your mouse over a toolchain and finally
to click on one of the three buttons ``Fork``, ``Edit`` or ``New version``.
Then an editor window is presented so you can modify your toolchain by deleting
and/or adding some blocks and/or connections. At the end, you have to save your
new toolchain by clicking on the ``save`` button (green floppy disk). If you
fork a toolchain, you have to give it a new name on the ``Name`` bar.
.. include:: ../links.rst
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