Skip to content

Commit d59c479

Browse files
remigathoni“gathoni-k”swzCuroverse
authored
Add descriptive link texts (#294)
Co-authored-by: “gathoni-k” <“[email protected]”> Co-authored-by: SWZ <[email protected]>
1 parent 05cc06d commit d59c479

File tree

4 files changed

+11
-12
lines changed

4 files changed

+11
-12
lines changed

src/introduction/quick-start.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -93,13 +93,13 @@ files.
9393

9494
## Learn more
9595

96-
- Continue reading the next sections of this User Guide!
97-
- List of CWL Implementations: <https://www.commonwl.org/implementations/>
98-
- The `common-workflow-language` organization at GitHub: <https://github.com/common-workflow-language>
99-
- Common Workflow Language at Wikipedia: <https://en.wikipedia.org/wiki/Common_Workflow_Language>
100-
- YAML.org: <http://yaml.org/> and YAML at Wikipedia: <https://en.wikipedia.org/wiki/YAML>
101-
- The CWL {{ cwl_version }} Specification: {{ '<https://www.commonwl.org/{}/>'.format(cwl_version_text) }}
102-
- Workflow management system at Wikipedia: <https://en.wikipedia.org/wiki/Workflow_management_system>
96+
Continue reading the next sections of this User Guide!
97+
- [List of CWL Implementations](https://www.commonwl.org/implementations).
98+
- The [`common-workflow-language` organization](https://github.com/common-workflow-language) at GitHub.
99+
- [Common Workflow Language at Wikipedia](https://en.wikipedia.org/wiki/Common_Workflow_Language).
100+
- [YAML.org](http://yaml.org/) and [YAML at Wikipedia](https://en.wikipedia.org/wiki/YAML).
101+
- The {{'[CWL Specification VERSION](https://www.commonwl.org/VERSION)'.replace('VERSION', cwl_version_text) }}.
102+
- [Workflow management system at Wikipedia](https://en.wikipedia.org/wiki/Workflow_management_system).
103103

104104
% N.B.: Wondering what's up with this syntax in the CWL Specification link above?
105105
% It's necessary as MyST Parser does not allow substitutions in links, for more:

src/topics/custom-types.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ converting a standard biom table file to hd5 format.
2121
:name: custom-types.yml
2222
```
2323

24-
___Note:___ To follow the example below, you need to download the example input file, *rich_sparse_otu_table.biom*. The file is available from <https://github.com/common-workflow-language/user_guide/raw/main/src/_includes/cwl/custom-types/rich_sparse_otu_table.biom>) and can be downloaded e.g. via `wget`:
24+
___Note:___ To follow the example below, you need to [download the example input file](https://raw.githubusercontent.com/common-workflow-language/user_guide/main/_includes/cwl/custom-types/rich_sparse_otu_table.biom), *rich_sparse_otu_table.biom* e.g. via `wget`:
2525

2626
```{code-block} console
2727
$ wget https://github.com/common-workflow-language/user_guide/raw/main/src/_includes/cwl/custom-types/rich_sparse_otu_table.biom

src/topics/file-formats.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ type-checking when creating parameter files.
88
For file formats, we recommend referencing existing ontologies (like EDAM in
99
our example), reference a local ontology for your institution, or do not add
1010
a file format initially for quick development before sharing your tool with
11-
others. You can browse existing file format listings for IANA [here][IANA] and
12-
for EDAM [here][EDAM].
11+
others. You can browse existing [IANA file format listings][IANA] and
12+
[EDAM file format listings][EDAM] on their websites.
1313

1414
In the next tutorial, we explain the `$namespaces` and `$schemas` section of the
1515
document in greater detail, so don't worry about these for now.

src/topics/specifying-software-requirements.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,7 @@ given in the form of an [RRID][rrid]. Resources with RRIDs can be looked up in t
3131
[SciCrunch][scicrunch] registry, which provides a portal for finding, tracking,
3232
and referring to scientific resources consistently. If you want to specify a
3333
tool as a `SoftwareRequirement`, search for the tool on SciCrunch and use the
34-
RRID that it has been assigned in the registry. (Follow [this tutorial][scicrunch-add-tool]
35-
if you want to add a tool to SciCrunch.) You can use this RRID to refer
34+
RRID that it has been assigned in the registry. (Follow this [Adding a Resource Tutorial][scicrunch-add-tool] to add a tool to SciCrunch). You can use this RRID to refer
3635
to the tool (via [identifiers.org][identifiers]) in the `specs` field of your
3736
requirement description. Other good choices, in order of preference, are to
3837
include the DOI for the main tool citation and the URL to the tool.

0 commit comments

Comments
 (0)