diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index f19b804..25bd0a8 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -8,6 +8,8 @@ we pledge to follow the [The Carpentries 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 +[coc-reporting]: https://docs.carpentries.org/topic_folders/policies/incident-reporting.html + + + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6c2b81c..2ca82cb 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,18 +21,18 @@ mistake, some awkward wording, or a factual error. This is a good way to introduce yourself and to meet some of our community members. 1. If you do not have a [GitHub][github] account, you can [send us comments by - email][contact]. However, we will be able to respond more quickly if you use - one of the other methods described below. + email][contact]. However, we will be able to respond more quickly if you use + one of the other methods described below. 2. If you have a [GitHub][github] account, or are willing to [create - one][github-join], but do not know how to use Git, you can report problems - or suggest improvements by [creating an issue][repo-issues]. This allows us - to assign the item to someone and to respond to it in a threaded discussion. + one][github-join], but do not know how to use Git, you can report problems + or suggest improvements by [creating an issue][repo-issues]. This allows us + to assign the item to someone and to respond to it in a threaded discussion. 3. If you are comfortable with Git, and would like to add or change material, - you can submit a pull request (PR). Instructions for doing this are - [included below](#using-github). For inspiration about changes that need to - be made, check out the [list of open issues][issues] across the Carpentries. + you can submit a pull request (PR). Instructions for doing this are + [included below](#using-github). For inspiration about changes that need to + be made, check out the [list of open issues][issues] across the Carpentries. Note: if you want to build the website locally, please refer to [The Workbench documentation][template-doc]. @@ -41,8 +41,7 @@ documentation][template-doc]. 1. If you wish to change this lesson, add issues and pull requests here. 2. If you wish to change the template used for workshop websites, please refer - to [The Workbench documentation][template-doc]. - + to [The Workbench documentation][template-doc]. ### What to Contribute @@ -80,12 +79,12 @@ Contribute to an Open Source Project on GitHub][how-contribute]. In brief, we use [GitHub flow][github-flow] to manage changes: 1. Create a new branch in your desktop copy of this repository for each - significant change. + significant change. 2. Commit the change in that branch. 3. Push that branch to your fork of this repository on GitHub. 4. Submit a pull request from that branch to the [upstream repository][repo]. 5. If you receive feedback, make changes on your desktop and push to your - branch on GitHub: the pull request will update automatically. + branch on GitHub: the pull request will update automatically. NB: The published copy of the lesson is usually in the `main` branch. @@ -98,26 +97,26 @@ final say over what gets merged into the lesson. The Carpentries is a global organisation with volunteers and learners all over the world. We share values of inclusivity and a passion for sharing knowledge, teaching and learning. There are several ways to connect with The Carpentries -community listed at including via social +community listed at [https://carpentries.org/connect/](https://carpentries.org/connect/) including via social media, slack, newsletters, and email lists. You can also [reach us by email][contact]. -[repo]: https://example.com/FIXME -[repo-issues]: https://example.com/FIXME/issues -[contact]: mailto:team@carpentries.org [cp-site]: https://carpentries.org/ -[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry -[dc-lessons]: https://datacarpentry.org/lessons/ +[swc-site]: https://software-carpentry.org/ [dc-site]: https://datacarpentry.org/ -[discuss-list]: https://carpentries.topicbox.com/groups/discuss +[lc-site]: https://librarycarpentry.org/ [github]: https://github.com -[github-flow]: https://guides.github.com/introduction/flow/ +[contact]: mailto:team@carpentries.org [github-join]: https://github.com/join -[how-contribute]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github +[repo-issues]: https://github.com/librarycarpentry/lc-overview/issues [issues]: https://carpentries.org/help-wanted-issues/ +[template-doc]: https://carpentries.github.io/workbench/ +[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry [lc-issues]: https://github.com/issues?q=user%3ALibraryCarpentry [swc-issues]: https://github.com/issues?q=user%3Aswcarpentry -[swc-lessons]: https://software-carpentry.org/lessons/ -[swc-site]: https://software-carpentry.org/ -[lc-site]: https://librarycarpentry.org/ -[template-doc]: https://carpentries.github.io/workbench/ +[how-contribute]: https://egghead.io/courses/how-to-contribute-to-an-open-source-project-on-github +[github-flow]: https://guides.github.com/introduction/flow/ +[repo]: https://github.com/librarycarpentry/lc-overview + + + diff --git a/LICENSE.md b/LICENSE.md index 7632871..ff32825 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -12,8 +12,8 @@ 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 +- 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. @@ -22,30 +22,30 @@ terms. Under the following terms: -- **Attribution**---You must give appropriate credit (mentioning that your work +- **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 ), provide a [link to the + practical, linking to [https://carpentries.org/](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 +- **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 +- 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 +- 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 +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 @@ -74,6 +74,9 @@ Initiatives][ci]. [cc-by-human]: https://creativecommons.org/licenses/by/4.0/ [cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode +[osi]: https://opensource.org [mit-license]: https://opensource.org/licenses/mit-license.html [ci]: https://communityin.org/ -[osi]: https://opensource.org + + + diff --git a/config.yaml b/config.yaml index 1f189c4..f0a4e20 100644 --- a/config.yaml +++ b/config.yaml @@ -14,7 +14,7 @@ carpentry: 'lc' title: 'Library Carpentry Workshop Overview' # Date the lesson was created (YYYY-MM-DD, this is empty by default) -created: +created: '2018-05-29' # Comma-separated list of keywords for the lesson keywords: 'software, data, lesson, The Carpentries' diff --git a/episodes/06-file-naming-formatting.md b/episodes/06-file-naming-formatting.md index 788affc..b599e25 100644 --- a/episodes/06-file-naming-formatting.md +++ b/episodes/06-file-naming-formatting.md @@ -85,7 +85,7 @@ There are some simple notation schemes that are also plain text and machine read There are a number of ways we can do this, for instance [hackmd.io](https://hackmd.io/) or [cryptpad.fr/code](https://cryptpad.fr/code), we will use [Dillinger.io](https://dillinger.io/) referenced in the [Markdown Guide](https://www.markdownguide.org/). Go to Dillinger.io and change the headings to bold. -::::::::::::::: solution +:::::::::::::::: spoiler ## Answer diff --git a/index.md b/index.md index 2b9d696..49df2fa 100644 --- a/index.md +++ b/index.md @@ -11,7 +11,6 @@ Library Carpentry aims to teach people working in library- and information-relat Library Carpentry lessons are for people working in library- and information-related roles. See [Our Audience](https://librarycarpentry.org/audience/) and [Our Learner Profiles (Draft)](https://github.com/LibraryCarpentry/lc-overview/blob/gh-pages/files/learner-profiles.md) for more information. - :::::::::::::::::::::::::::::::::::::::::::::::::: :::::::::::::::::::::::::::::::::::::::::: prereq @@ -20,7 +19,6 @@ Library Carpentry lessons are for people working in library- and information-rel There are no prerequisites, and the materials assume no prior knowledge about the tools. - :::::::::::::::::::::::::::::::::::::::::::::::::: :::::::::::::::::::::::::::::::::::::::::: prereq @@ -29,7 +27,6 @@ There are no prerequisites, and the materials assume no prior knowledge about th The data used in this workshop include bibliographic metadata and text-based data. See each lesson for the specific datasets and sources used. - :::::::::::::::::::::::::::::::::::::::::::::::::: :::::::::::::::::::::::::::::::::::::::::: prereq @@ -38,7 +35,6 @@ The data used in this workshop include bibliographic metadata and text-based dat Lesson materials are all available online, under a CC BY license, for self-directed study or for adaptation and re-use (as "Carpentries-based" training). - :::::::::::::::::::::::::::::::::::::::::::::::::: # Workshop Structure @@ -56,7 +52,7 @@ Based on the feedback from Library Carpentry (and the greater Carpentries) commu In response to [strengthening the LC community](https://software.ac.uk/blog/2019-07-26-strengthening-library-carpentry-community), the Curriculum Advisory Committee has been exploring [the addition of new and popular curricula](https://github.com/LibraryCarpentry/governance/issues/14). The table below includes the standard workshop curriculum and two additional curricula that are equally supported. A final option is a "mix and match" approach that the workshop requestor can develop with the Carpentries. As we add more lessons to Library Carpentry, we will offer new curricula in [The Carpentries workshop request form](https://amy.carpentries.org/forms/workshop/) and [LC lessons](https://librarycarpentry.org/lessons/). | Curriculum | Description | Lesson menu | Total time estimated | -| ------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------ | ----------------------------------------------------------------- | ----------------------------------------------- | +| ---------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------- | ----------------------------------------------------------------- | ----------------------------------------------- | | Library Carpentry Standard Workshop | Core lessons | 1\) [Introduction to Working with Data](https://librarycarpentry.org/lc-data-intro/), 2) [The Unix Shell](https://librarycarpentry.org/lc-shell/), 3) [Introduction to Git](https://librarycarpentry.org/lc-git/), 4) [OpenRefine](https://librarycarpentry.org/lc-open-refine/) Note: A standard workshop must include three of the four lessons | 2 days | | Library Carpentry Introduction | A good combination for pilots and workshops connected with conferences and other events | 1\) [Introduction to Library Carpentry](https://librarycarpentry.org/lc-overview/02-intro-to-library-carpentry/index.html), 2) [OpenRefine](https://librarycarpentry.org/lc-open-refine/) | Half day | | Library Carpentry Data Analysis Core | An introduction to data analysis and good practices including versioning, cleaning, automation, manipulation, and structured queries | 1\) [Introduction to Git](https://librarycarpentry.org/lc-git/), 2) [The Unix Shell](https://librarycarpentry.org/lc-shell/), 3) [OpenRefine](https://librarycarpentry.org/lc-open-refine/), 4) [SQL](https://librarycarpentry.org/lc-sql/) | 2 days |