Skip to content

Commit d3d6c95

Browse files
authored
reference correct branch, remove carpentries refs (#223)
* Update CITATION with CACM paper
1 parent c9d3e0f commit d3d6c95

39 files changed

+55
-2207
lines changed

.travis.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ cache:
1010

1111
branches:
1212
only:
13-
- gh-pages
13+
- main
1414
- /.*/
1515

1616
before_script:

16-file-formats/index.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -54,11 +54,11 @@ parameterization.
5454
:language: yaml
5555
```
5656

57-
___Note:___ To follow the example below, you need to download the example input file, *file-formats.bam*. The file is available from [https://github.com/common-workflow-language/user_guide/raw/gh-pages/_includes/cwl/16-file-formats/file-formats.bam
58-
](https://github.com/common-workflow-language/user_guide/raw/gh-pages/_includes/cwl/16-file-formats/file-formats.bam) and can be downloaded e.g. via `wget`:
57+
___Note:___ To follow the example below, you need to download the example input file, *file-formats.bam*. The file is available from [https://github.com/common-workflow-language/user_guide/raw/main/_includes/cwl/16-file-formats/file-formats.bam
58+
](https://github.com/common-workflow-language/user_guide/raw/main/_includes/cwl/16-file-formats/file-formats.bam) and can be downloaded e.g. via `wget`:
5959

6060
```bash
61-
wget https://github.com/common-workflow-language/user_guide/raw/gh-pages/_includes/cwl/16-file-formats/file-formats.bam
61+
wget https://github.com/common-workflow-language/user_guide/raw/main/_includes/cwl/16-file-formats/file-formats.bam
6262
```
6363

6464
Now invoke `cwl-runner` with the tool wrapper and the input object on the

19-custom-types/index.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,10 +36,10 @@ converting a standard biom table file to hd5 format.
3636
:language: yaml
3737
```
3838

39-
___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://raw.githubusercontent.com/common-workflow-language/user_guide/gh-pages/_includes/cwl/19-custom-types/rich_sparse_otu_table.biom](https://raw.githubusercontent.com/common-workflow-language/user_guide/gh-pages/_includes/cwl/19-custom-types/rich_sparse_otu_table.biom) and can be downloaded e.g. via `wget`:
39+
___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://raw.githubusercontent.com/common-workflow-language/user_guide/main/_includes/cwl/19-custom-types/rich_sparse_otu_table.biom](https://raw.githubusercontent.com/common-workflow-language/user_guide/main/_includes/cwl/19-custom-types/rich_sparse_otu_table.biom) and can be downloaded e.g. via `wget`:
4040

4141
```bash
42-
wget https://raw.githubusercontent.com/common-workflow-language/user_guide/gh-pages/_includes/cwl/19-custom-types/rich_sparse_otu_table.biom
42+
wget https://raw.githubusercontent.com/common-workflow-language/user_guide/main/_includes/cwl/19-custom-types/rich_sparse_otu_table.biom
4343
```
4444

4545
On line 29, in `inputs:table_type`, a list of allowable table options to be used in the

21-1st-workflow/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -25,7 +25,7 @@ compiles it.
2525
```
2626

2727
```{admonition} Visualization of 1st-workflow.cwl
28-
[![Visualization of 1st-workflow.cwl](https://view.commonwl.org/graph/svg/github.com/common-workflow-language/user_guide/blob/gh-pages/_includes/cwl/21-1st-workflow/1st-workflow.cwl)](https://view.commonwl.org/workflows/github.com/common-workflow-language/user_guide/blob/gh-pages/_includes/cwl/21-1st-workflow/1st-workflow.cwl)
28+
[![Visualization of 1st-workflow.cwl](https://view.commonwl.org/graph/svg/github.com/common-workflow-language/user_guide/blob/main/_includes/cwl/21-1st-workflow/1st-workflow.cwl)](https://view.commonwl.org/workflows/github.com/common-workflow-language/user_guide/blob/main/_includes/cwl/21-1st-workflow/1st-workflow.cwl)
2929
```
3030

3131
Use a YAML or a JSON object in a separate file to describe the input of a run:

22-nested-workflows/index.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,11 +45,11 @@ the `compile` step in orange; `compile` is another workflow, diagrammed on the
4545
right. In purple we see the fixed string `"Hello.java"` being supplied as the
4646
`name_of_file_to_extract`.
4747
48-
<a href="https://view.commonwl.org/workflows/github.com/common-workflow-language/user_guide/blob/gh-pages/_includes/cwl/22-nested-workflows/nestedworkflows.cwl"><img
49-
src="https://view.commonwl.org/graph/svg/github.com/common-workflow-language/user_guide/blob/gh-pages/_includes/cwl/22-nested-workflows/nestedworkflows.cwl"
48+
<a href="https://view.commonwl.org/workflows/github.com/common-workflow-language/user_guide/blob/main/_includes/cwl/22-nested-workflows/nestedworkflows.cwl"><img
49+
src="https://view.commonwl.org/graph/svg/github.com/common-workflow-language/user_guide/blob/main/_includes/cwl/22-nested-workflows/nestedworkflows.cwl"
5050
alt="Visualization of nestedworkflows.cwl" /></a>
51-
<a href="https://view.commonwl.org/workflows/github.com/common-workflow-language/user_guide/blob/gh-pages/_includes/cwl/22-nested-workflows/1st-workflow.cwl"><img
52-
src="https://view.commonwl.org/graph/svg/github.com/common-workflow-language/user_guide/blob/gh-pages/_includes/cwl/22-nested-workflows/1st-workflow.cwl"
51+
<a href="https://view.commonwl.org/workflows/github.com/common-workflow-language/user_guide/blob/main/_includes/cwl/22-nested-workflows/1st-workflow.cwl"><img
52+
src="https://view.commonwl.org/graph/svg/github.com/common-workflow-language/user_guide/blob/main/_includes/cwl/22-nested-workflows/1st-workflow.cwl"
5353
alt="Visualization of 1st-workflow.cwl" /></a>
5454
```
5555

CITATION

Lines changed: 25 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,29 @@
11
# Citation
22

3-
To cite CWL as a project, as a language, or as a standard, use:
3+
To cite the Common Workflow Language and the CWL project in a scholary work, please use:
4+
5+
Michael R. Crusoe, Sanne Abeln, Alexandru Iosup, Peter Amstutz, John Chilton, Nebojša Tijanić, Hervé Ménager, Stian Soiland-Reyes, Bogdan Gavrilović, Carole Goble, and The CWL Community. 2022. Methods included: standardizing computational reuse and portability with the Common Workflow Language. Commun. ACM 65, 6 (June 2022), 54–63. https://doi.org/10.1145/3486897
6+
7+
@article{10.1145/3486897,
8+
author = {Crusoe, Michael R. and Abeln, Sanne and Iosup, Alexandru and Amstutz, Peter and Chilton, John and Tijani\'{c}, Neboj\v{s}a and M\'{e}nager, Herv\'{e} and Soiland-Reyes, Stian and Gavrilovi\'{c}, Bogdan and Goble, Carole and Community, The CWL},
9+
title = {Methods Included: Standardizing Computational Reuse and Portability with the Common Workflow Language},
10+
year = {2022},
11+
issue_date = {June 2022},
12+
publisher = {Association for Computing Machinery},
13+
address = {New York, NY, USA},
14+
volume = {65},
15+
number = {6},
16+
issn = {0001-0782},
17+
url = {https://doi.org/10.1145/3486897},
18+
doi = {10.1145/3486897},
19+
abstract = {Standardizing computational reuse and portability with the Common Workflow Language.},
20+
journal = {Commun. ACM},
21+
month = {may},
22+
pages = {54–63},
23+
numpages = {10}
24+
}
25+
26+
To cite just the CWL standards themselves, please use the following inclusive of the DOI:
427

528
Amstutz, Peter; Crusoe, Michael R; Tijanić, Nebojša; Chapman, Brad;
629
Chilton, John; Heuer, Michael; Kartashov, Andrey; Kern, John; Leehr, Dan;
@@ -23,12 +46,9 @@ Luka Stojanovic
2346
year = {2016}
2447
}
2548

26-
# the above is from https://github.com/common-workflow-language/common-workflow-language/blob/master/CITATION
49+
# the above is from https://github.com/common-workflow-language/common-workflow-language/blob/main/CITATION
2750

2851
Our preferred DOI for the "CWL User Guide" is http://doi.org/10.5281/zenodo.840129
2952

3053
The latest DOI for the "CWL User Guide" is:
3154
[![DOI](https://zenodo.org/badge/89621457.svg)](https://zenodo.org/badge/latestdoi/89621457)
32-
33-
The structure and style of this user guide is derived from [the Carpentries](https://github.com/carpentries)
34-
lesson template: [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.838778.svg)](https://doi.org/10.5281/zenodo.838778)

CONTRIBUTING.md

Lines changed: 9 additions & 56 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
The [Common Workflow Language project][cwl-site] is an open source project,
44
and we welcome contributions of all kinds:
5-
new lessons,
5+
new sections,
66
fixes to existing material,
77
bug reports,
88
and reviews of proposed changes are all welcome.
@@ -43,32 +43,10 @@ and to meet some of our community members.
4343
you can submit a pull request (PR).
4444
Instructions for doing this are [included below][#using-github].
4545

46-
## Where to Contribute
47-
48-
1. If you wish to change this lesson,
49-
please work in <https://github.com/common-workflow-language/user_guide>,
50-
which can be viewed at <https://www.commmonwl.org/user_guide/>.
51-
52-
2. If you wish to change the example lesson,
53-
please work in <https://github.com/carpentries/lesson-example>,
54-
which documents the format of our lessons
55-
and can be viewed at <https://carpentries.github.io/lesson-example>.
56-
57-
3. If you wish to change the template used for workshop websites,
58-
please work in <https://github.com/carpentries/workshop-template>.
59-
The home page of that repository explains how to set up workshop websites,
60-
while the extra pages in <https://carpentries.github.io/workshop-template>
61-
provide more background on our design choices.
62-
63-
4. If you wish to change CSS style files, tools,
64-
or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`,
65-
please work in <https://github.com/carpentries/styles>.
66-
6746
## What to Contribute
6847

6948
There are many ways to contribute,
70-
from writing new exercises and improving existing ones
71-
to updating or filling in the documentation
49+
like updating or filling in the documentation
7250
and submitting [bug reports][issues]
7351
about things that don't work, aren't clear, or are missing.
7452
If you are looking for ideas,
@@ -78,52 +56,33 @@ or the issues for [Common Workflow Language][cwl-issues] project itself.
7856
Comments on issues and reviews of pull requests are just as welcome:
7957
we are smarter together than we are on our own.
8058
Reviews from novices and newcomers are particularly valuable:
81-
it's easy for people who have been using these lessons for a while
59+
it's easy for people who have been using these materials for a while
8260
to forget how impenetrable some of this material can be,
8361
so fresh eyes are always welcome.
8462

85-
<!--
86-
## What *Not* to Contribute
87-
88-
Our lessons already contain more material than we can cover in a typical workshop,
89-
so we are usually *not* looking for more concepts or tools to add to them.
90-
As a rule,
91-
if you want to introduce a new idea,
92-
you must (a) estimate how long it will take to teach
93-
and (b) explain what you would take out to make room for it.
94-
The first encourages contributors to be honest about requirements;
95-
the second, to think hard about priorities.
96-
97-
We are also not looking for exercises or other material that only run on one platform.
98-
Our workshops typically contain a mixture of Windows, macOS, and Linux users;
99-
in order to be usable,
100-
our lessons must run equally well on all three.
101-
-->
10263
## Using GitHub
10364

10465
If you choose to contribute via GitHub, you may want to look at
10566
[How to Contribute to an Open Source Project on GitHub][how-contribute].
10667
To manage changes, we follow [GitHub flow][github-flow].
107-
Each lesson has two maintainers who review issues and pull requests or encourage others to do so.
108-
The maintainers are community volunteers and have final say over what gets merged into the lesson.
109-
To use the web interface for contributing to a lesson:
68+
To use the web interface for contributing:
11069

11170
1. Fork the originating repository to your GitHub profile.
112-
2. Within your version of the forked repository, move to the `gh-pages` branch and
71+
2. Within your version of the forked repository, move to the `main` branch and
11372
create a new branch for each significant change being made.
11473
3. Navigate to the file(s) you wish to change within the new branches and make revisions as required.
11574
4. Commit all changed files within the appropriate branches.
11675
5. Create individual pull requests from each of your changed branches
117-
to the `gh-pages` branch within the originating repository.
76+
to the `main` branch within the originating repository.
11877
6. If you receive feedback, make changes using your issue-specific branches of the forked
11978
repository and the pull requests will update automatically.
12079
7. Repeat as needed until all feedback has been addressed.
12180

122-
When starting work, please make sure your clone of the originating `gh-pages` branch is up-to-date
81+
When starting work, please make sure your clone of the originating `main` branch is up-to-date
12382
before creating your own revision-specific branch(es) from there.
12483
Additionally, please only work from your newly-created branch(es) and *not*
125-
your clone of the originating `gh-pages` branch.
126-
Lastly, published copies of all the lessons are available in the `gh-pages` branch of the originating
84+
your clone of the originating `main` branch.
85+
Lastly, published copies of all the sections are available in the `main` branch of the originating
12786
repository for reference while revising.
12887

12988
## Other Resources
@@ -132,17 +91,11 @@ General discussion of [Common Workflow Language][cwl-site] project
13291
happens on the [discussion mailing list][discuss-list],
13392
which everyone is welcome to join.
13493

135-
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
136-
[dc-lessons]: http://datacarpentry.org/lessons/
137-
[dc-site]: http://datacarpentry.org/
13894
[discuss-list]: https://groups.google.com/forum/#!forum/common-workflow-language
13995
[github]: https://github.com
14096
[github-flow]: https://guides.github.com/introduction/flow/
14197
[github-join]: https://github.com/join
14298
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
14399
[issues]: https://github.com/common-workflow-language/user_guide/issues
144100
[repo]: https://github.com/common-workflow-language/user_guide
145-
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
146-
[swc-lessons]: https://software-carpentry.org/lessons/
147-
[swc-site]: https://software-carpentry.org/
148101
[cwl-site]: https://www.commonwl.org/

LICENSE.md

Lines changed: 2 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,6 @@
22

33
## Instructional Material
44

5-
This material is derived from a framework created by the Software Carpentry
6-
and Data Carpentry projects under the [Creative Commons Attribution
7-
license][cc-by-human].
8-
95
All Common Workflow Language project instructional material and changes
106
to the structure are also made available under the [Creative Commons Attribution
117
license][cc-by-human]. The following is a human-readable summary of
@@ -26,8 +22,8 @@ Under the following terms:
2622

2723
* **Attribution**---You must give appropriate credit (mentioning that
2824
your work is derived from work that is Copyright © the Common Workflow
29-
Language project, and Copyright © Software Carpentry, and, where practical, linking to
30-
https://www.commonwl.org/ and https://software-carpentry.org/), provide a [link to the
25+
Language project, and, where practical, linking to
26+
https://www.commonwl.org/ ), provide a [link to the
3127
license][cc-by-human], and indicate if changes were made. You may do
3228
so in any reasonable manner, but not in any way that suggests the
3329
licensor endorses you or your use.
@@ -61,12 +57,9 @@ limitations under the License.
6157

6258
## Trademark
6359

64-
"Software Carpentry" and "Data Carpentry" and their respective logos
65-
are registered trademarks of [Community Initiatives][CI].
6660

6761
[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
6862
[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
6963
[apache-2.0-license]: https://opensource.org/licenses/Apache-2.0
7064
[mit-license]: https://opensource.org/licenses/mit-license.html
71-
[ci]: http://communityin.org/
7265
[osi]: https://opensource.org

README.md

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
[![DOI](https://zenodo.org/badge/89621457.svg)](https://zenodo.org/badge/latestdoi/89621457)
22

3-
[![Syntax Check](https://travis-ci.org/common-workflow-language/user_guide.svg?branch=gh-pages)](https://travis-ci.org/common-workflow-language/user_guide)
3+
[![Syntax Check](https://travis-ci.org/common-workflow-language/user_guide.svg?branch=main)](https://travis-ci.org/common-workflow-language/user_guide)
44

55
[User guide for CWL v1.0.2](https://www.commonwl.org/user_guide/)
66

@@ -9,30 +9,20 @@ https://github.com/common-workflow-language/common-workflow-language/blob/a2a8a0
99

1010
## Contributing
1111

12-
We welcome all contributions to improve the lesson! Maintainers will do their best to help you if you have any
12+
We welcome all contributions to improve the materials! Maintainers will do their best to help you if you have any
1313
questions, concerns, or experience any difficulties along the way.
1414
To edit the user guide:
1515

16-
We'd like to ask you to familiarize yourself with our [Contribution Guide](CONTRIBUTING.md) and have a look at
17-
the [more detailed guidelines][lesson-example] on proper formatting, ways to render the lesson locally, and even
18-
how to write new episodes.
16+
We'd like to ask you to familiarize yourself with our [Contribution Guide](CONTRIBUTING.md).
1917

20-
- The text files for each tutorial can be found in the directory [_episodes](/_episodes/index.md)
21-
22-
- The cwl and yaml code files linked to each tutorial can be found in the directory [_includes/cwl](https://github.com/common-workflow-language/user_guide/tree/gh-pages/_includes/cwl)
23-
24-
This repo is based upon https://github.com/swcarpentry/styles and should be periodically resynced.
25-
26-
## Maintainer(s)
2718

2819
* FIXME
2920

3021
## Authors
3122

32-
A list of contributors to the lesson can be found in [AUTHORS](AUTHORS)
23+
A list of contributors to these materials can be found in [AUTHORS](AUTHORS)
3324

3425
## Citation
3526

36-
To cite this lesson, please consult with [CITATION](CITATION)
27+
To cite these materials, please consult with [CITATION](CITATION)
3728

38-
[lesson-example]: https://carpentries.github.io/lesson-example

_includes/aio-script.md

Lines changed: 0 additions & 49 deletions
This file was deleted.

0 commit comments

Comments
 (0)