Starting to reformat

AUTHORS

@@ -1,17 +1 @@
-lesson-template was written by:
-Aaron O'Leary <[email protected]>
-Abigail Cabunoc <[email protected]>
-Andy Boughton <[email protected]>
-Bill Mills <[email protected]>
-Francois Michonneau <[email protected]>
-Greg Wilson <[email protected]>
-James Allen <[email protected]>
-John Blischak <[email protected]>
-Jon Pipitone <[email protected]>
-Michael Hansen <[email protected]>
-Piotr Banaszkiewicz <[email protected]>
-Raniere Silva <[email protected]>
-Rémi Emonet <[email protected]>
-Timothée Poisot <[email protected]>
-Trevor Bekolay <[email protected]>
-W. Trevor King <[email protected]>
+Greg Wilson

CONTRIBUTING.md

@@ -1,45 +1,152 @@
-Software Carpentry is an open source project,
+# Contributing
+
+[Software Carpentry][swc-site] and [Data Carpentry][dc-site] are open source projects,
 and we welcome contributions of all kinds:
 new lessons,
 fixes to existing material,
 bug reports,
-and reviews of proposed changes are all equally welcome.
+and reviews of proposed changes are all welcome.
+
+## Contributor Agreement
 
 By contributing,
-you are agreeing that Software Carpentry may redistribute your work under
-[these licenses][license].
-You also agree to abide by our
-[contributor code of conduct][conduct].
+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 [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
+agrees to abide by our [code of conduct](CONDUCT.md).
 
-## Getting Started
+## How to Contribute
 
-1.  We use GitHub flow to manage changes,
-    which is explained in the chapter [Contributing to a Project][pro-git-chapter]
-    in Scott Chacon's book *Pro Git*.
+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.
 
-2.  For our lessons,
-    you should branch from and submit pull requests against the `gh-pages` branch.
+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.
 
-3.  When editing lessons, please only commit changes to the Markdown
-    files, *not* the generated HTML.  We will re-create the HTML after
-    your pull request is merged.  (Working this way ensures that each
-    change only needs to be reviewed once, in one place.)
+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.
 
-4.  If you're looking for things to work on,
-    please see [the list of issues for this repository][issues],
-    or for [our other lessons][swc-lessons].
-    Comments on issues and reviews of pull requests are equally welcome.
+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).
 
-## Other Resources
+## Where to Contribute
+
+1.  If you wish to change this lesson,
+    please work in <https://github.com/swcarpentry/web-data-python>,
+    which can be viewed at <https://swcarpentry.github.io/web-data-python>.
+
+2.  If you wish to change the example lesson,
+    please work in <https://github.com/swcarpentry/lesson-example>,
+    which documents the format of our lessons
+    and can be viewed at <https://swcarpentry.github.io/lesson-example>.
+
+3.  If you wish to change the template used for workshop websites,
+    please work in <https://github.com/swcarpentry/workshop-template>.
+    The home page of that repository explains how to set up workshop websites,
+    while the extra pages in <https://swcarpentry.github.io/workshop-template>
+    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 <https://github.com/swcarpentry/styles>.
+
+## 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 [Data Carpentry][dc-issues]
+and [Software Carpentry][swc-issues] projects.
+
+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.
 
-1.  This lesson is based on the template found at
-    [https://github.com/swcarpentry/lesson-template](https://github.com/swcarpentry/lesson-template).
-    That repository has instructions on formatting and previewing lessons.
+## What *Not* to Contribute
+
+Our lessons already contain more material than we can cover in a typical workshop,
+so we are usually *not* looking for more concepts or tools to add to them.
+As a rule,
+if you want to introduce a new idea,
+you must (a) estimate how long it will take to teach
+and (b) explain what you would take out to make room for it.
+The first encourages contributors to be honest about requirements;
+the second, to think hard about priorities.
+
+We are also not looking for exercises or other material that only run on one platform.
+Our workshops typically contain a mixture of Windows, Mac OS X, and Linux users;
+in order to be usable,
+our lessons must run equally well on all three.
+
+## 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
 
-2.  For a list of helpful commands run `make` in this directory.
+General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site]
+happens on the [discussion mailing list][discuss-list],
+which everyone is welcome to join.
+You can also [reach us by email][contact].
 
-[conduct]: CONDUCT.md
-[issues]: https://github.com/swcarpentry/web-data-python/issues
-[license]: LICENSE.md
-[pro-git-chapter]: http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project
-[swc-lessons]: http://software-carpentry.org/lessons.html
+[contact]: mailto:[email protected]
+[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
+[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/web-data-python/issues/
+[repo]: https://github.com/swcarpentry/web-data-python/
+[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
+[swc-lessons]: http://software-carpentry.org/lessons/
+[swc-site]: http://software-carpentry.org/

README.md

@@ -1,5 +1,5 @@
-web-data
-========
+web-data-python
+===============
 
 Introduction to getting and publishing data over the web for Python programmers.
 

_config.yml

@@ -0,0 +1,67 @@
+#------------------------------------------------------------
+# Values for this lesson.
+#------------------------------------------------------------
+
+# Which carpentry is this ("swc" or "dc")?
+carpentry: "swc"
+
+# Overall title for pages.
+title: "Working With Data on the Web"
+
+# Contact email address.
+email: [email protected]
+
+#------------------------------------------------------------
+# 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: <USERNAME>/<PROJECT>
+
+# 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"
+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="
+
+# 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:
+  - 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

_episodes/01-getdata.md

@@ -1,7 +1,5 @@
 ---
-layout: page
-title: Working With Data on the Web
-subtitle: Getting Data
+title: "Getting Data"
 minutes: 15
 ---
 > ## Learning Objectives {.objectives}

_episodes/02-csv.md

@@ -1,7 +1,5 @@
 ---
-layout: page
-title: Working With Data on the Web
-subtitle: Handling CSV Data
+title: "Handling CSV Data"
 minutes: 15
 ---
 > ## Learning Objectives {.objectives}

_episodes/03-generalize.md

@@ -1,7 +1,5 @@
 ---
-layout: page
-title: Working With Data on the Web
-subtitle: Generalizing and Handling Errors
+title: "Generalizing and Handling Errors"
 minutes: 15
 ---
 > ## Learning Objectives {.objectives}

_episodes/04-visualize.md

@@ -1,7 +1,5 @@
 ---
-layout: page
-title: Working With Data on the Web
-subtitle: Visualization
+title: "Visualization"
 minutes: 15
 ---
 > ## Learning Objectives {.objectives}

_episodes/05-makedata.md

@@ -1,7 +1,5 @@
 ---
-layout: page
-title: Working With Data on the Web
-subtitle: Publishing Data
+title: "Publishing Data"
 minutes: 15
 ---
 > ## Learning Objectives {.objectives}

_episodes/06-findable.md

@@ -1,7 +1,5 @@
 ---
-layout: page
-title: Working With Data on the Web
-subtitle: Making Data Findable
+title: "Making Data Findable"
 minutes: 15
 ---
 > ## Learning Objectives {.objectives}

_extras/discuss.md

@@ -1,7 +1,7 @@
 ---
 layout: page
-title: Working With Data on the Web
-subtitle: Discussion
+title: "Discussion"
+permalink: /discuss/
 ---
 Interactive web applications have transformed science
 (and the rest of society),

_extras/guide.md

@@ -1,7 +1,7 @@
 ---
 layout: page
-title: Working With Data on the Web
-subtitle: Instructor's Guide
+title: "Instructors' Guide"
+permalink: /guide/
 ---
 Getting data from the web is not the hardest part of this lesson
 (in part because libraries like Requests make it so simple).

index.md

@@ -1,6 +1,5 @@
 ---
-layout: page
-title: Working With Data on the Web
+layout: lesson
 ---
 This lesson explains how to consume data from the web,
 and how to create data for others to use.
@@ -14,24 +13,3 @@ and how to create data for others to use.
 > *   Use strings and lists
 > *   Write and call simple functions
 > *   Access the Internet in class
-
-> ## Getting ready {.getready}
->
-> You must have Python and network access,
-> and you will need to be able to install Python libraries on your computer.
-
-## Topics
-
-1.  [Getting Data](01-getdata.html)
-2.  [Handling CSV Data](02-csv.html)
-3.  [Generalizing and Handling Errors](03-generalize.html)
-4.  [Visualization](04-visualize.html)
-5.  [Publishing Data](05-makedata.html)
-6.  [Making Data Findable](06-findable.html)
-
-## Other Resources
-
-*   [Motivation](motivation.html)
-*   [Reference](reference.html)
-*   [Discussion](discussion.html)
-*   [Instructor's Guide](instructors.html)