Skip to content

Commit 0a966f4

Browse files
committed
🎨 style(hello_seqera): incorporate suggestions from code-review
Co-authored by: Geraldine Van der Auwera <[email protected]> Cow-authored by: Marcel Ribeiro-Dantas <[email protected]>
1 parent 514f912 commit 0a966f4

File tree

3 files changed

+18
-12
lines changed

3 files changed

+18
-12
lines changed

‎docs/hello_nextflow/seqera/01_run_with_cli.md

Lines changed: 12 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ Start by logging into the [Seqera Platform](https://cloud.seqera.io/).
66
!!! info "Nextflow Tower"
77

88
Seqera Platform was previously known as Nextflow Tower.
9-
You'll still see references to the previous name in environment variable and cli option names.
9+
You'll still see references to the previous name in environment variables and CLI option names.
1010

1111
### 1.1. Set up your Seqera Platform token by exporting it to your environment
1212

@@ -26,21 +26,26 @@ Follow these steps to set up your token:
2626

2727
!!! note
2828

29-
Leave this browser tab open as we will need the token once more to store it as a Nextflow secret.
29+
Leave the browser tab with the token open as we will need it once more to store it as a Nextflow secret.
3030

3131
4. To make your token available to the Nextflow CLI, export it on the command line:
3232

3333
Open a terminal and type:
3434

3535
```bash
36-
export TOWER_ACCESS_TOKEN=eyxxxxxxxxxxxxxxxQ1ZTE=
36+
export TOWER_ACCESS_TOKEN=eyxxxxxxxxxxxxxxxQ1ZTE=
3737
```
3838

3939
Where `eyxxxxxxxxxxxxxxxQ1ZTE=` is the token you have just created.
4040

41-
### 1.2. Run Nextflow cli with Seqera Platform visualizing and capturing logs
41+
!!! Warning "Security Note"
4242

43-
Run your Nextflow workflows as usual with the addition of the `-with-tower` command:
43+
Keep your token secure and do not share it with others.
44+
You can add a ++space++ before the `export` command to prevent it from being saved in your shell history.
45+
46+
### 1.2. Run Nextflow CLI with Seqera Platform visualizing and capturing logs
47+
48+
Run a Nextflow workflow with the addition of the `-with-tower` command:
4449

4550
```bash
4651
nextflow run nextflow-io/hello -with-tower
@@ -66,7 +71,7 @@ Hola world!
6671
Hello world!
6772
```
6873

69-
Use ++ctrl+click++ or ++cmd+click++ on the link to open it in your browser.
74+
Hold ++ctrl++ or ++cmd++ and click on the link to open it in your browser.
7075
You'll see the Seqera Platform interface with the job finished and the logs captured.
7176
7277
![Seqera Platform](seqera/img/run_with_tower.png)
@@ -75,8 +80,7 @@ You will see and be able to monitor your **Nextflow jobs** in Seqera Platform.
7580
7681
### 1.3. Set up Seqera Platform in Nextflow configuration
7782
78-
Doing that token setup regularly can get bit tedious, but the same setup can be applied in configuration applied to Nexflow configuration so that it does not need to be set each time.
79-
This can be the `nextflow.config` file of a specific project, or the global file located at `$HOME/.nextflow/config`, which will apply to all your runs.
83+
Doing that token setup regularly can get a bit tedious, so let's set this configuration for all our pipeline runs with the global Nextflow configuration file located at `$HOME/.nextflow/config`.
8084

8185
Before we set the configuration, we need to permanently store the token in Nextflow using a [Nextflow secret](https://www.nextflow.io/docs/latest/secrets.html):
8286

‎docs/hello_nextflow/seqera/02_run_with_launchpad.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -75,10 +75,10 @@ Click on the task to see the task details:
7575

7676
You have learned how to:
7777

78-
- Switch between organizations and workspaces in Seqera Platform.
79-
- Launch a Nextflow pipeline that ran in the cloud using Seqera Platform.
80-
- Monitor the progress of the pipeline run.
81-
- Inspect the details of a task that was executed as part of the pipeline.
78+
- Switch between organizations and workspaces in Seqera Platform.
79+
- Launch a Nextflow pipeline that ran in the cloud using Seqera Platform.
80+
- Monitor the progress of the pipeline run.
81+
- Inspect the details of a task that was executed as part of the pipeline.
8282

8383
### Next steps
8484

‎mkdocs.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -155,6 +155,8 @@ markdown_extensions:
155155
preserve_tabs: true
156156
- pymdownx.tabbed:
157157
alternate_style: true
158+
- pymdownx.tasklist:
159+
custom_checkbox: true
158160
- tables
159161
- toc:
160162
title: On this page

0 commit comments

Comments
 (0)