Skip to content

Commit b25cf22

Browse files
authored
Merge pull request #168 from common-workflow-language/extra_links
explictly link to the extra docs
2 parents c13634d + 0dd30e5 commit b25cf22

File tree

4 files changed

+13
-8
lines changed

4 files changed

+13
-8
lines changed

_episodes/07-containers.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,6 +53,7 @@ hints:
5353
DockerRequirement:
5454
dockerPull: node:slim
5555
~~~
56+
{: .source}
5657

5758
`baseCommand: node` tells CWL that we will be running this command in a container. We
5859
then need to specify some `hints` for how to find the container we want. In this case we list
@@ -62,7 +63,6 @@ the name of the container image (you can even specify the tag, which is good ide
6263
best practises when using containers for reproducible research). In this case we have
6364
used a container called `node:slime`.
6465

65-
{: .source}
6666

6767
Provide a "hello.js" and invoke `cwl-runner` providing the tool wrapper and the
6868
input object on the command line:

_extras/miscellaneous.md

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ along with
136136
[`linkMerge: merge_nested`](https://www.commonwl.org/v1.0/Workflow.html#WorkflowStepInput)
137137

138138
> merge_nested
139-
139+
>
140140
> The input must be an array consisting of exactly one entry for each input link.
141141
> If "merge_nested" is specified with a single link, the value from the link must be wrapped in a single-item list.
142142

@@ -176,9 +176,11 @@ outputs:
176176

177177
For example, the filename is `a space is here.txt` includes 3 space characters.
178178

179-
> ERROR Workflow error, try again with --debug for more information:
180-
>
181-
> Invalid filename: 'a space is here.txt' contains illegal characters
179+
```console
180+
ERROR Workflow error, try again with --debug for more information:
181+
182+
Invalid filename: 'a space is here.txt' contains illegal characters
183+
```
182184

183185
If you can not avoid these dangerous characters, then pass `--relax-path-checks` to `cwltool`.
184186

@@ -249,4 +251,4 @@ If is not possible to change the input identifier, then you can use an alternati
249251

250252
```cwl
251253
valueFrom: $(inputs["sample-input"])
252-
```
254+
```

bin/lesson_check.py

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,6 @@
3333
'%/CONTRIBUTING.md': False,
3434
'%/LICENSE.md': True,
3535
'%/README.md': False,
36-
'%/_extras/discuss.md': True,
37-
'%/_extras/guide.md': True,
3836
'%/index.md': True,
3937
'%/reference.md': True,
4038
'%/setup.md': True,

index.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,11 @@ This guide will introduce you to writing tool wrappers and workflows using the C
2929
> * A CWL runner. It is recommended to start with the [reference implementation][cwltool-install]. The full list of CWL runners is on [the project homepage][cwl-runners-list].
3030
{: .prereq}
3131

32+
You also may be interested in:
33+
1. [A quick tutorial for the subset of YAML used in CWL]({{ page.root }}{% link _extras/yaml.md %})
34+
2. [CWL Recommended Practices]({{ page.root }}{% link _extras/recommended-practices.md %})
35+
3. [Miscellaneous CWL tips]({{ page.root }}{% link _extras/miscellaneous.md %})
36+
3237
[cwl-runners-list]: https://www.commonwl.org/#Implementations
3338
[cwltool-install]: https://github.com/common-workflow-language/cwltool#install
3439
[repo]: https://github.com/common-workflow-language/user-guide/issues

0 commit comments

Comments
 (0)