From 12506a4b66016088a5c8582ac6e34ccb2cdb13f3 Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Tue, 14 Mar 2017 14:22:16 +0000 Subject: [PATCH 01/12] Improve wording on syllabus.html As suggested by @gcapes. --- _includes/syllabus.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/syllabus.html b/_includes/syllabus.html index 118e584..1adfac4 100644 --- a/_includes/syllabus.html +++ b/_includes/syllabus.html @@ -17,7 +17,7 @@

Schedule

{% if multiday %}{% endif %} Setup - Dowload files used on the lesson. + Download files required for the lesson {% for episode in site.episodes %} {% if episode.start %} {% comment %} Starting a new day? {% endcomment %} From 38307ff35b01ef8c1521473676a43742b5f9601a Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Tue, 4 Apr 2017 08:02:53 +0100 Subject: [PATCH 02/12] 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 10/12] 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 11/12] 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 6cbc02461413706ce4e8d525faf9ebe1c1356928 Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Sat, 6 May 2017 10:27:27 +0100 Subject: [PATCH 12/12] Add files from bin/lesson_initialize.py --- CONTRIBUTING.md | 23 ++++++++++++----------- aio.md | 36 ++++++++++++++++++++++++++++++++++++ 2 files changed, 48 insertions(+), 11 deletions(-) create mode 100644 aio.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 2ab1593..9de5a12 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -45,18 +45,22 @@ and to meet some of our community members. ## Where to Contribute -1. If you wish to change this example lesson, - please work in . - This lesson documents the format of our lessons, +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 . -2. If you wish to change the template used for workshop websites, +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. -3. If you wish to change CSS style files, tools, +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 . @@ -102,8 +106,7 @@ 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 [episodes][episodes] directory - in the `gh-pages` branch of the repository +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 @@ -137,14 +140,12 @@ You can also [reach us by email][contact]. [dc-lessons]: http://datacarpentry.org/lessons/ [dc-site]: http://datacarpentry.org/ [discuss-list]: http://lists.software-carpentry.org/listinfo/discuss -[example-site]: https://swcarpentry.github.io/lesson-example/ [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/swcarpentry/lesson-example/issues/ -[repo]: https://github.com/swcarpentry/lesson-example/ +[issues]: https://github.com/swcarpentry/FIXME/issues/ +[repo]: https://github.com/swcarpentry/FIXME/ [swc-issues]: https://github.com/issues?q=user%3Aswcarpentry [swc-lessons]: http://software-carpentry.org/lessons/ [swc-site]: http://software-carpentry.org/ -[episodes]: _episodes 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 %}