Merge pull request #66 from zenmonkeykstop/master

Contributor updates

README.md

@@ -6,11 +6,40 @@ This curriculum is hosted by [OpenNews](https://opennews.org/), a team that help
 
 This is a living resource and we welcome your [contributions](docs/contributing.md) and [feedback](https://github.com/OpenNewsLabs/field-guide-security-training-newsroom/issues).
 
-Our goal is not to replicate good work that other organizations have already done, so if you know about great training resources for security trainers, we'd love to add those to our [resource roundup](docs/Chapter03-02-Resources.md).
+Our goal is not to replicate good work that other organizations have already done, so if you know about great training resources for security trainers, we'd love to add those to our [resource roundup](https://the-field-guide-to-security-training-in-the-newsroom.readthedocs.io/en/latest/Chapter03-01-Resources.html).
 
 ## More ways to contribute
 
-* **Share examples from the news:** Every lesson plan in Chapter 2 ends with a list of links in the news that capture the importance of the material covered in that lesson. If your favorite links are missing, we'd love to add them. If you're comfortable with GitHub, we welcome [Pull Requests](https://github.com/OpenNewsLabs/field-guide-security-training-newsroom/pulls) and [new Issues](https://github.com/OpenNewsLabs/field-guide-security-training-newsroom/issues/new), or you can also [drop us an email anytime](mailto:fieldguide@opennews.org).
-* **Share your favorite resources:** We also wrap each lesson with links to other lesson plans—from EFF, Freedom of the Press Foundationm, and elsewhere—that cover the same material for a different audience or with a different approach. If your favorite lesson plans are missing, we'd love to add those, too.
+* **Tell us about your experience:** Have you used *The Field Guide to Security Training in the Newsroom* to lead a workshop in your newsroom? [We'd love to hear about it](mailto:fieldguide@opennews.org). We're also looking for newsrooms that want to work closely with us to lead trainings and edit the guide in the process. Email us if this sounds like you.
+
+* **New lessons, and lesson ideas.** As new tools are developed and new threats emerge, we plan to add lesson plans to cover them. [Let us know](mailto:fieldguide@opennews.org) what topics you're most interested in seeing covered, or share an agenda from a workshop you've used with your peers. If you want to get started on a lesson plan right away, you'll find Markdown and HTML templates in the project's `templates` directory. 
+
+* **Resource links and glossary items.** Chapter 3 includes a glossary and links to existing security resources, to complement and extend the topics covered in our lesson plans. If your favourite links are missing, we'd love to add them!
+If you're comfortable with GitHub, we welcome [Pull Requests](https://github.com/OpenNewsLabs/field-guide-security-training-newsroom/pulls) and [new Issues](https://github.com/OpenNewsLabs/field-guide-security-training-newsroom/issues/new), or you can also [drop us an email anytime](mailto:fieldguide@opennews.org).
+
+* **Translation and localization.** The initial version of the guide was written with North American English-speaking newsrooms in mind, but digital security is important for journalists working in all communities and languages. If you can provide translations of the existing guide resources, or if you'd like to add lesson plans covering topics more relevant to your community, please [contact us](mailto:fieldguide@opennews.org). 
+
 * **Pick up an existing need:** Our [GitHub Issues list](https://github.com/OpenNewsLabs/field-guide-security-training-newsroom/issues) captures specific tasks that need to be addressed. If you're looking for a way to contribute, grab a ticket!
-* **Tell us about your experience:** Have you used *The Field Guide to Security Training in the Newsroom* to lead a workshop in your newsroom? [We'd love to hear about it](mailto:fieldguide@opennews.org).
+
+## Building the Guide
+
+The field guide is published on ReadTheDocs using Sphinx, a Python-based documentation system. If you have changes to share and want to preview them before sending us a pull request, here's how to build the guide locally. (Note that these instructions assume a Unix-like environment. If you're using OS X or Linux, you should be good to go. Windows 10 users should consider enabling the Windows Subsystem for Linux - users of earlier Windows versions should look into [Cygwin](https://www.cygwin.com/).) 
+
+1. If they're not already available, install Python 2 and pip. For more information, see the [Python Beginners Guide](https://wiki.python.org/moin/BeginnersGuide/Download).
+2. From the command line, use pip to install the necessary modules:
+```bash
+pip install recommonmark
+pip install sphinx sphinx-autobuild sphinx_rtd_theme
+```
+(If you encounter permission errors, you may need to run the commands with a `sudo` at the beginning, eg. `sudo pip install recommonmark`.)
+
+3. If you haven't already done so, fork the project on Github and clone your fork on your local computer.
+4. From the command line, `cd` into the project's `docs` subdirectory.
+5. Run the command `make html`. This will build the guide in the `docs/_build/html` project subdirectory.
+
+(The `make` utility is installed by default on most unix-like environments. If you see errors like `make: command not found`, you should install the base development tools for your environment, which will include `make`.)
+
+6. Open the file `docs/_build/html/index.html` in your browser to view the local copy of the guide.
+
+7. Run `make html` again after any changes to update your local copy.
+

templates/template.html

@@ -0,0 +1,39 @@
+<h1 id="lesson-plan-name">[ Lesson Plan Name ]</h1>
+<h2 id="overview">Overview</h2>
+<p>[ What problems does this tool or approach solve, and what problems does it not solve? Eg. &quot;Signal does a great job of protecting the content of an SMS message in transit, and they don't store metadata on their servers, but messages stored on your phone are only as secure as your phone. And messages you send to someone else are only as secure as their phone.&quot; Include a succinct statement about what the goals of the segment are -- what should a participant understand by the end? ]</p>
+<h2 id="about-this-lesson-plan">About This Lesson Plan</h2>
+<p><strong>Review date:</strong> [ When was the last time this was reviewed or updated?]<br />
+<strong>Lesson duration:</strong> [ Roughly how long should it take to lead participants through this lesson plan? 20 minutes? An hour? More? ]<br />
+<strong>Level:</strong> [ Introductory/Intermediate/Advanced ]</p>
+<p><strong>Preconditions</strong><br />
+[ Concepts that the lesson assumes participants already understand, or lesson plans considered a prerequisite for this one. ]</p>
+<p><strong>What materials will participants need?</strong><br />
+[ eg. phone, laptop? ]</p>
+<p><strong>How should participants prepare?</strong><br />
+[ Do participants need to download anything? Review anything? ]</p>
+<p><strong>What materials will the instructor need?</strong><br />
+[ Handout? Software? Projector? Dongle? Check out Chapter 1 for more tips on planning ahead as an instructor. ]</p>
+<p><strong>How should the instructor prepare?</strong><br />
+[ If an instructor wants to build up their own knowledge base, what do they need to know? ]</p>
+<p><strong>Advance email</strong><br />
+[ At least one possible email that a could send out to participants or crib from so that they come prepared. Eg. &quot;Folks! On Friday in our weekly brown bag, I'm going to answer all your questions about making peanut butter sandwiches. Please be sure you've at least tasted peanut butter by then. You will need to bring two slices of bread. I'll have epi-pens and whole wheat bread. Please be sure to tell me if you can't eat wheat. If you have time I encourage you to read at least one of these excellent articles about why everyone should know how to make a peanut butter sandwich.&quot; ]</p>
+<p><strong>Followup email</strong><br />
+[ at least one possible email that an intructor could follow up with. It should include:</p>
+<ul>
+<li>a recap of the key points so participants can refer back to it,</li>
+<li>some outside reference links for context</li>
+<li>a followup exercise. Eg. &quot;Thanks for coming to the peanut butter sandwich brown bag session. I'm attaching a link to an excellent YouTube video about spreading techniques. We talked about using a knife, choosing jams that spread well, and how to think about bread. Your homework is to make at least one sandwich with creamy PB and one with crunchy and report back to me by Tuesday on how that went.&quot; ]</li>
+</ul>
+<h2 id="lesson-plan">Lesson Plan</h2>
+<p><strong>Icebreakers/activities</strong><br />
+[ Is there a recommended icebreaker or activity that will help set the tone, or illustrate a concept? Feel free to link out for these. ]</p>
+<p><strong>Walkthrough or Active Lesson</strong><br />
+[ A hands on activity that will help participants either implement the tool -- ideally with some notes about stumbling blocks - or drive home the concept in a useful way. If you're installing or demonstrating a specific tool, make sure there's enough information here to get around potential roadblocks. ]</p>
+<h2 id="recommended-reading">Recommended Reading</h2>
+<p><strong>Links in the news</strong><br />
+[ As many links as are useful to illustrate this concept or need for security. ]</p>
+<ul>
+<li><a href="URL">Title of News Story (Outlet, Date)</a></li>
+</ul>
+<p><strong>More great lesson plans</strong><br />
+[Links to as many other curricula and How-to articles that cover the same material as we can fit.]</p>

templates/template.md

@@ -0,0 +1,62 @@
+# \[ Lesson Plan Name \]
+
+## Overview
+ \[ What problems does this tool or approach solve, and what
+problems does it not solve? Eg. "Signal does a great job of protecting
+the content of an SMS message in transit, and they don't store metadata
+on their servers, but messages stored on your phone are only as secure
+as your phone. And messages you send to someone else are only as secure
+as their phone." 
+Include a succinct statement about what the goals of the segment are -- what
+should a participant understand by the end? \]
+
+## About This Lesson Plan
+
+**Review date:** \[ When was the last time this was reviewed or updated?\]  
+**Lesson duration:** \[ Roughly how long should it take to lead participants through this lesson plan? 20 minutes? An hour? More? \]  
+**Level:** \[ Introductory/Intermediate/Advanced \] 
+
+**Preconditions**  
+\[ Concepts that the lesson assumes participants already understand, or lesson plans considered a prerequisite for this one. \]
+
+**What materials will participants need?**  
+\[ eg. phone, laptop? \]
+
+**How should participants prepare?**  
+\[ Do participants need to download anything? Review anything? \]
+
+**What materials will the instructor need?**  
+\[ Handout? Software? Projector? Dongle? Check out Chapter 1 for more tips on planning ahead as an instructor. \]
+
+**How should the instructor prepare?**  
+\[ If an instructor wants to build up their own knowledge base, what do they
+need to know? \]
+
+**Advance email**  
+\[ At least one possible email that a could send out to participants or crib from so that they come prepared. Eg. "Folks! On Friday in our weekly brown bag, I'm going to answer all your questions about making peanut butter sandwiches. Please be sure you've at least tasted peanut butter by then. You will need to bring two slices of bread. I'll have epi-pens and whole wheat bread. Please be sure to tell me if you can't eat wheat. If you have time I encourage you to read at least one of these excellent articles about why everyone should know how to make a peanut butter sandwich." \]
+
+**Followup email**  
+\[ at least one possible email that an intructor could follow up with. It should include:
+
++ a recap of the key points so participants can refer back to it,
++ some outside reference links for context
++ a followup exercise. Eg. "Thanks for coming to the peanut butter sandwich brown bag session. I'm attaching a link to an excellent YouTube video about spreading techniques. We talked about using a knife, choosing jams that spread well, and how to think about bread. Your homework is to make at least one sandwich with creamy PB and one with crunchy and report back to me by Tuesday on how that went." \]
+
+## Lesson Plan
+
+**Icebreakers/activities**  
+\[ Is there a recommended icebreaker or activity that will help set the tone, or illustrate a concept? Feel free to link out for these. \]
+
+**Walkthrough or Active Lesson**  
+\[ A hands on activity that will help participants either implement the tool -- ideally with some notes about stumbling blocks - or drive home the concept in a useful way. If you're installing or demonstrating a specific tool, make sure there's enough information here to get around potential roadblocks. \]
+
+## Recommended Reading
+
+**Links in the news**  
+\[ As many links as are useful to illustrate this concept or need for security. \]
+
+* [Title of News Story (Outlet, Date)](URL)
+
+
+**More great lesson plans**  
+\[Links to as many other curricula and How-to articles that cover the same material as we can fit.\]