From 50175bb4bd00dec53309d088e667c98c5602645b Mon Sep 17 00:00:00 2001 From: Toby Hodges Date: Tue, 25 Aug 2020 14:13:42 +0200 Subject: [PATCH 1/5] initialise lesson to use remote theme --- AUTHORS | 1 + CITATION | 1 + README.md | 40 +++++++++++++++++++++++++++++++++++++ _extras/discuss.md | 6 ++++++ _extras/guide.md | 6 ++++++ episodes/01-introduction.md | 15 ++++++++++++++ index.md | 17 ++++++++++++++++ reference.md | 9 +++++++++ setup.md | 7 +++++++ 9 files changed, 102 insertions(+) create mode 100644 AUTHORS create mode 100644 CITATION create mode 100644 README.md create mode 100644 _extras/discuss.md create mode 100644 _extras/guide.md create mode 100644 episodes/01-introduction.md create mode 100644 index.md create mode 100644 reference.md create mode 100644 setup.md diff --git a/AUTHORS b/AUTHORS new file mode 100644 index 0000000..04e1f5a --- /dev/null +++ b/AUTHORS @@ -0,0 +1 @@ +FIXME: list authors' names and email addresses. \ No newline at end of file diff --git a/CITATION b/CITATION new file mode 100644 index 0000000..56ece3c --- /dev/null +++ b/CITATION @@ -0,0 +1 @@ +FIXME: describe how to cite this lesson. \ No newline at end of file diff --git a/README.md b/README.md new file mode 100644 index 0000000..060994a --- /dev/null +++ b/README.md @@ -0,0 +1,40 @@ +# FIXME Lesson title + +[![Create a Slack Account with us](https://img.shields.io/badge/Create_Slack_Account-The_Carpentries-071159.svg)](https://swc-slack-invite.herokuapp.com/) + +This repository generates the corresponding lesson website from [The Carpentries](https://carpentries.org/) repertoire of lessons. + +## Contributing + +We welcome all contributions to improve the lesson! Maintainers will do their best to help you if you have any +questions, concerns, or experience any difficulties along the way. + +We'd like to ask you to familiarize yourself with our [Contribution Guide](CONTRIBUTING.md) and have a look at +the [more detailed guidelines][lesson-example] on proper formatting, ways to render the lesson locally, and even +how to write new episodes. + +Please see the current list of [issues][FIXME] for ideas for contributing to this +repository. For making your contribution, we use the GitHub flow, which is +nicely explained in the chapter [Contributing to a Project](http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project) in Pro Git +by Scott Chacon. +Look for the tag ![good_first_issue](https://img.shields.io/badge/-good%20first%20issue-gold.svg). This indicates that the maintainers will welcome a pull request fixing this issue. + + +## Maintainer(s) + +Current maintainers of this lesson are + +* FIXME +* FIXME +* FIXME + + +## Authors + +A list of contributors to the lesson can be found in [AUTHORS](AUTHORS) + +## Citation + +To cite this lesson, please consult with [CITATION](CITATION) + +[lesson-example]: https://carpentries.github.io/lesson-example diff --git a/_extras/discuss.md b/_extras/discuss.md new file mode 100644 index 0000000..bfc33c5 --- /dev/null +++ b/_extras/discuss.md @@ -0,0 +1,6 @@ +--- +title: Discussion +--- +FIXME + +{% include links.md %} diff --git a/_extras/guide.md b/_extras/guide.md new file mode 100644 index 0000000..50f266f --- /dev/null +++ b/_extras/guide.md @@ -0,0 +1,6 @@ +--- +title: "Instructor Notes" +--- +FIXME + +{% include links.md %} diff --git a/episodes/01-introduction.md b/episodes/01-introduction.md new file mode 100644 index 0000000..2e156c2 --- /dev/null +++ b/episodes/01-introduction.md @@ -0,0 +1,15 @@ +--- +title: "Introduction" +teaching: 0 +exercises: 0 +questions: +- "Key question (FIXME)" +objectives: +- "First learning objective. (FIXME)" +keypoints: +- "First key point. Brief Answer to questions. (FIXME)" +--- +FIXME + +{% include links.md %} + diff --git a/index.md b/index.md new file mode 100644 index 0000000..95ccdbd --- /dev/null +++ b/index.md @@ -0,0 +1,17 @@ +--- +layout: lesson +root: . # Is the only page that doesn't follow the pattern /:path/index.html +permalink: index.html # Is the only page that doesn't follow the pattern /:path/index.html +--- +FIXME: home page introduction + + + +{% comment %} This is a comment in Liquid {% endcomment %} + +> ## Prerequisites +> +> FIXME +{: .prereq} + +{% include links.md %} diff --git a/reference.md b/reference.md new file mode 100644 index 0000000..8c82616 --- /dev/null +++ b/reference.md @@ -0,0 +1,9 @@ +--- +layout: reference +--- + +## Glossary + +FIXME + +{% include links.md %} diff --git a/setup.md b/setup.md new file mode 100644 index 0000000..b8c5032 --- /dev/null +++ b/setup.md @@ -0,0 +1,7 @@ +--- +title: Setup +--- +FIXME + + +{% include links.md %} From ca96911a345eb60a2591cace3eb5d691272b0454 Mon Sep 17 00:00:00 2001 From: Toby Hodges Date: Tue, 25 Aug 2020 14:52:00 +0200 Subject: [PATCH 2/5] add some notes for Incubator developers --- README.md | 33 ++++++++++++++++++++++++++++++--- 1 file changed, 30 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 060994a..48354af 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,32 @@ [![Create a Slack Account with us](https://img.shields.io/badge/Create_Slack_Account-The_Carpentries-071159.svg)](https://swc-slack-invite.herokuapp.com/) -This repository generates the corresponding lesson website from [The Carpentries](https://carpentries.org/) repertoire of lessons. +**Thanks for contributing to The Carpentries Incubator!** +This repository provides a blank starting point for lessons to be developed +in [The Carpentries](https://carpentries.org/) Incubator. + +A member of the Carpentries Curriculum Team will work with you to +get your lesson listed on the [Community Developed Lessons page][community-lessons] +and make sure you have everything you need to begin developing your new lesson. + +## What to do next + +Before you begin developing your new lesson, +here are a few things we recommend you do: + +* [ ] Decide on a title for your new lesson! + Once you've chosen a new title, you can set the value for `lesson_title` + in [`_config.yml`](_config.yml) +* [ ] Fill in the fields marked `FIXME` in: + * this README + * [`_config.yml`](_config.yml) +* [ ] If you're going to be developing lesson material for the first time + according to our design principles, + consider reading the [Carpentries Curriculum Development Handbook][cdh] +* [ ] Consult the [Lesson Example][lesson-example] website to find out more about + working with the lesson template +* [ ] Update this README with relevant information about your lesson + and delete this section ## Contributing @@ -17,12 +42,12 @@ Please see the current list of [issues][FIXME] for ideas for contributing to thi repository. For making your contribution, we use the GitHub flow, which is nicely explained in the chapter [Contributing to a Project](http://git-scm.com/book/en/v2/GitHub-Contributing-to-a-Project) in Pro Git by Scott Chacon. -Look for the tag ![good_first_issue](https://img.shields.io/badge/-good%20first%20issue-gold.svg). This indicates that the maintainers will welcome a pull request fixing this issue. +Look for the tag ![good_first_issue](https://img.shields.io/badge/-good%20first%20issue-gold.svg). This indicates that the maintainers will welcome a pull request fixing this issue. ## Maintainer(s) -Current maintainers of this lesson are +Current maintainers of this lesson are * FIXME * FIXME @@ -37,4 +62,6 @@ A list of contributors to the lesson can be found in [AUTHORS](AUTHORS) To cite this lesson, please consult with [CITATION](CITATION) +[cdh]: https://cdh.carpentries.org +[community-lessons]: https://carpentries.org/community-lessons [lesson-example]: https://carpentries.github.io/lesson-example From bb39821f4e8b78e737a6f01e340e9b74f1ad8372 Mon Sep 17 00:00:00 2001 From: Toby Hodges Date: Tue, 25 Aug 2020 14:56:31 +0200 Subject: [PATCH 3/5] wording tweaks --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 48354af..1c3fdc5 100644 --- a/README.md +++ b/README.md @@ -3,11 +3,11 @@ [![Create a Slack Account with us](https://img.shields.io/badge/Create_Slack_Account-The_Carpentries-071159.svg)](https://swc-slack-invite.herokuapp.com/) **Thanks for contributing to The Carpentries Incubator!** -This repository provides a blank starting point for lessons to be developed -in [The Carpentries](https://carpentries.org/) Incubator. +This repository provides a blank starting point for lessons to be developed here. -A member of the Carpentries Curriculum Team will work with you to -get your lesson listed on the [Community Developed Lessons page][community-lessons] +A member of the [Carpentries Curriculum Team](https://carpentries.org/team/) +will work with you to get your lesson listed on the +[Community Developed Lessons page][community-lessons] and make sure you have everything you need to begin developing your new lesson. ## What to do next From ae6998eefa7637fce309cbd3cb3b6281880c45bf Mon Sep 17 00:00:00 2001 From: Toby Hodges Date: Tue, 25 Aug 2020 15:15:42 +0200 Subject: [PATCH 4/5] add notes about including URL to lesson pages --- README.md | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/README.md b/README.md index 1c3fdc5..9a004e2 100644 --- a/README.md +++ b/README.md @@ -18,6 +18,7 @@ here are a few things we recommend you do: * [ ] Decide on a title for your new lesson! Once you've chosen a new title, you can set the value for `lesson_title` in [`_config.yml`](_config.yml) +* [ ] Add the URL to your built lesson pages to the repository description\* * [ ] Fill in the fields marked `FIXME` in: * this README * [`_config.yml`](_config.yml) @@ -29,6 +30,13 @@ here are a few things we recommend you do: * [ ] Update this README with relevant information about your lesson and delete this section +\* To set the URL on GitHub, click the gear wheel button next to **About** +on the right of the repository landing page. +The lesson URL structure is **https://carpentries-incubator.github.io/**: +a repository at https://github.com/carpentries-incubator/new-lesson/ will have pages at +the lesson URL https://carpentries-incubator.github.io/new-lesson/. + + ## Contributing We welcome all contributions to improve the lesson! Maintainers will do their best to help you if you have any From 17522ba64625eee4e80096f2d1a46dc185a1d22a Mon Sep 17 00:00:00 2001 From: Toby Hodges Date: Thu, 4 Feb 2021 13:34:05 +0100 Subject: [PATCH 5/5] Add extra step for RMarkdown lessons --- README.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/README.md b/README.md index 9a004e2..ac9d7f2 100644 --- a/README.md +++ b/README.md @@ -27,9 +27,12 @@ here are a few things we recommend you do: consider reading the [Carpentries Curriculum Development Handbook][cdh] * [ ] Consult the [Lesson Example][lesson-example] website to find out more about working with the lesson template +* [ ] If you are planning to write your lesson in RMarkdown, + [create a `main` branch and set this as the default branch in your repository settings][change-default-branch] * [ ] Update this README with relevant information about your lesson and delete this section + \* To set the URL on GitHub, click the gear wheel button next to **About** on the right of the repository landing page. The lesson URL structure is **https://carpentries-incubator.github.io/**: @@ -71,5 +74,6 @@ A list of contributors to the lesson can be found in [AUTHORS](AUTHORS) To cite this lesson, please consult with [CITATION](CITATION) [cdh]: https://cdh.carpentries.org +[change-default-branch]: https://docs.github.com/en/github/administering-a-repository/changing-the-default-branch [community-lessons]: https://carpentries.org/community-lessons [lesson-example]: https://carpentries.github.io/lesson-example