X-Git-Url: https://git.arvados.org/rnaseq-cwl-training.git/blobdiff_plain/9c447b8e6ca87637b4ada4a6361c56d06cd8f0f8..d2710514cf299b6d1f1261054442e043aeda201c:/bin/lesson_initialize.py diff --git a/bin/lesson_initialize.py b/bin/lesson_initialize.py index cfd8f6f..b26bf28 100755 --- a/bin/lesson_initialize.py +++ b/bin/lesson_initialize.py @@ -3,10 +3,10 @@ """Initialize a newly-created repository.""" +from __future__ import print_function import sys import os - ROOT_AUTHORS = '''\ FIXME: list authors' names and email addresses. ''' @@ -61,7 +61,28 @@ and to meet some of our community members. you can submit a pull request (PR). Instructions for doing this are [included below](#using-github). -## What We're Looking For +## 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 @@ -80,7 +101,7 @@ 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. -## What We're *Not* Looking For +## 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. @@ -96,16 +117,9 @@ 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. -## Getting Started - -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. +## Using GitHub -If you want to start adding or fixing material yourself, +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: @@ -132,11 +146,6 @@ or encourage others to do so. The maintainers are community volunteers, and have final say over what gets merged into the lesson. -## Our Template - -[This documentation][example-site] explains how we format our lessons -(and is itself an example of that formatting). - ## Other Resources General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site] @@ -154,8 +163,8 @@ You can also [reach us by email][contact]. [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/{USERNAME}/{LESSON-NAME}/issues/ -[repo]: https://github.com/{USERNAME}/{LESSON-NAME}/ +[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/ @@ -166,48 +175,49 @@ ROOT_CONFIG_YML = '''\ # Values for this lesson. #------------------------------------------------------------ -# Which carpentry is this ("swc" or "dc")? +# Which carpentry is this ("swc", "dc", or "lc")? carpentry: "swc" -# What kind of thing is this ("workshop" or "lesson")? -kind: "lesson" - # Overall title for pages. title: "Lesson Title" -# Account (without slashes). -account: "[[USER-NAME]]" - -# Root URL below account (without slashes). -project: "[[REPO-NAME]]" - -# Contact email address. -email: "[[CONTACT-ADDRESS]]" +# 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). #------------------------------------------------------------ -# Is this production or development? (Overridden in _config_dev.yml.) -is_production: true +# 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: "https://datacarpentry.org" +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 (540 is 09:00 am) -start_time: 540 +# 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: @@ -219,6 +229,8 @@ collections: # Set the default layout for things in the episodes collection. defaults: + - values: + root: .. - scope: path: "" type: episodes @@ -237,6 +249,7 @@ highlighter: false ROOT_INDEX_MD = '''\ --- layout: lesson +root: . --- FIXME: home page introduction @@ -249,6 +262,7 @@ FIXME: home page introduction ROOT_REFERENCE_MD = '''\ --- layout: reference +permalink: /reference/ --- ## Glossary @@ -309,12 +323,16 @@ permalink: /figures/ EXTRAS_GUIDE_MD = '''\ --- layout: page -title: "Instructors' Guide" +title: "Instructor Notes" permalink: /guide/ --- FIXME ''' +INCLUDES_ALL_FIGURES_HTML = '''\ + +''' + BOILERPLATE = ( ('AUTHORS', ROOT_AUTHORS), ('CITATION', ROOT_CITATION), @@ -327,7 +345,8 @@ BOILERPLATE = ( ('_extras/about.md', EXTRAS_ABOUT_MD), ('_extras/discuss.md', EXTRAS_DISCUSS_MD), ('_extras/figures.md', EXTRAS_FIGURES_MD), - ('_extras/guide.md', EXTRAS_GUIDE_MD) + ('_extras/guide.md', EXTRAS_GUIDE_MD), + ('_includes/all_figures.html', INCLUDES_ALL_FIGURES_HTML) )