Skip to content

Commit 9dab7c6

Browse files
mr-cmr-c
authored
Merge pull request #3 from common-workflow-language/our-stuff
initial setup
2 parents 3a26a44 + 1f2dd24 commit 9dab7c6

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

43 files changed

+874
-144
lines changed

‎.github/ISSUE_TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Please delete the text below before submitting your contribution.
2+
3+
---
4+
5+
Thanks for contributing! If this contribution is for instructor training, please send an email to [email protected] with a link to this contribution so we can record your progress. You’ve completed your contribution step for instructor checkout just by submitting this contribution.
6+
7+
Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact Kate Hertweck ([email protected]).
8+
9+
---

‎.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
Please delete the text below before submitting your contribution.
2+
3+
---
4+
5+
Thanks for contributing! If this contribution is for instructor training, please send an email to [email protected] with a link to this contribution so we can record your progress. You’ve completed your contribution step for instructor checkout just by submitting this contribution.
6+
7+
Please keep in mind that lesson maintainers are volunteers and it may be some time before they can respond to your contribution. Although not all contributions can be incorporated into the lesson materials, we appreciate your time and effort to improve the curriculum. If you have any questions about the lesson maintenance process or would like to volunteer your time as a contribution reviewer, please contact Kate Hertweck ([email protected]).
8+
9+
---

‎AUTHORS

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
FIXME: list authors' names and email addresses.

‎CITATION

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
FIXME: describe how to cite this lesson.

‎CONDUCT.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,12 @@ layout: page
33
title: "Contributor Code of Conduct"
44
permalink: /conduct/
55
---
6+
As contributors and maintainers of this project,
7+
we pledge to respect all people who contribute through reporting issues,
8+
posting feature requests,
9+
updating documentation,
10+
submitting pull requests or patches,
11+
and other activities.
612

713
The CWL Project is dedicated to providing a harassment-free experience for everyone, regardless of gender, gender identity and expression, sexual orientation, disability, physical appearance, body size, age, race, or religion. We do not tolerate harassment of participants in any form.
814

‎CONTRIBUTING.md

Lines changed: 150 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,150 @@
1+
# Contributing
2+
3+
The [Common Workflow Language project](cwl-site) is an open source project,
4+
and we welcome contributions of all kinds:
5+
new lessons,
6+
fixes to existing material,
7+
bug reports,
8+
and reviews of proposed changes are all welcome.
9+
10+
## Contributor Agreement
11+
12+
By contributing,
13+
you agree that we may redistribute your work under [our license](LICENSE.md).
14+
In exchange,
15+
we will address your issues and/or assess your change proposal as promptly as we can,
16+
and help you become a member of our community.
17+
Everyone involved in the [Common Workflow Language project](cwl-site)
18+
agrees to abide by our [code of conduct](CONDUCT.md).
19+
20+
## How to Contribute
21+
22+
The easiest way to get started is to file an issue
23+
to tell us about a spelling mistake,
24+
some awkward wording,
25+
or a factual error.
26+
This is a good way to introduce yourself
27+
and to meet some of our community members.
28+
29+
1. If you do not have a [GitHub][github] account,
30+
you can [send us comments by email][contact].
31+
However,
32+
we will be able to respond more quickly if you use one of the other methods described below.
33+
34+
2. If you have a [GitHub][github] account,
35+
or are willing to [create one][github-join],
36+
but do not know how to use Git,
37+
you can report problems or suggest improvements by [creating an issue][issues].
38+
This allows us to assign the item to someone
39+
and to respond to it in a threaded discussion.
40+
41+
3. If you are comfortable with Git,
42+
and would like to add or change material,
43+
you can submit a pull request (PR).
44+
Instructions for doing this are [included below](#using-github).
45+
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://swcarpentry.github.io/FIXME>.
51+
52+
2. If you wish to change the example lesson,
53+
please work in <https://github.com/swcarpentry/lesson-example>,
54+
which documents the format of our lessons
55+
and can be viewed at <https://swcarpentry.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/swcarpentry/workshop-template>.
59+
The home page of that repository explains how to set up workshop websites,
60+
while the extra pages in <https://swcarpentry.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/swcarpentry/styles>.
66+
67+
## What to Contribute
68+
69+
There are many ways to contribute,
70+
from writing new exercises and improving existing ones
71+
to updating or filling in the documentation
72+
and and submitting [bug reports][issues]
73+
about things that don't work, aren't clear, or are missing.
74+
If you are looking for ideas,
75+
please see [the list of issues for this repository][issues],
76+
or the issues for [Common Workflow Language](cwl-issues) project itself.
77+
78+
Comments on issues and reviews of pull requests are just as welcome:
79+
we are smarter together than we are on our own.
80+
Reviews from novices and newcomers are particularly valuable:
81+
it's easy for people who have been using these lessons for a while
82+
to forget how impenetrable some of this material can be,
83+
so fresh eyes are always welcome.
84+
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, Mac OS X, and Linux users;
99+
in order to be usable,
100+
our lessons must run equally well on all three.
101+
-->
102+
## Using GitHub
103+
104+
If you choose to contribute via GitHub,
105+
you may want to look at
106+
[How to Contribute to an Open Source Project on GitHub][how-contribute].
107+
In brief:
108+
109+
1. The published copy of the lesson is in the `gh-pages` branch of the repository
110+
(so that GitHub will regenerate it automatically).
111+
Please create all branches from that,
112+
and merge the [master repository][repo]'s `gh-pages` branch into your `gh-pages` branch
113+
before starting work.
114+
Please do *not* work directly in your `gh-pages` branch,
115+
since that will make it difficult for you to work on other contributions.
116+
117+
2. We use [GitHub flow][github-flow] to manage changes:
118+
1. Create a new branch in your desktop copy of this repository for each significant change.
119+
2. Commit the change in that branch.
120+
3. Push that branch to your fork of this repository on GitHub.
121+
4. Submit a pull request from that branch to the [master repository][repo].
122+
5. If you receive feedback,
123+
make changes on your desktop and push to your branch on GitHub:
124+
the pull request will update automatically.
125+
126+
Each lesson has two maintainers who review issues and pull requests
127+
or encourage others to do so.
128+
The maintainers are community volunteers,
129+
and have final say over what gets merged into the lesson.
130+
131+
## Other Resources
132+
133+
General discussion of [Common Workflow Language](cwl-site) project
134+
happens on the [discussion mailing list][discuss-list],
135+
which everyone is welcome to join.
136+
137+
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
138+
[dc-lessons]: http://datacarpentry.org/lessons/
139+
[dc-site]: http://datacarpentry.org/
140+
[discuss-list]: https://groups.google.com/forum/#!forum/common-workflow-language
141+
[github]: http://github.com
142+
[github-flow]: https://guides.github.com/introduction/flow/
143+
[github-join]: https://github.com/join
144+
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
145+
[issues]: https://github.com/common-workflow-language/user_guide/issues
146+
[repo]: https://github.com/common-workflow-language/user_guide
147+
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
148+
[swc-lessons]: http://software-carpentry.org/lessons/
149+
[swc-site]: http://software-carpentry.org/
150+
[cwl-site]: http://www.commonwl.org/

‎_config.yml

Lines changed: 73 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,73 @@
1+
#------------------------------------------------------------
2+
# Values for this lesson.
3+
#------------------------------------------------------------
4+
5+
# Which carpentry is this ("swc", "dc", "lc", or "cwl")?
6+
carpentry: "cwl"
7+
8+
# Overall title for pages.
9+
title: "Lesson Title"
10+
11+
# Contact. This *must* include the protocol: if it's an email
12+
# address, it must look like "mailto:[email protected]",
13+
# or if it's a URL, "https://gitter.im/username/ProjectName".
14+
contact: "mailto:[email protected]"
15+
16+
#------------------------------------------------------------
17+
# Generic settings (should not need to change).
18+
#------------------------------------------------------------
19+
20+
# What kind of thing is this ("workshop" or "lesson")?
21+
kind: "lesson"
22+
23+
# Magic to make URLs resolve both locally and on GitHub.
24+
# See https://help.github.com/articles/repository-metadata-on-github-pages/.
25+
repository: <USERNAME>/<PROJECT>
26+
27+
# Sites.
28+
amy_site: "https://amy.software-carpentry.org/workshops"
29+
dc_site: "http://datacarpentry.org"
30+
swc_github: "https://github.com/swcarpentry"
31+
swc_site: "https://software-carpentry.org"
32+
swc_pages: "https://swcarpentry.github.io"
33+
lc_site: "http://librarycarpentry.github.io/"
34+
template_repo: "https://github.com/swcarpentry/styles"
35+
example_repo: "https://github.com/swcarpentry/lesson-example"
36+
example_site: "https://swcarpentry.github.com/lesson-example"
37+
workshop_repo: "https://github.com/swcarpentry/workshop-template"
38+
workshop_site: "https://swcarpentry.github.io/workshop-template"
39+
training_site: "https://swcarpentry.github.io/instructor-training"
40+
41+
# Surveys.
42+
pre_survey: "https://www.surveymonkey.com/r/swc_pre_workshop_v1?workshop_id="
43+
post_survey: "https://www.surveymonkey.com/r/swc_post_workshop_v1?workshop_id="
44+
training_post_survey: "https://www.surveymonkey.com/r/post-instructor-training"
45+
46+
# Start time in minutes (0 to be clock-independent, 540 to show a start at 09:00 am).
47+
start_time: 0
48+
49+
# Specify that things in the episodes collection should be output.
50+
collections:
51+
episodes:
52+
output: true
53+
permalink: /:path/
54+
extras:
55+
output: true
56+
57+
# Set the default layout for things in the episodes collection.
58+
defaults:
59+
- values:
60+
root: ..
61+
- scope:
62+
path: ""
63+
type: episodes
64+
values:
65+
layout: episode
66+
67+
# Files and directories that are not to be copied.
68+
exclude:
69+
- Makefile
70+
- bin
71+
72+
# Turn off built-in syntax highlighting.
73+
highlighter: false

‎_episodes/01-introduction.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
---
2+
title: "Introduction"
3+
teaching: 0
4+
exercises: 0
5+
questions:
6+
- "Key question"
7+
objectives:
8+
- "First objective."
9+
keypoints:
10+
- "First key point."
11+
---
12+
Content here
13+
14+
{% include links.md %}
15+

‎_extras/about.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
layout: page
3+
title: About
4+
permalink: /about/
5+
---
6+
{% include carpentries.html %}

‎_extras/discuss.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
---
2+
layout: page
3+
title: Discussion
4+
permalink: /discuss/
5+
---
6+
FIXME

0 commit comments

Comments
 (0)