Skip to content

Commit 49a46fa

Browse files
authored
fix spelling (#148)
1 parent ec1d1cb commit 49a46fa

File tree

5 files changed

+35
-22
lines changed

5 files changed

+35
-22
lines changed

content/EDITING.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -29,11 +29,11 @@ Instructions for editing specific pages and site components.
2929
<a id="navigation-menus"></a>
3030
## Navigation Menus
3131

32-
There are two nav menu templates currently available:
32+
There are two nav menu templates currently available:
3333

3434
* `_includes/top_nav.html` - the main site nav
3535
* Data: `_data/navigation.yml`
36-
* Syles: `_sass/partials/_nav.scss`
36+
* Styles: `_sass/partials/_nav.scss`
3737
* `_includes/left_nav.html` - left nav on an individual page
3838
* Data: `_data/navigation.yml` by default
3939
* Can also pull data from a page-specific file, e.g. `gallery.html` previously used `_data/user-gallery.yml` for its left nav
@@ -141,7 +141,7 @@ The first version will generate `<body class="body-page-short">`, and the second
141141
* `_includes/home/intro.html` - contains the intro paragraph and imports the video player
142142
* `_includes/home/features.html` - template for the "Features" boxes section. Relies on `_data/home.yml`
143143
* `_includes/home/users-mini-gallery.html` - the bottom gallery of logos. Relies on data in `_data/user-gallery.html`
144-
* `_includes/home/video-player.html` - template code for the video player ([Plyr](https://plyr.io/)). See [Video Player](#video-player) section for more info.
144+
* `_includes/home/video-player.html` - template code for the video player ([Plyr](https://plyr.io/)). See [Video Player](#video-player) section for more info.
145145

146146
<a id="features-boxes"></a>
147147
#### Features Boxes
@@ -293,7 +293,7 @@ Items containing special characters (colons, brackets, etc) may need to be wrapp
293293
<a id="foreign-languages"></a>
294294
## Foreign Languages
295295

296-
Text in foreign language should be entered in HTML and include the `lang` and `hreflang` attributes. Subtitles should include the `srclang` code Here's a list of [common language subtags](https://en.wikipedia.org/wiki/IETF_language_tag#List_of_subtags) You can also search via [the Language Subtag Lookup](https://r12a.github.io/app-subtags/) or check whether a tag is valid (e.g. `en-us` is valid, while `en_us` is not).
296+
Text in foreign language should be entered in HTML and include the `lang` and `hreflang` attributes. Subtitles should include the `srclang` code Here's a list of [common language subtags](https://en.wikipedia.org/wiki/IETF_language_tag#List_of_subtags) You can also search via [the Language Subtag Lookup](https://r12a.github.io/app-subtags/) or check whether a tag is valid (e.g. `en-us` is valid, while `en_us` is not).
297297

298298
Example usage:
299299

@@ -303,7 +303,7 @@ Example usage:
303303
linked content is in Japanese -->
304304
<a href="https://github.com/pitagora-galaxy/cwl/wiki/CWL-Start-Guide-JP" lang="ja" hreflang="ja">
305305
306-
<!-- Russian link doesn't have hreflang, since the linked
306+
<!-- Russian link doesn't have hreflang, since the linked
307307
website auto-translates the content, based on the user's
308308
region -->
309309
<a href="https://stepik.org/course/1612/syllabus" lang="ru">
@@ -312,7 +312,7 @@ region -->
312312
<track src="{{ "/assets/video/subtitles/chinese_simplified.vtt" | relative_url }}" label="Chinese (Simplified)" kind="subtitles" srclang="zh-Hans">
313313
314314
<!-- These can be mixed in with Markdown code -->
315-
* A series of <a href="https://stepik.org/lesson/35918/step/1?unit=15070"lang="ru" hreflang="ru"> is available
315+
* A series of <a href="https://stepik.org/lesson/35918/step/1?unit=15070"lang="ru" hreflang="ru"> is available
316316
in Russian as part of the <a href="https://stepik.org/course/1612/syllabus" lang="ru">Управление вычислениями</a
317317
> (Computation Management) free online course.
318318
```
@@ -324,7 +324,7 @@ Currently the site has some Japanese & Russian links. The corresponding codes ar
324324

325325
For any markdown tables, prepend the following classes: `.table`, `.table-striped`, `.cols-2` or `.cols-3`:
326326

327-
2 Column Table Example:
327+
2 Column Table Example:
328328

329329
```markdown
330330
{: .table .table-striped .cols-2 }
@@ -343,14 +343,14 @@ For 3 column table, change `.cols-2` to `.cols-3`. i.e. `{: .table .table-stripe
343343
* Bootstrap 5.1.3
344344
* Site styles are built on top of Bootstrap 5.1.3
345345
* Nav menu relies on `/assets/js/bootstrap.min.js`
346-
* jQuery 3.5.1
346+
* jQuery 3.5.1
347347
* Mobile Nav relies on this in `/assets/js/navCloseFix.js`, due to a bug where it wasn't closing properly
348348
* Back to the Top button relies on this
349349

350350
<a id="bootstrap"></a>
351351
### Bootstrap
352352

353-
The site uses [Bootstrap 5](https://getbootstrap.com/docs/5.0/getting-started/introduction/) (specifically v5.0.0-beta3) for the base styles, and the nav menus.
353+
The site uses [Bootstrap 5](https://getbootstrap.com/docs/5.0/getting-started/introduction/) (specifically v5.0.0-beta3) for the base styles, and the nav menus.
354354

355355
Relevant folders & files:
356356

@@ -362,7 +362,7 @@ The styles are loaded as the first import in `style.scss`. The JS code is loaded
362362
<a id="media-query-grid-breakpoints"></a>
363363
#### Media Query Grid Breakpoints
364364

365-
Bootstrap grid breakpoints are originally found in ``_sass/bootstrap/_variables.scss`, and can be overriden in `_sass/partials/_variables.scss`
365+
Bootstrap grid breakpoints are originally found in ``_sass/bootstrap/_variables.scss`, and can be overridden in `_sass/partials/_variables.scss`
366366

367367
The following breakpoints and max-widths are used for responsive design:
368368

content/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# CWL Website - Instructions
22

3-
Instructions on how to run and edit the main [commonwl.org](commonwl.org) website.
3+
Instructions on how to run and edit the main [commonwl.org](commonwl.org) website.
44

55
See the main [README.md](../README.md) for general [instructions](../README.md#contributing) on contributing. See the [Security Policy](https://github.com/common-workflow-language/cwl-website/security/policy) page to report a vulnerability.
66

@@ -54,7 +54,7 @@ It's important to specify both config files, in order. Otherwise Jekyll will gen
5454

5555
**Use a custom url or port:** For convenience, you may wish to specify `--host cwl.test` and `--port 80` (or any other value), as follows: `bundle exec jekyll serve --config "_config.yml,_config_local.yml --host cwl.test --port 80`. **Note:** You may have to [update your hosts file](https://www.howtogeek.com/howto/27350/beginner-geek-how-to-edit-your-hosts-file/), in order for your computer to respect the custom url.
5656

57-
**Command Line:** Anything you specify on the command line wil override the settings in your config files. For a full list of command line options, see Jekyll - Configuration Options [Serve Commands](https://jekyllrb.com/docs/configuration/options/#serve-command-options) and [Build Commands](https://jekyllrb.com/docs/configuration/options/#build-command-options)
57+
**Command Line:** Anything you specify on the command line will override the settings in your config files. For a full list of command line options, see Jekyll - Configuration Options [Serve Commands](https://jekyllrb.com/docs/configuration/options/#serve-command-options) and [Build Commands](https://jekyllrb.com/docs/configuration/options/#build-command-options)
5858

5959
<a id="important-files-and-directories"></a>
6060
### Important Files and Directories

content/features.md

Lines changed: 20 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -7,20 +7,30 @@ columns: 10
77

88
## Benefits of Workflows and Standards
99

10-
### Why Use Workfows?
10+
### Why Use Workflows?
1111

1212
Workflows and using workflow tools help make your computation methods portable, maintainable, reproducible and shareable. Often analysis methods contain many steps, perhaps in multiple languages and workflows help researchers document, run and maintain these complicated analyses.
1313
Using a workflow system rather than a series of scripts has a number of benefits including abstraction, scaling, automation, and provenance (ASAP).
1414
Workflows enable a clear abstraction about the components of your analysis, the relationship between the components and the inputs and outputs for each component allows for a well-labeled analysis with documented expectation. This abstraction helps enable the other benefits of scaling, automation and provenance.
1515
Workflow execution can be parallelized or distributed making use of cluster, cloud, and high performance computing (HPC) environments. This helps to solve larger problems and analyze larger datasets faster.
1616

17-
Automation helps when running repetitive pipelines for example when running parameter sweeps or the same analysis on different sets of data. Workflow engines can use the inherient abstraction of workflows to efficently track, plan and manage the executation of workflow components.
18-
Lastly, provenance tracking helps with auditing, tranparency, and validation. Ultimately, using workflows in the long run helps save time and effort and allows for easier scaling, tracking, sharing and reuse.
17+
Automation helps when running repetitive pipelines, for example when running
18+
parameter sweeps or the same analysis on different sets of data. Workflow engines
19+
can use the inherient abstraction of workflows to efficiently track, plan and
20+
manage the execution of workflow components.
21+
Lastly, provenance tracking helps with auditing, tranparency, and validation.
22+
Ultimately, using workflows in the long run helps save time and effort and
23+
allows for easier scaling, tracking, sharing and reuse.
1924

2025
### Why Use a Standard?
2126

22-
A standard for sharing and reusing workflows can provide a solution to describing portable,re-usable workflows while also being workflow-engine and vendor-neutral.
23-
Although workflows are [very popular](https://s.apache.org/existing-workflow-systems), prior to the CWL standards every workflow system was incompatible with every other. This means, those users not using the CWL standards are required to express their computational workflows in a different way everytime they have to use another workflow system. This greatly hampers reuse and collaboration.
27+
A standard for sharing and reusing workflows can provide a solution to describing
28+
portable,re-usable workflows while also being workflow-engine and vendor-neutral.
29+
Although workflows are [very popular](https://s.apache.org/existing-workflow-systems),
30+
prior to the CWL standards every workflow system was incompatible with every other.
31+
This means, those users not using the CWL standards are required to express their
32+
computational workflows in a different way every time they have to use another
33+
workflow system. This greatly hampers reuse and collaboration.
2434

2535
### When to Use CWL?
2636

@@ -29,7 +39,7 @@ command-line tool based data analysis.
2939
CWL is for dataflow style batch analysis consisting of command line programs. It is not designed for supporting safe interaction with stateful (web) services, real-time communication between workflow steps, or workflows that need particular steps run at or during a
3040
specific day/time-frame.
3141

32-
## Reusability and Reproduciblity with CWL
42+
## Reusability and Reproducibility with CWL
3343
CWL workflows are portable, reusable, and flexible. Reproduction, reuse, and replication of computational methods requires a complete description of what computer applications were used, how exactly they were used, and how they were connected to each other. To this end, CWL enables portability by being explicit about inputs/outputs to form the data flow, data locations and execution models. CWL supports using software container technologies, such as Docker and Singularity, to enable portability. For increased flexiblity, individual CWL tool definitions can be reused in any new workflow.
3444

3545
<figure>
@@ -42,7 +52,10 @@ Benefits of CWL including flexibility, portability, and scalability. CWL is well
4252

4353
## Parallelization and Scale with CWL
4454

45-
CWL workflows describe each step with explict inputs and outputs. Workflow steps in CWL are not necessarily run in the order they are listed, instead the order is determined by the dependencies between steps. Workflow steps which do not depend on one another may run in parallel.
55+
CWL workflows describe each step with explicit inputs and outputs. Workflow steps
56+
in CWL are not necessarily run in the order they are listed, instead the order
57+
is determined by the dependencies between steps. Workflow steps which do not
58+
depend on one another may run in parallel.
4659

4760
Additionally, the **[scatter](https://www.commonwl.org/user_guide/23-scatter-workflow/index.html)** feature in CWL allows the repeated execution of a CWL step in parallel (depending on the resources available) over a list of inputs. This can be done without requiring the modification of the underlying tool description.
4861

content/getting-started.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,10 @@
1212

1313
* Learn to write CWL using the [CWL user guide](/user_guide/) which provides a gentle introduction to creating CWL command line tool and workflow descriptions.
1414
* Browse [CWL Implementations](/implementations/) to find a software package that's right for you.
15-
* Follow [CWL Recommended Practices](http://www.commonwl.org/user_guide/rec-practices/) to make your CWL tools and workflows more efficent, reusable and transparent.
15+
* Follow [CWL Recommended Practices](http://www.commonwl.org/user_guide/rec-practices/) to make your CWL tools and workflows more efficient, reusable and transparent.
1616
* Read <a href="https://github.com/pitagora-galaxy/cwl/wiki/CWL-Start-Guide-JP" lang="ja" hreflang="ja">CWLの日本語での解説ドキュメント</a> a 15 minute introduction to the CWL project in Japanese.
1717
* Watch a series of [video lessons about CWL](https://stepik.org/lesson/35918/step/1?unit=15070) in Russian as part of the <a href="https://stepik.org/course/1612/syllabus" lang="ru">Управление вычислениями</a> (Computation Management) free online course.
18-
* Find [CWL descriptions for life-science tools](https://github.com/common-workflow-library/bio-cwl-tools) to use directly or incoporate into your workflows.
18+
* Find [CWL descriptions for life-science tools](https://github.com/common-workflow-library/bio-cwl-tools) to use directly or incorporate into your workflows.
1919

2020
{%- endcapture -%}
2121

content/implementations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ workflows and they are available from vendors such as Curii
2323
Wide adoption benefits from our principles: CWL offers
2424
conformance tests, but the CWL community does not yet test or certify
2525
CWL implementations, or specific technology stacks. Instead,
26-
plaform/service providers self-certify support for CWL, based on a
26+
platform/service providers self-certify support for CWL, based on a
2727
particular technology configuration they deploy and maintain.
2828

2929
{:.cwl-red}

0 commit comments

Comments
 (0)