From 38307ff35b01ef8c1521473676a43742b5f9601a Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Tue, 4 Apr 2017 08:02:53 +0100 Subject: [PATCH 01/16] Add Library Carpentry to the workshop template Includes @drjwbaker's description of Library Carpentry. --- _includes/dc/intro.html | 18 ++++++++ _includes/dc/schedule.html | 24 +++++++++++ _includes/dc/syllabus.html | 96 +++++++++++++++++++++++++++++++++++++++++ _includes/dc/who.html | 8 ++++ _includes/lc/intro.html | 19 ++++++++ _includes/lc/schedule.html | 24 +++++++++++ _includes/lc/syllabys.html | 69 +++++++++++++++++++++++++++++ _includes/lc/who.html | 8 ++++ _includes/navbar.html | 14 +----- _includes/sc/intro.html | 18 ++++++++ _includes/sc/schedule.html | 24 +++++++++++ _includes/sc/syllabus.html | 96 +++++++++++++++++++++++++++++++++++++++++ _includes/sc/who.html | 8 ++++ _includes/workshop_footer.html | 19 ++++++-- assets/img/lc-icon-black.png | Bin 0 -> 18753 bytes 15 files changed, 428 insertions(+), 17 deletions(-) create mode 100644 _includes/dc/intro.html create mode 100644 _includes/dc/schedule.html create mode 100644 _includes/dc/syllabus.html create mode 100644 _includes/dc/who.html create mode 100644 _includes/lc/intro.html create mode 100644 _includes/lc/schedule.html create mode 100644 _includes/lc/syllabys.html create mode 100644 _includes/lc/who.html create mode 100644 _includes/sc/intro.html create mode 100644 _includes/sc/schedule.html create mode 100644 _includes/sc/syllabus.html create mode 100644 _includes/sc/who.html create mode 100644 assets/img/lc-icon-black.png diff --git a/_includes/dc/intro.html b/_includes/dc/intro.html new file mode 100644 index 0000000..741aeeb --- /dev/null +++ b/_includes/dc/intro.html @@ -0,0 +1,18 @@ +

+ Data Carpentry + aims to help researchers get their work done + in less time and with less pain + by teaching them basic research computing skills. + This hands-on workshop will cover basic concepts and tools, + including program design, version control, data management, + and task automation. + Participants will be encouraged to help one another + and to apply what they have learned to their own research problems. +

+

+ + For more information on what we teach and why, + please see our paper + "Best Practices for Scientific Computing". + +

diff --git a/_includes/dc/schedule.html b/_includes/dc/schedule.html new file mode 100644 index 0000000..6894a19 --- /dev/null +++ b/_includes/dc/schedule.html @@ -0,0 +1,24 @@ +
+
+

Day 1

+ + + + + + + +
09:00 Automating tasks with the Unix shell
10:30 Coffee
12:00 Lunch break
13:00 Building programs with Python
14:30 Coffee
16:00 Wrap-up
+
+
+

Day 2

+ + + + + + + +
09:00 Version control with Git
10:30 Coffee
12:00 Lunch break
13:00 Managing data with SQL
14:30 Coffee
16:00 Wrap-up
+
+
diff --git a/_includes/dc/syllabus.html b/_includes/dc/syllabus.html new file mode 100644 index 0000000..a325cee --- /dev/null +++ b/_includes/dc/syllabus.html @@ -0,0 +1,96 @@ +
+
+

The Unix Shell

+
    +
  • Files and directories
    • +
  • History and tab completion
    • +
  • Pipes and redirection
    • +
  • Looping over files
    • +
  • Creating and running shell scripts
    • +
  • Finding things
    • +
  • Reference...
    • +
+
+
+

Programming in Python

+
    +
  • Using libraries
    • +
  • Working with arrays
    • +
  • Reading and plotting data
    • +
  • Creating and using functions
    • +
  • Loops and conditionals
    • +
  • Defensive programming
    • +
  • Using Python from the command line
    • +
  • Reference...
    • +
+
+ + +
+ +
+
+

Version Control with Git

+
    +
  • Creating a repository
    • +
  • Recording changes to files: add, commit, ...
    • +
  • Viewing changes: status, diff, ...
    • +
  • Ignoring files
    • +
  • Working on the web: clone, pull, push, ...
    • +
  • Resolving conflicts
    • +
  • Open licenses
    • +
  • Where to host work, and why
    • +
  • Reference...
    • +
+
+ +
+

Open Refine

+
    +
  • Introduction to OpenRefine
    • +
  • Importing data
    • +
  • Basic functions
    • +
  • Advanced Functions
    • +
  • Reference...
    • +
+
+
diff --git a/_includes/dc/who.html b/_includes/dc/who.html new file mode 100644 index 0000000..2d8e94a --- /dev/null +++ b/_includes/dc/who.html @@ -0,0 +1,8 @@ +

+ Who: + The course is aimed at graduate students and other researchers. + + You don't need to have any previous knowledge of the tools + that will be presented at the workshop. + +

diff --git a/_includes/lc/intro.html b/_includes/lc/intro.html new file mode 100644 index 0000000..6794b54 --- /dev/null +++ b/_includes/lc/intro.html @@ -0,0 +1,19 @@ +

+ Library Carpentry + is made by librarians, for librarians to help you: +

+ +

+ + Library Carpentry introduces you to the fundamentals of computing + and provides you with a platform for further self-directed learning. + For more information on what we teach and why, please see our paper + "Library Carpentry: software skills training for library professionals". + +

diff --git a/_includes/lc/schedule.html b/_includes/lc/schedule.html new file mode 100644 index 0000000..cc2b592 --- /dev/null +++ b/_includes/lc/schedule.html @@ -0,0 +1,24 @@ +
+
+

Day 1

+ + + + + + + +
09:00 Data Intro for Librarians
10:30 Coffee
12:00 Lunch break
13:00 Shell Lessons for Libraries
14:30 Coffee
16:00 Wrap-up
+
+
+

Day 2

+ + + + + + + +
09:00 Git Intro for Librarians
10:30 Coffee
12:00 Lunch break
13:00 OpenRefine for Librarians
14:30 Coffee
16:00 Wrap-up
+
+
diff --git a/_includes/lc/syllabys.html b/_includes/lc/syllabys.html new file mode 100644 index 0000000..4dc2077 --- /dev/null +++ b/_includes/lc/syllabys.html @@ -0,0 +1,69 @@ +
+
+

Data Intro

+
    +
  • Intro to data
    • +
  • Jargon busting
    • +
  • Keyboard shortcuts
    • +
  • Plain text formats
    • +
  • Naming files
    • +
  • Regular expressions
    • +
  • Reference...
    • +
+
+
+

The Unix Shell

+
    +
  • Files and directories
    • +
  • History and tab completion
    • +
  • Counting and sorting contents in files
    • +
  • Pipes and redirection
    • +
  • Mining or searching in files
    • +
  • Reference...
    • +
+
+ +
+ +
+
+

Version Control with Git

+
    +
  • Creating a repository
    • +
  • Configuring git
    • +
  • Recording changes to files: add, commit, ...
    • +
  • Viewing state changes with status
    • +
  • Working on the web: clone, pull, push, ...
    • +
  • Where to host work, and why
    • +
  • Reference...
    • +
+
+
+
+

Open Refine

+
    +
  • Introduction to OpenRefine
    • +
  • Importing data
    • +
  • Basic functions
    • +
  • Advanced Functions
    • +
  • Reference...
    • +
+
+
+
+ diff --git a/_includes/lc/who.html b/_includes/lc/who.html new file mode 100644 index 0000000..fd9b38c --- /dev/null +++ b/_includes/lc/who.html @@ -0,0 +1,8 @@ +

+ Who: + The course is for librarians, archivists, and other information workers. + + You don't need to have any previous knowledge of the tools that + will be presented at the workshop. + +

diff --git a/_includes/navbar.html b/_includes/navbar.html index 6b21afc..00fd328 100644 --- a/_includes/navbar.html +++ b/_includes/navbar.html @@ -22,19 +22,7 @@ {% elsif page.carpentry == "lc" %} - - - {% elsif site.carpentry == "swc" %} - - - - {% elsif site.carpentry == "dc" %} - - - - {% elsif site.carpentry == "lc" %} - - + {% endif %} diff --git a/_includes/sc/intro.html b/_includes/sc/intro.html new file mode 100644 index 0000000..7b9fbf5 --- /dev/null +++ b/_includes/sc/intro.html @@ -0,0 +1,18 @@ +

+ Software Carpentry + aims to help researchers get their work done + in less time and with less pain + by teaching them basic research computing skills. + This hands-on workshop will cover basic concepts and tools, + including program design, version control, data management, + and task automation. + Participants will be encouraged to help one another + and to apply what they have learned to their own research problems. +

+

+ + For more information on what we teach and why, + please see our paper + "Best Practices for Scientific Computing". + +

diff --git a/_includes/sc/schedule.html b/_includes/sc/schedule.html new file mode 100644 index 0000000..6894a19 --- /dev/null +++ b/_includes/sc/schedule.html @@ -0,0 +1,24 @@ +
+
+

Day 1

+ + + + + + + +
09:00 Automating tasks with the Unix shell
10:30 Coffee
12:00 Lunch break
13:00 Building programs with Python
14:30 Coffee
16:00 Wrap-up
+
+
+

Day 2

+ + + + + + + +
09:00 Version control with Git
10:30 Coffee
12:00 Lunch break
13:00 Managing data with SQL
14:30 Coffee
16:00 Wrap-up
+
+
diff --git a/_includes/sc/syllabus.html b/_includes/sc/syllabus.html new file mode 100644 index 0000000..a325cee --- /dev/null +++ b/_includes/sc/syllabus.html @@ -0,0 +1,96 @@ +
+
+

The Unix Shell

+
    +
  • Files and directories
    • +
  • History and tab completion
    • +
  • Pipes and redirection
    • +
  • Looping over files
    • +
  • Creating and running shell scripts
    • +
  • Finding things
    • +
  • Reference...
    • +
+
+
+

Programming in Python

+
    +
  • Using libraries
    • +
  • Working with arrays
    • +
  • Reading and plotting data
    • +
  • Creating and using functions
    • +
  • Loops and conditionals
    • +
  • Defensive programming
    • +
  • Using Python from the command line
    • +
  • Reference...
    • +
+
+ + +
+ +
+
+

Version Control with Git

+
    +
  • Creating a repository
    • +
  • Recording changes to files: add, commit, ...
    • +
  • Viewing changes: status, diff, ...
    • +
  • Ignoring files
    • +
  • Working on the web: clone, pull, push, ...
    • +
  • Resolving conflicts
    • +
  • Open licenses
    • +
  • Where to host work, and why
    • +
  • Reference...
    • +
+
+ +
+

Open Refine

+
    +
  • Introduction to OpenRefine
    • +
  • Importing data
    • +
  • Basic functions
    • +
  • Advanced Functions
    • +
  • Reference...
    • +
+
+
diff --git a/_includes/sc/who.html b/_includes/sc/who.html new file mode 100644 index 0000000..2d8e94a --- /dev/null +++ b/_includes/sc/who.html @@ -0,0 +1,8 @@ +

+ Who: + The course is aimed at graduate students and other researchers. + + You don't need to have any previous knowledge of the tools + that will be presented at the workshop. + +

diff --git a/_includes/workshop_footer.html b/_includes/workshop_footer.html index 3ae63e6..7b2f22c 100644 --- a/_includes/workshop_footer.html +++ b/_includes/workshop_footer.html @@ -3,11 +3,22 @@ {% endcomment %} From 1e56203d492a1a13d86756fb5e9d754ed2cae0f8 Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Sat, 6 May 2017 10:07:40 +0100 Subject: [PATCH 09/16] Remove CONDUCT.md since it should be generate by bin/lesson_initialize.py --- CONDUCT.md | 45 --------------------------------------------- 1 file changed, 45 deletions(-) delete mode 100644 CONDUCT.md diff --git a/CONDUCT.md b/CONDUCT.md deleted file mode 100644 index 5e4943b..0000000 --- a/CONDUCT.md +++ /dev/null @@ -1,45 +0,0 @@ ---- -layout: page -title: "Contributor Code of Conduct" -permalink: /conduct/ ---- -As contributors and maintainers of this project, -we pledge to respect all people who contribute through reporting issues, -posting feature requests, -updating documentation, -submitting pull requests or patches, -and other activities. - -We are committed to making participation in this project a harassment-free experience for everyone, -regardless of level of experience, -gender, -gender identity and expression, -sexual orientation, -disability, -personal appearance, -body size, -race, -ethnicity, -age, -or religion. - -Examples of unacceptable behavior by participants include the use of sexual language or imagery, -derogatory comments or personal attacks, -trolling, -public or private harassment, -insults, -or other unprofessional conduct. - -Project maintainers have the right and responsibility to remove, edit, or reject -comments, commits, code, wiki edits, issues, and other contributions -that are not aligned to our [Code of Conduct][coc]. -Project maintainers who do not follow the Code of Conduct may be removed from the project team. - -Instances of abusive, harassing, or otherwise unacceptable behavior -may be reported by following our [reporting guidelines][coc-reporting]. - - -- [Software and Data Carpentry Code of Conduct][coc] -- [Code of Conduct Reporting Guide][coc-reporting] - -{% include links.md %} From 98e4bc69b4b03055125a6f888e08b7d08e5cba67 Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Sat, 6 May 2017 10:19:56 +0100 Subject: [PATCH 10/16] Fix bug with Python script --- bin/lesson_initialize.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/bin/lesson_initialize.py b/bin/lesson_initialize.py index 513597a..fc7baf7 100755 --- a/bin/lesson_initialize.py +++ b/bin/lesson_initialize.py @@ -278,7 +278,7 @@ FIXME ''' -ROOT_SETUP_MD = '''\ +ROOT_AIO_MD = '''\ --- layout: page permalink: /aio/ From 9f34e6e952d0d3ab25df0eef4e65a521d2ba4c88 Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Wed, 10 May 2017 11:05:10 +0100 Subject: [PATCH 11/16] Revert "Remove CONDUCT.md since it should be generate by bin/lesson_initialize.py" This reverts commit 1e56203d492a1a13d86756fb5e9d754ed2cae0f8. --- CONDUCT.md | 45 +++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 CONDUCT.md diff --git a/CONDUCT.md b/CONDUCT.md new file mode 100644 index 0000000..5e4943b --- /dev/null +++ b/CONDUCT.md @@ -0,0 +1,45 @@ +--- +layout: page +title: "Contributor Code of Conduct" +permalink: /conduct/ +--- +As contributors and maintainers of this project, +we pledge to respect all people who contribute through reporting issues, +posting feature requests, +updating documentation, +submitting pull requests or patches, +and other activities. + +We are committed to making participation in this project a harassment-free experience for everyone, +regardless of level of experience, +gender, +gender identity and expression, +sexual orientation, +disability, +personal appearance, +body size, +race, +ethnicity, +age, +or religion. + +Examples of unacceptable behavior by participants include the use of sexual language or imagery, +derogatory comments or personal attacks, +trolling, +public or private harassment, +insults, +or other unprofessional conduct. + +Project maintainers have the right and responsibility to remove, edit, or reject +comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to our [Code of Conduct][coc]. +Project maintainers who do not follow the Code of Conduct may be removed from the project team. + +Instances of abusive, harassing, or otherwise unacceptable behavior +may be reported by following our [reporting guidelines][coc-reporting]. + + +- [Software and Data Carpentry Code of Conduct][coc] +- [Code of Conduct Reporting Guide][coc-reporting] + +{% include links.md %} From b08b83dd0f3b847e0a96051797b840eadd0591e5 Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Sun, 18 Jun 2017 08:57:19 +0100 Subject: [PATCH 12/16] Handler for collaborative_notes See https://github.com/swcarpentry/workshop-template/issues/410 --- bin/workshop_check.py | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/bin/workshop_check.py b/bin/workshop_check.py index d3051bf..39ee0bf 100755 --- a/bin/workshop_check.py +++ b/bin/workshop_check.py @@ -227,12 +227,12 @@ def check_eventbrite(eventbrite): @look_for_fixme -def check_etherpad(etherpad): +def check_collaborative_notes(collaborative_notes): """ - 'etherpad' must be a valid URL. + 'collaborative_notes' must be a valid URL. """ - return bool(re.match(URL_PATTERN, etherpad)) + return bool(re.match(URL_PATTERN, collaborative_notes)) @look_for_fixme @@ -292,7 +292,7 @@ def check_pass(value): 'eventbrite': (False, check_eventbrite, 'Eventbrite key appears invalid'), - 'etherpad': (False, check_etherpad, 'Etherpad URL appears invalid'), + 'collaborative_notes': (False, check_collaborative_notes, 'Collaborative Notes URL appears invalid'), 'venue': (False, check_pass, 'venue name not specified'), From 55c2e1b39722e7f0f019620e89c20054a0388b51 Mon Sep 17 00:00:00 2001 From: Joel Nothman Date: Tue, 4 Jul 2017 15:07:12 +1000 Subject: [PATCH 13/16] Link LC as for SWC and DC --- _includes/carpentries.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/carpentries.html b/_includes/carpentries.html index a0e0181..e6e7965 100644 --- a/_includes/carpentries.html +++ b/_includes/carpentries.html @@ -32,7 +32,7 @@ Library Carpentry logo
- Library Carpentry is made by librarians to help librarians + Library Carpentry is made by librarians to help librarians automate repetitive, boring, error-prone tasks; create, maintain and analyse sustainable and reusable data; work effectively with IT and systems colleagues; From 6e4e4c45b60d65f0272fe62e779b14c9e8aa3db3 Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Wed, 5 Jul 2017 09:58:54 +0100 Subject: [PATCH 14/16] Unify Library Carpentry logo Close #155 --- _includes/carpentries.html | 2 +- assets/img/lc-icon-black.svg | 76 -------------------------------------------- 2 files changed, 1 insertion(+), 77 deletions(-) delete mode 100644 assets/img/lc-icon-black.svg diff --git a/_includes/carpentries.html b/_includes/carpentries.html index e6e7965..4d5c906 100644 --- a/_includes/carpentries.html +++ b/_includes/carpentries.html @@ -29,7 +29,7 @@
- Library Carpentry logo + Library Carpentry logo
Library Carpentry is made by librarians to help librarians diff --git a/assets/img/lc-icon-black.svg b/assets/img/lc-icon-black.svg deleted file mode 100644 index df71189..0000000 --- a/assets/img/lc-icon-black.svg +++ /dev/null @@ -1,76 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - From 0ab311b14a3cb46559a41354f56ea6884495b67a Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Wed, 5 Jul 2017 10:10:58 +0100 Subject: [PATCH 15/16] Fix logo at navbar by run ~~~ $ find _includes -type f -exec sed -i "s/page.carpentry/site.carpentry/g" {} \; $ find _layouts -type f -exec sed -i "s/page.carpentry/site.carpentry/g" {} \; $ find _extras -type f -exec sed -i "s/page.carpentry/site.carpentry/g" {} \; $ find _episodes -type f -exec sed -i "s/page.carpentry/site.carpentry/g" {} \; $ find bin -type f -exec sed -i "s/page.carpentry/site.carpentry/g" {} \; $ find assets -type f -exec sed -i "s/page.carpentry/site.carpentry/g" {} \; ~~~ --- _includes/navbar.html | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/_includes/navbar.html b/_includes/navbar.html index 7782c9d..7e2560d 100644 --- a/_includes/navbar.html +++ b/_includes/navbar.html @@ -12,15 +12,15 @@ {% comment %} Select what logo to display. {% endcomment %} - {% if page.carpentry == "swc" %} + {% if site.carpentry == "swc" %} - {% elsif page.carpentry == "dc" %} + {% elsif site.carpentry == "dc" %} - {% elsif page.carpentry == "lc" %} + {% elsif site.carpentry == "lc" %} From 1f2dd240d9c761577d2274c9938ca559dfbe1071 Mon Sep 17 00:00:00 2001 From: "Michael R. Crusoe" Date: Tue, 11 Jul 2017 14:59:42 +0300 Subject: [PATCH 16/16] initial setup --- AUTHORS | 1 + CITATION | 1 + CONTRIBUTING.md | 150 +++++++++++++++++++++++++++++++++++++++++++ _config.yml | 73 +++++++++++++++++++++ _episodes/01-introduction.md | 15 +++++ _extras/about.md | 6 ++ _extras/discuss.md | 6 ++ _extras/figures.md | 6 ++ _extras/guide.md | 6 ++ _includes/all_figures.html | 1 + aio.md | 36 +++++++++++ index.md | 10 +++ reference.md | 8 +++ setup.md | 6 ++ 14 files changed, 325 insertions(+) create mode 100644 AUTHORS create mode 100644 CITATION create mode 100644 CONTRIBUTING.md create mode 100644 _config.yml create mode 100644 _episodes/01-introduction.md create mode 100644 _extras/about.md create mode 100644 _extras/discuss.md create mode 100644 _extras/figures.md create mode 100644 _extras/guide.md create mode 100644 _includes/all_figures.html create mode 100644 aio.md create mode 100644 index.md create mode 100644 reference.md create mode 100644 setup.md diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..659aeec --- /dev/null +++ b/AUTHORS @@ -0,0 +1 @@ +FIXME: list authors' names and email addresses. diff --git a/CITATION b/CITATION new file mode 100644 index 0000000..d5bfc2b --- /dev/null +++ b/CITATION @@ -0,0 +1 @@ +FIXME: describe how to cite this lesson. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5d15dc0 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,150 @@ +# Contributing + +The [Common Workflow Language project](cwl-site) is an open source project, +and we welcome contributions of all kinds: +new lessons, +fixes to existing material, +bug reports, +and reviews of proposed changes are all welcome. + +## Contributor Agreement + +By contributing, +you agree that we may redistribute your work under [our license](LICENSE.md). +In exchange, +we will address your issues and/or assess your change proposal as promptly as we can, +and help you become a member of our community. +Everyone involved in the [Common Workflow Language project](cwl-site) +agrees to abide by our [code of conduct](CONDUCT.md). + +## How to Contribute + +The easiest way to get started is to file an issue +to tell us about a spelling mistake, +some awkward wording, +or a factual error. +This is a good way to introduce yourself +and to meet some of our community members. + +1. If you do not have a [GitHub][github] account, + you can [send us comments by email][contact]. + However, + we will be able to respond more quickly if you use one of the other methods described below. + +2. If you have a [GitHub][github] account, + or are willing to [create one][github-join], + but do not know how to use Git, + you can report problems or suggest improvements by [creating an issue][issues]. + This allows us to assign the item to someone + and to respond to it in a threaded discussion. + +3. If you are comfortable with Git, + and would like to add or change material, + you can submit a pull request (PR). + Instructions for doing this are [included below](#using-github). + +## Where to Contribute + +1. If you wish to change this lesson, + please work in , + which can be viewed at . + +2. If you wish to change the example lesson, + please work in , + which documents the format of our lessons + and can be viewed at . + +3. If you wish to change the template used for workshop websites, + please work in . + The home page of that repository explains how to set up workshop websites, + while the extra pages in + provide more background on our design choices. + +4. If you wish to change CSS style files, tools, + or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`, + please work in . + +## What to Contribute + +There are many ways to contribute, +from writing new exercises and improving existing ones +to updating or filling in the documentation +and and submitting [bug reports][issues] +about things that don't work, aren't clear, or are missing. +If you are looking for ideas, +please see [the list of issues for this repository][issues], +or the issues for [Common Workflow Language](cwl-issues) project itself. + +Comments on issues and reviews of pull requests are just as welcome: +we are smarter together than we are on our own. +Reviews from novices and newcomers are particularly valuable: +it's easy for people who have been using these lessons for a while +to forget how impenetrable some of this material can be, +so fresh eyes are always welcome. + + +## Using GitHub + +If you choose to contribute via GitHub, +you may want to look at +[How to Contribute to an Open Source Project on GitHub][how-contribute]. +In brief: + +1. The published copy of the lesson is in the `gh-pages` branch of the repository + (so that GitHub will regenerate it automatically). + Please create all branches from that, + and merge the [master repository][repo]'s `gh-pages` branch into your `gh-pages` branch + before starting work. + Please do *not* work directly in your `gh-pages` branch, + since that will make it difficult for you to work on other contributions. + +2. We use [GitHub flow][github-flow] to manage changes: + 1. Create a new branch in your desktop copy of this repository for each significant change. + 2. Commit the change in that branch. + 3. Push that branch to your fork of this repository on GitHub. + 4. Submit a pull request from that branch to the [master repository][repo]. + 5. If you receive feedback, + make changes on your desktop and push to your branch on GitHub: + the pull request will update automatically. + +Each lesson has two maintainers who review issues and pull requests +or encourage others to do so. +The maintainers are community volunteers, +and have final say over what gets merged into the lesson. + +## Other Resources + +General discussion of [Common Workflow Language](cwl-site) project +happens on the [discussion mailing list][discuss-list], +which everyone is welcome to join. + +[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry +[dc-lessons]: http://datacarpentry.org/lessons/ +[dc-site]: http://datacarpentry.org/ +[discuss-list]: https://groups.google.com/forum/#!forum/common-workflow-language +[github]: http://github.com +[github-flow]: https://guides.github.com/introduction/flow/ +[github-join]: https://github.com/join +[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github +[issues]: https://github.com/common-workflow-language/user_guide/issues +[repo]: https://github.com/common-workflow-language/user_guide +[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry +[swc-lessons]: http://software-carpentry.org/lessons/ +[swc-site]: http://software-carpentry.org/ +[cwl-site]: http://www.commonwl.org/ diff --git a/_config.yml b/_config.yml new file mode 100644 index 0000000..06bd6d1 --- /dev/null +++ b/_config.yml @@ -0,0 +1,73 @@ +#------------------------------------------------------------ +# Values for this lesson. +#------------------------------------------------------------ + +# Which carpentry is this ("swc", "dc", "lc", or "cwl")? +carpentry: "cwl" + +# Overall title for pages. +title: "Lesson Title" + +# Contact. This *must* include the protocol: if it's an email +# address, it must look like "mailto:lessons@software-carpentry.org", +# or if it's a URL, "https://gitter.im/username/ProjectName". +contact: "mailto:lessons@software-carpentry.org" + +#------------------------------------------------------------ +# Generic settings (should not need to change). +#------------------------------------------------------------ + +# What kind of thing is this ("workshop" or "lesson")? +kind: "lesson" + +# Magic to make URLs resolve both locally and on GitHub. +# See https://help.github.com/articles/repository-metadata-on-github-pages/. +repository: / + +# Sites. +amy_site: "https://amy.software-carpentry.org/workshops" +dc_site: "http://datacarpentry.org" +swc_github: "https://github.com/swcarpentry" +swc_site: "https://software-carpentry.org" +swc_pages: "https://swcarpentry.github.io" +lc_site: "http://librarycarpentry.github.io/" +template_repo: "https://github.com/swcarpentry/styles" +example_repo: "https://github.com/swcarpentry/lesson-example" +example_site: "https://swcarpentry.github.com/lesson-example" +workshop_repo: "https://github.com/swcarpentry/workshop-template" +workshop_site: "https://swcarpentry.github.io/workshop-template" +training_site: "https://swcarpentry.github.io/instructor-training" + +# Surveys. +pre_survey: "https://www.surveymonkey.com/r/swc_pre_workshop_v1?workshop_id=" +post_survey: "https://www.surveymonkey.com/r/swc_post_workshop_v1?workshop_id=" +training_post_survey: "https://www.surveymonkey.com/r/post-instructor-training" + +# Start time in minutes (0 to be clock-independent, 540 to show a start at 09:00 am). +start_time: 0 + +# Specify that things in the episodes collection should be output. +collections: + episodes: + output: true + permalink: /:path/ + extras: + output: true + +# Set the default layout for things in the episodes collection. +defaults: + - values: + root: .. + - scope: + path: "" + type: episodes + values: + layout: episode + +# Files and directories that are not to be copied. +exclude: + - Makefile + - bin + +# Turn off built-in syntax highlighting. +highlighter: false diff --git a/_episodes/01-introduction.md b/_episodes/01-introduction.md new file mode 100644 index 0000000..9bed75f --- /dev/null +++ b/_episodes/01-introduction.md @@ -0,0 +1,15 @@ +--- +title: "Introduction" +teaching: 0 +exercises: 0 +questions: +- "Key question" +objectives: +- "First objective." +keypoints: +- "First key point." +--- +Content here + +{% include links.md %} + diff --git a/_extras/about.md b/_extras/about.md new file mode 100644 index 0000000..aa7beea --- /dev/null +++ b/_extras/about.md @@ -0,0 +1,6 @@ +--- +layout: page +title: About +permalink: /about/ +--- +{% include carpentries.html %} diff --git a/_extras/discuss.md b/_extras/discuss.md new file mode 100644 index 0000000..1d467a4 --- /dev/null +++ b/_extras/discuss.md @@ -0,0 +1,6 @@ +--- +layout: page +title: Discussion +permalink: /discuss/ +--- +FIXME diff --git a/_extras/figures.md b/_extras/figures.md new file mode 100644 index 0000000..de99a57 --- /dev/null +++ b/_extras/figures.md @@ -0,0 +1,6 @@ +--- +layout: page +title: Figures +permalink: /figures/ +--- +{% include all_figures.html %} diff --git a/_extras/guide.md b/_extras/guide.md new file mode 100644 index 0000000..0bad995 --- /dev/null +++ b/_extras/guide.md @@ -0,0 +1,6 @@ +--- +layout: page +title: "Instructor Notes" +permalink: /guide/ +--- +FIXME diff --git a/_includes/all_figures.html b/_includes/all_figures.html new file mode 100644 index 0000000..c341a40 --- /dev/null +++ b/_includes/all_figures.html @@ -0,0 +1 @@ + diff --git a/aio.md b/aio.md new file mode 100644 index 0000000..6d93852 --- /dev/null +++ b/aio.md @@ -0,0 +1,36 @@ +--- +layout: page +permalink: /aio/ +--- + +{% comment %} +Create anchor for each one of the episodes. +{% endcomment %} +{% for episode in site.episodes %} +
+{% endfor %} diff --git a/index.md b/index.md new file mode 100644 index 0000000..e2fcde3 --- /dev/null +++ b/index.md @@ -0,0 +1,10 @@ +--- +layout: lesson +root: . +--- +FIXME: home page introduction + +> ## Prerequisites +> +> FIXME +{: .prereq} diff --git a/reference.md b/reference.md new file mode 100644 index 0000000..87a20cc --- /dev/null +++ b/reference.md @@ -0,0 +1,8 @@ +--- +layout: reference +permalink: /reference/ +--- + +## Glossary + +FIXME diff --git a/setup.md b/setup.md new file mode 100644 index 0000000..2dc2e46 --- /dev/null +++ b/setup.md @@ -0,0 +1,6 @@ +--- +layout: page +title: Setup +permalink: /setup/ +--- +FIXME