source commit: c25953d

CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+---
+title: "Contributor Code of Conduct"
+---
+
+As contributors and maintainers of this project,
+we pledge to follow the [Carpentry Code of Conduct][coc].
+
+Instances of abusive, harassing, or otherwise unacceptable behavior
+may be reported by following our [reporting guidelines][coc-reporting].
+
+
+[coc-reporting]: https://docs.carpentries.org/topic_folders/policies/incident-reporting.html
+[coc]: https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html

LICENSE.md

@@ -0,0 +1,79 @@
+---
+title: "Licenses"
+---
+
+## Instructional Material
+
+All Carpentries (Software Carpentry, Data Carpentry, and Library Carpentry)
+instructional material is made available under the [Creative Commons
+Attribution license][cc-by-human]. The following is a human-readable summary of
+(and not a substitute for) the [full legal text of the CC BY 4.0
+license][cc-by-legal].
+
+You are free:
+
+- to **Share**---copy and redistribute the material in any medium or format
+- to **Adapt**---remix, transform, and build upon the material
+
+for any purpose, even commercially.
+
+The licensor cannot revoke these freedoms as long as you follow the license
+terms.
+
+Under the following terms:
+
+- **Attribution**---You must give appropriate credit (mentioning that your work
+  is derived from work that is Copyright (c) The Carpentries and, where
+  practical, linking to <https://carpentries.org/>), provide a [link to the
+  license][cc-by-human], and indicate if changes were made. You may do so in
+  any reasonable manner, but not in any way that suggests the licensor endorses
+  you or your use.
+
+- **No additional restrictions**---You may not apply legal terms or
+  technological measures that legally restrict others from doing anything the
+  license permits.  With the understanding that:
+
+Notices:
+
+* You do not have to comply with the license for elements of the material in
+  the public domain or where your use is permitted by an applicable exception
+  or limitation.
+* No warranties are given. The license may not give you all of the permissions
+  necessary for your intended use. For example, other rights such as publicity,
+  privacy, or moral rights may limit how you use the material.
+
+## Software
+
+Except where otherwise noted, the example programs and other software provided
+by The Carpentries are made available under the [OSI][osi]-approved [MIT
+license][mit-license].
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of
+this software and associated documentation files (the "Software"), to deal in
+the Software without restriction, including without limitation the rights to
+use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+of the Software, and to permit persons to whom the Software is furnished to do
+so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+## Trademark
+
+"The Carpentries", "Software Carpentry", "Data Carpentry", and "Library
+Carpentry" and their respective logos are registered trademarks of [Community
+Initiatives][ci].
+
+[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
+[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
+[mit-license]: https://opensource.org/licenses/mit-license.html
+[ci]: https://communityin.org/
+[osi]: https://opensource.org

component-guide.md

@@ -0,0 +1,214 @@
+---
+title: "Workbench Component Guide"
+---
+
+::::::::::::::::::: prereq
+
+### Find out More!
+
+This is the component guide for the workbench. For details on how to create 
+components from [fenced divs][fenced-divs], read the [Callout Blocks section of
+"Episode Structure"](episodes.html#callout-blocks).
+
+::::::::::::::::::::::::::
+
+## Required Sections
+
+The workbench requires `objectives` and `questions` at the beginning and 
+`keypoints` at the end of each episode.
+
+::::::::::::::::: objectives
+
+### OBJECTIVES (`objectives`)
+
+OBJECTIVES callouts are created with the `objectives` tag and outline what the
+learners should take away from the episode.
+
+::::::::::::::::::::::::::::
+
+::::::::::::::::: questions
+
+### QUESTIONS (`questions`)
+
+QUESTIONS callouts are created with the `questions` tag and offer questions for
+the learner before they start the episode.
+
+:::::::::::::::::::::::::::
+
+
+::::::::::::::::: keypoints
+
+### KEYPOINTS (`keypoints`)
+
+KEYPOINTS callouts are created with the `keypoints` tag and offer key takeaways
+from the episode to summarise what the learners should have learned.
+
+:::::::::::::::::::::::::::
+
+
+
+## Instructor Notes
+
+Special sections that only appear on the instructor view (use the button at the
+top right of the page to toggle).
+
+::::::::::::::::::: instructor
+
+### INSTRUCTOR NOTE (`instructor`)
+
+Instructor notes are created with the `instructor` tag
+
+::::::::::::::::::::::::::::::
+
+
+
+## Callout Blocks
+
+Sections to pause the narrative flow of an episode for learners to reflect.
+
+::::::::::::::::: callout
+
+### CALLOUT (`callout`)
+
+CALLOUT callouts are created with the `callout` tag and are an aside or comment.
+
+:::::::::::::::::::::::::
+
+::::::::::::::::: prereq
+
+### PREREQUISITES (`prereq`)
+
+PREREQUISITES callouts are created with the `prereq` tag and indicate things a
+learner needs before starting the episodes (e.g. data from a previous episode or
+and understanding of a particular concept).
+
+::::::::::::::::::::::::
+
+::::::::::::::::: checklist
+
+### CHECKLIST (`checklist`)
+
+CHECKLIST callouts are created with the `checklist` tag and are a way to more
+strongly emphasise particular steps.
+
+:::::::::::::::::::::::::::
+
+::::::::::::::::::::::::::::::::: challenge
+
+### CHALLENGE (`challenge`)
+
+CHALLENGE callouts are created with the `challenge` tag and represent formative
+assessment opportunities for the learners to practice their skills.
+
+::::::::::::::::: hint
+
+### HINT (`hint`)
+
+HINT accordions are created with the `hint` tag and nested within 
+`challenge` callouts. These offer more context for the challenge that can help
+the learner find the solution.
+
+::::::::::::::::::::::
+
+::::::::::::::::: solution
+
+### SOLUTION (`solution`)
+
+SOLUTION accordions are created with the `solution` tag and nested within 
+`challenge` callouts. These provide the learners with the solution to the
+challenge so they can confirm their answers.
+
+::::::::::::::::::::::::::
+
+
+:::::::::::::::::::::::::::::::::::::::::::
+
+::::::::::::::::: discussion
+
+### DISCUSSION (`discussion`)
+
+DISCUSSION callouts are created with the `discussion` tag and represent an
+open-ended formative assessment in which the learners are expected to discuss
+a particular topic with other learners.
+
+::::::::::::::::::::::::::::
+
+::::::::::::::::: testimonial
+
+### TESTIMONIAL (`testimonial`)
+
+TESTIMONIAL callouts are created with the `testimonial` tag and are quotations
+from previous learners or instructors.
+
+:::::::::::::::::::::::::::::
+
+::::::::::::::::: spoiler
+
+### SPOILER (`spoiler`)
+
+SPOILER callouts are created with the `spoiler` tag and
+are a way to provide additional details/content 
+that can be expanded and collapsed on demand.
+
+:::::::::::::::::::::::::
+
+
+### Tabbed Callouts
+
+::::::::::::::::: tab
+
+### Windows
+
+Some Windows instructions
+
+### Mac
+
+Maybe some for Mac
+
+### Linux
+
+And more for Linux users, including a code block:
+
+```python
+  print("Yay, tabs!")
+```
+
+:::::::::::::::::::::::::
+
+### Grouped Tabs
+
+The first tab specified is the default tab. Selecting a tab in one tab group changes the tab in
+the other group(s).
+
+::::::::::::::::::::: group-tab
+
+### Windows
+
+1
+
+### Mac
+
+2
+
+### Linux
+
+3
+
+:::::::::::::::::::::::::::::::
+
+::::::::::::::::::::: group-tab
+
+### Windows
+
+4
+
+### Mac
+
+5
+
+### Linux
+
+6
+
+:::::::::::::::::::::::::::::::
+