lesson-example

lesson-example copied to clipboard

ep 3: syllabus.html

[{"_id":"63668edaea01ec786e840992","body":"@KerensaMcElroy Thanks for the report. This is a mistake. You don't need to include `syllabus.html`.","issue_id":1662243919717,"origin_id":410986180,"user_origin_id":1506457,"create_time":1533632374,"update_time":1533632374,"id":1667665626579,"updated_at":"2022-11-05T16:27:06.579000Z","created_at":"2022-11-05T16:27:06.579000Z"}]

Hello! I'm working through making an new lesson, and in episode 3 here, under 'starter files' -> 'index', it says to include syllabus.html after the .prereq block. I cannot see...

KerensaMcElroy

Using RMarkdown need better "Key Points"

[{"_id":"636695443056137e26667c59","body":"It looks like this is fixed in the Rmd version of that lesson? Just the md version has the old keypoints.","issue_id":1662243919719,"origin_id":383474132,"user_origin_id":1428071,"create_time":1524466827,"update_time":1524466827,"id":1667667268530,"updated_at":"2022-11-05T16:54:28.530000Z","created_at":"2022-11-05T16:54:28.530000Z"},{"_id":"636695443056137e26667c5a","body":"> It looks like this is fixed in the Rmd version of that lesson?\r\n\r\nI will update the Markdown file.","issue_id":1662243919719,"origin_id":383519871,"user_origin_id":1506457,"create_time":1524477198,"update_time":1524477198,"id":1667667268534,"updated_at":"2022-11-05T16:54:28.534000Z","created_at":"2022-11-05T16:54:28.534000Z"}]

"It shouldn’t be difficult" can be harmful to novices. @swcarpentry/r-maintainers please provide better key points.

rgaiacs

ep6: Do not use subheadings -- really?

[{"_id":"636694c78041c95dfb1e49e7","body":"Related commit: f2f424e","issue_id":1662243919722,"origin_id":406331779,"user_origin_id":13123663,"create_time":1532016674,"update_time":1532016674,"id":1667667143560,"updated_at":"2022-11-05T16:52:23.560000Z","created_at":"2022-11-05T16:52:23.560000Z"},{"_id":"636694c78041c95dfb1e49e8","body":"@gcapes, I could be wrong, but I think the distinction is sub-title versus sub-heading. H2 and H3 formatting is wonderful for breaking up walls of text. However, the title and subtitle are set in the yaml header. All lessons have titles. Most (if not all) lessons have H2 headers. No lessons have sub-titles as defined in the yaml header. \r\n\r\nDoes that make sense?","issue_id":1662243919722,"origin_id":406487311,"user_origin_id":7544197,"create_time":1532061671,"update_time":1532061715,"id":1667667143564,"updated_at":"2022-11-05T16:52:23.564000Z","created_at":"2022-11-05T16:52:23.564000Z"},{"_id":"636694c78041c95dfb1e49e9","body":"@raynamharris Thanks - what you wrote makes perfect sense, but I still think the lesson template page I linked to is confusing on this point.","issue_id":1662243919722,"origin_id":406514637,"user_origin_id":12446270,"create_time":1532072033,"update_time":1532072033,"id":1667667143568,"updated_at":"2022-11-05T16:52:23.568000Z","created_at":"2022-11-05T16:52:23.568000Z"},{"_id":"636694c78041c95dfb1e49ea","body":"@gcapes @maxim-belkin I suggested a change in \r\nhttps:\/\/github.com\/carpentries\/lesson-example\/pull\/225. not sure if that works or helps...","issue_id":1662243919722,"origin_id":406742929,"user_origin_id":7544197,"create_time":1532125927,"update_time":1532125953,"id":1667667143571,"updated_at":"2022-11-05T16:52:23.571000Z","created_at":"2022-11-05T16:52:23.571000Z"}]

In [episode 4](http://carpentries.github.io/lesson-example/04-formatting/index.html) there is a recommendation not to use sub-titles in episodes. Perhaps it's a wording ambiguity, but that very page (and indeed the whole lesson example repo) makes...

gcapes

Style Guide should mention standardize use of Carpentry/Carpentries/The Carpentries

[]

This is related to https://github.com/carpentries/instructor-training/issues/639. http://swcarpentry.github.io/lesson-example/06-style-guide/index.html should mention the "correct" way to mention the organisation. Also, would be good if our validation tool check for it.

rgaiacs

Add SVG style guide

[{"_id":"63668f4fd297b621323d1a00","body":"As mentioned in https:\/\/github.com\/swcarpentry\/lesson-example\/pull\/179, LibreOffice 6.0.1.1 looks good. This need to go into the style guide.","issue_id":1662243919727,"origin_id":366932933,"user_origin_id":1506457,"create_time":1519122238,"update_time":1519122238,"id":1667665743555,"updated_at":"2022-11-05T16:29:03.554000Z","created_at":"2022-11-05T16:29:03.554000Z"}]

Following up with https://github.com/swcarpentry/lesson-example/issues/171 and https://github.com/swcarpentry/styles/pull/203, we might need to clean up SVG files until Firefox or LibreOffice developers fix some issues, see links in the issue link before. I...

rgaiacs

It is awkward that this is both a template and instructions

[{"_id":"63668aa84267bf3cd44b26c8","body":"Hi @remram44, Thanks for the constructive feedback.\r\n\r\n> However this repository also contains important information about creating\/maintaining lessons. I think those two things really ought to be broken apart, into a simple template\/example, and a \"author\/maintainer lesson\" (or added to maintainer-onboarding?)\r\n\r\nSome information are here because we didn't have a place to add it in a few months. @ErinBecker can move some content to https:\/\/github.com\/carpentries\/maintainer-onboarding as she is leading the maintainers onboarding.","issue_id":1662243919730,"origin_id":358605298,"user_origin_id":1506457,"create_time":1516271466,"update_time":1516271466,"id":1667664552349,"updated_at":"2022-11-05T16:09:12.348000Z","created_at":"2022-11-05T16:09:12.348000Z"},{"_id":"63668aa84267bf3cd44b26c9","body":"I don't think this repository is still the template for new lessons. Until the Workbench is complete, the [Styles repository](https:\/\/github.com\/carpentries\/styles) serves as the lesson template.\r\n\r\nShould this issue be closed?","issue_id":1662243919730,"origin_id":1282743807,"user_origin_id":1303898,"create_time":1666113210,"update_time":1666113210,"id":1667664552353,"updated_at":"2022-11-05T16:09:12.352000Z","created_at":"2022-11-05T16:09:12.352000Z"},{"_id":"63668aa84267bf3cd44b26ca","body":"No, this repository is still very much both example and instructions. Having important information about creating a lesson be under the heading \"title here\" is obviously wrong.","issue_id":1662243919730,"origin_id":1282746372,"user_origin_id":426784,"create_time":1666113356,"update_time":1666113356,"id":1667664552356,"updated_at":"2022-11-05T16:09:12.355000Z","created_at":"2022-11-05T16:09:12.355000Z"},{"_id":"63668aa84267bf3cd44b26cb","body":"Ah yes, I see your point. I thought you meant that this repository was the GitHub template repository to base lessons on, but I was wrong about that. I agree that \"title here\" is not helpful and even confusing when we point people to use this lesson as a (style) guide.","issue_id":1662243919730,"origin_id":1282754445,"user_origin_id":1303898,"create_time":1666113802,"update_time":1666113802,"id":1667664552359,"updated_at":"2022-11-05T16:09:12.359000Z","created_at":"2022-11-05T16:09:12.359000Z"}]

I think it is very useful to have a template lesson to easily create new lessons. However this repository also contains important information about creating/maintaining lessons. I think those two...

remram44

Refer learners to exercism.io or other practice resources after lesson?

[{"_id":"636682d7ea01ec786e83fb5c","body":"PS: For `git-novice`, this could be (in addition to what has been posted in https:\/\/github.com\/carpentries\/mentoring\/issues\/31:\r\n- https:\/\/try.github.io\/\r\n- https:\/\/education.github.com\/advisors","issue_id":1662243919732,"origin_id":368799545,"user_origin_id":9948149,"create_time":1519722658,"update_time":1519728684,"id":1667662551495,"updated_at":"2022-11-05T15:35:51.494000Z","created_at":"2022-11-05T15:35:51.494000Z"},{"_id":"636682d7ea01ec786e83fb5d","body":"@ChristinaLK said\r\n\r\n> It might be worth coordinating w\/ the lesson-example\/styles team to figure out where in the template this would be appropriate (I'm guessing another page under \"extras\"?) and then it could be filled in by community members.\r\n\r\nI think a better place would be at the end of the lesson as a last episode. I need to ask other maintainers.","issue_id":1662243919732,"origin_id":368822890,"user_origin_id":1506457,"create_time":1519727226,"update_time":1519727226,"id":1667662551497,"updated_at":"2022-11-05T15:35:51.497000Z","created_at":"2022-11-05T15:35:51.497000Z"},{"_id":"636682d7ea01ec786e83fb5e","body":"Another potential resource with focus on FLOSS contributions: https:\/\/openhatch.org\/missions\/","issue_id":1662243919732,"origin_id":377685171,"user_origin_id":9948149,"create_time":1522494387,"update_time":1522494387,"id":1667662551500,"updated_at":"2022-11-05T15:35:51.500000Z","created_at":"2022-11-05T15:35:51.500000Z"},{"_id":"636682d7ea01ec786e83fb5f","body":"For regular expressions \/ REs: https:\/\/regexr.com\/ & http:\/\/reg-exp.com\/ have live testing, cheat-sheets, etc. [regexper.com](https:\/\/regexper.com\/documentation.html) generates visual representations (\"Railroad Diagrams\").","issue_id":1662243919732,"origin_id":377770646,"user_origin_id":9948149,"create_time":1522570160,"update_time":1522570375,"id":1667662551503,"updated_at":"2022-11-05T15:35:51.503000Z","created_at":"2022-11-05T15:35:51.503000Z"},{"_id":"636682d7ea01ec786e83fb60","body":"> [...] at the end of the lesson as a last episode.\r\n\r\nGiven that many workshops do not progress to the later episodes due to time constraints, I think additional advice, independent of the episodes should also receive an extra page, like the reference list.","issue_id":1662243919732,"origin_id":381310908,"user_origin_id":9948149,"create_time":1523691710,"update_time":1523691710,"id":1667662551506,"updated_at":"2022-11-05T15:35:51.506000Z","created_at":"2022-11-05T15:35:51.506000Z"}]

Hello :-) This is a repost of [carpentries/mentoring#31](https://github.com/carpentries/mentoring/issues/31) where this repo was mentioned as a more fitting location. How about mentioning some relevant resources like the [exercism.io language tracks](http://exercism.io/languages/) at...

katrinleinweber

Notes about translations workflows

[{"_id":"63668dc64267bf3cd44b2ad3","body":"@ErinBecker Can you add a new section mention the translation process?","issue_id":1662243919735,"origin_id":365339964,"user_origin_id":1506457,"create_time":1518542710,"update_time":1518542710,"id":1667665350232,"updated_at":"2022-11-05T16:22:30.232000Z","created_at":"2022-11-05T16:22:30.232000Z"}]

There's two main ways we need to decide how they are going to work: 1. English as master - other languages as translations 2. All the languages go in their...

dpshelio

Moving to a lesson release hosting scheme

[{"_id":"636682804267bf3cd44b1b0a","body":"Here are some resources to consider (the current release process that relies on github for hosting):\r\n- release repository (tools and hosting): https:\/\/github.com\/swcarpentry\/swc-releases \r\n- and the latest unannounced release: http:\/\/swcarpentry.github.io\/swc-releases\/2017.08\/\r\n\r\nFor point 3., maybe the same principle as the one use in the release could be used:\r\n- top right corner of the page on, e.g., http:\/\/swcarpentry.github.io\/swc-releases\/2017.08\/git-novice\/index.html \r\n- commit automatically created to patch the CSS: https:\/\/github.com\/swcarpentry\/git-novice\/commit\/7c5c12ba6ea07095fb513e3222945cef6ae98f57\r\n","issue_id":1662243919738,"origin_id":321099512,"user_origin_id":244649,"create_time":1502231247,"update_time":1502231247,"id":1667662464439,"updated_at":"2022-11-05T15:34:24.438000Z","created_at":"2022-11-05T15:34:24.438000Z"},{"_id":"636682804267bf3cd44b1b0b","body":"I think this could be a good solution, and is related to this thread that we've had going on for awhile. https:\/\/github.com\/datacarpentry\/R-ecology-lesson\/issues\/154","issue_id":1662243919738,"origin_id":321111802,"user_origin_id":889238,"create_time":1502235739,"update_time":1502235739,"id":1667662464442,"updated_at":"2022-11-05T15:34:24.442000Z","created_at":"2022-11-05T15:34:24.442000Z"},{"_id":"636682804267bf3cd44b1b0c","body":"# Comments on Proposal\r\n\r\nI recommend to make the language a first class citizen on this proposal because (1) it shows to our community that we care about localisation and (2) avoid the need to redirect in the future. For example,\r\n\r\n- `- `https:\/\/lessons.carpentries.org\/<carpentry>\/<lesson_name>\/` returns a page with a link to all available languages, at the moment only English but in the future others;\r\n- `https:\/\/lessons.carpentries.org\/<carpentry>\/<language_code>\/<lesson_name>\/` redirects to `https:\/\/lessons.carpentries.org\/<carpentry>\/<language_code>\/<lesson_name>\/latest\/`;\r\n- `https:\/\/lessons.carpentries.org\/<carpentry>\/<language_code>\/<lesson_name>\/<version>` returns the home page of `<lesson_name>` in <`language_code>` when `<version>` is one of the following\r\n - `YYYY-MM`, where `YYYY` is the year of release and `MM` is the month of release;\r\n - `latest`, a alias for the latest release (this is the same name used by Read the Docs);\r\n - `dev`, a alias for the version stored on GitHub Pages server (this is a special case where we will redirect users).","issue_id":1662243919738,"origin_id":321352637,"user_origin_id":1506457,"create_time":1502305804,"update_time":1502305804,"id":1667662464445,"updated_at":"2022-11-05T15:34:24.445000Z","created_at":"2022-11-05T15:34:24.445000Z"},{"_id":"636682804267bf3cd44b1b0d","body":"One thing that might need to be considered.\r\n\r\nFor the current releases, `YYYY.MM` is used (with a `.` instead of `-`), like Ubuntu but making the year more explicit:\r\n- this can be confusing as it is not looking like iso-8610 (and I got confused a few times),\r\n- however, this has two advantages: it looks like a version number and it is an actual (real) number\r\n","issue_id":1662243919738,"origin_id":322031145,"user_origin_id":244649,"create_time":1502616015,"update_time":1502616015,"id":1667662464448,"updated_at":"2022-11-05T15:34:24.448000Z","created_at":"2022-11-05T15:34:24.448000Z"},{"_id":"636682804267bf3cd44b1b0e","body":"NB: `YYYY-MM` without a day is not [iso 8610](https:\/\/en.wikipedia.org\/wiki\/ISO_8601) either","issue_id":1662243919738,"origin_id":326026625,"user_origin_id":244649,"create_time":1504106769,"update_time":1504106769,"id":1667662464454,"updated_at":"2022-11-05T15:34:24.454000Z","created_at":"2022-11-05T15:34:24.454000Z"},{"_id":"636682804267bf3cd44b1b0f","body":"@twitwi you win .","issue_id":1662243919738,"origin_id":326030844,"user_origin_id":1506457,"create_time":1504107542,"update_time":1504107542,"id":1667662464458,"updated_at":"2022-11-05T15:34:24.458000Z","created_at":"2022-11-05T15:34:24.458000Z"}]

While I know we love living on the development branch 😬 for our lessons, I've been chewing on an idea to better streamline how we build and maintain the web...

jduckles

Should challenges be at the end or throughout a lesson?

[]

There is interest in putting some challenges throughout the lessons, so that they are in the location where the instructors will be using them as they go. https://github.com/swcarpentry/shell-novice/issues/552 The original...

tracykteal