Skip to content

Commit

Permalink
Document pipeline io can be edited
Browse files Browse the repository at this point in the history
  • Loading branch information
jmlord authored Sep 15, 2023
1 parent 5c839e9 commit 92c5fb6
Showing 1 changed file with 8 additions and 1 deletion.
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -257,7 +257,9 @@ Pipelines also have inputs and outputs. In order to run, a pipeline needs to spe
### Pipeline editor
The pipeline editor allows you to create pipelines by plugging steps together.

The left pane shows the available steps, the right pane shows the canvas.
The left pane shows the available steps, the main section shows the canvas.

On the right side, a collapsible pane allows to edit the labels and descriptions of the pipeline inputs and outputs.

**To add a step:** drag and drop from the left pane to the canvas. Steps that are single scripts will display with a single border, while steps that are pipelines will display with a double border.

Expand Down Expand Up @@ -302,6 +304,11 @@ Add an **output** node linked to a step output to specify that this output is an

![image](https://user-images.githubusercontent.com/6223744/181108988-97d988ca-8f4b-45b1-b4a3-32e90821b68b.png)

Pipeline inputs and outputs then appear in a collapsible pane on the right of the canvas, where their descriptions and labels can be edited.

<img src="https://github.com/GEO-BON/biab-2.0/assets/6223744/215b75db-7198-486d-880d-87c0b340668b" height="218">



### Saving and loading
The editor _does not_ allow you to edit files live on the server. Files need to be committed to the github repo using git.
Expand Down

0 comments on commit 92c5fb6

Please sign in to comment.