Wrap files at 79 characters for cleaner diffs and readability (carpentries-incubator#323)

* wrap episodes (16 retains semantic breaks), wrap snippets
* adjust CI/CD to check line lengths
* couple other text fixes that got caught along the way (mebi, HTMLized dashes)

Closes carpentries-incubator#282.

Author: Trevor Keller

.editorconfig

@@ -0,0 +1,12 @@
+root = true
+
+[*]
+max_line_length = 79
+indent_size = 4
+indent_style = space
+charset = utf-8
+insert_final_newline = true
+trim_trailing_whitespace = true
+
+[Makefile]
+indent_style = tab

.github/workflows/test_and_build.yml

@@ -37,6 +37,9 @@ jobs:
         bundle config set path '.vendor/bundle'
         bundle config build.nokogiri --use-system-libraries
         bundle install
+    - name: "Lint episode markdown"
+      run: |
+        find _episodes -name \*.md -exec bundle exec mdl -r MD001,MD003,MD005,MD006,MD007,MD008,MD009,MD010,MD011,MD012,MD015,MD016,MD017,MD018,MD019,MD020,MD021,MD022,MD023,MD025,MD035,MD036,MD037,MD038,MD039,MD046 {} \;
     - name: "Check lesson for warnings"
       run: |
         make lesson-check-all
@@ -74,3 +77,6 @@ jobs:
     - name: Check build ${{matrix.HPC_JEKYLL_CONFIG}}
       run: |
         make --always-make site HPC_JEKYLL_CONFIG=_includes/snippets_library/${{matrix.HPC_JEKYLL_CONFIG}}/_config_options.yml
+    - name: "Lint snippet markdown"
+      run: |
+        find _includes/snippets_library/${{matrix.HPC_JEKYLL_CONFIG}} -name \*.snip -exec bundle exec mdl -r MD001,MD003,MD005,MD006,MD007,MD008,MD009,MD010,MD011,MD012,MD015,MD016,MD017,MD018,MD019,MD020,MD021,MD022,MD023,MD025,MD035,MD036,MD037,MD038,MD039,MD046 {} \;

CONTRIBUTING.md

@@ -1,107 +1,121 @@
 # Contributing
 
-[Software Carpentry][swc-site] and [Data Carpentry][dc-site] are open source projects, and we
-welcome contributions of all kinds: new lessons, fixes to existing material, bug reports, and
-reviews of proposed changes are all welcome.
+[Software Carpentry][swc-site] and [Data Carpentry][dc-site] are open source
+projects, and we welcome contributions of all kinds: new lessons, fixes to
+existing material, bug reports, and reviews of proposed changes are all
+welcome.
 
 ## Contributor Agreement
 
-By contributing, you agree that we may redistribute your work under [our license](LICENSE.md). In
-exchange, we will address your issues and/or assess your change proposal as promptly as we can, and
-help you become a member of our community. Everyone involved in [Software Carpentry][swc-site] and
-[Data Carpentry][dc-site] agrees to abide by our [code of conduct](CODE_OF_CONDUCT.md).
+By contributing, you agree that we may redistribute your work under [our
+license](LICENSE.md). In exchange, we will address your issues and/or assess
+your change proposal as promptly as we can, and help you become a member of our
+community. Everyone involved in [Software Carpentry][swc-site] and [Data
+Carpentry][dc-site] agrees to abide by our [code of
+conduct](CODE_OF_CONDUCT.md).
 
 ## How to Contribute
 
-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.
+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.
 
-1.  If you do not have a [GitHub][github] account, you can [send us comments by email][email].
-    However, we will be able to respond more quickly if you use one of the other methods described
-    below.
+1. If you do not have a [GitHub][github] account, you can [send us comments by
+   email][email]. 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][issues]. This allows us to assign the item to someone and to respond to it
-    in a threaded discussion.
+1. 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][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).
+1. 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).
 
 ## Where to Contribute
 
-1.  If you wish to change this lesson, please work in <https://github.com/swcarpentry/FIXME>, which
-    can be viewed at <https://swcarpentry.github.io/FIXME>.
+1. If you wish to change this lesson, please work in
+   <https://github.com/carpentries-incubator/hpc-intro>, which can be viewed at
+   <https://carpentries-incubator.github.io/hpc-intro>.
 
-2.  If you wish to change the example lesson, please work in
-    <https://github.com/carpentries/lesson-example>, which documents the format of our lessons and
-    can be viewed at <https://carpentries.github.io/lesson-example>.
+1. If you wish to change the example lesson, please work in
+   <https://github.com/carpentries/lesson-example>, which documents the format
+   of our lessons and can be viewed at
+   <https://carpentries.github.io/lesson-example>.
 
-3.  If you wish to change the template used for workshop websites, please work in
-    <https://github.com/carpentries/workshop-template>. The home page of that repository explains
-    how to set up workshop websites, while the extra pages in
-    <https://carpentries.github.io/workshop-template> provide more background on our design choices.
+1. If you wish to change the template used for workshop websites, please work
+   in <https://github.com/carpentries/workshop-template>. The home page of that
+   repository explains how to set up workshop websites, while the extra pages
+   in <https://carpentries.github.io/workshop-template> 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 <https://github.com/carpentries/styles>.
+1. If you wish to change CSS style files, tools, or HTML boilerplate for
+   lessons or workshops stored in `_includes` or `_layouts`, please work in
+   <https://github.com/carpentries/styles>.
 
 ## What to Contribute
 
-There are many ways to contribute, from writing new exercises and improving existing ones to
-updating or filling in the documentation and submitting [bug reports][issues] about things that
-don't work, aren't clear, or are missing. If you are looking for ideas, please see the 'Issues' tab
-for a list of issues associated with this repository, or you may also look at the issues for
-[Data Carpentry][dc-issues] and [Software Carpentry][swc-issues] projects.
+There are many ways to contribute, from writing new exercises and improving
+existing ones to updating or filling in the documentation and submitting [bug
+reports][issues] about things that don't work, aren't clear, or are missing. If
+you are looking for ideas, please see the 'Issues' tab for a list of issues
+associated with this repository, or you may also look at the issues for [Data
+Carpentry][dc-issues] and [Software Carpentry][swc-issues] projects.
 
-Comments on issues and reviews of pull requests are just as welcome: we are smarter together than we
-are on our own. Reviews from novices and newcomers are particularly valuable: 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.
+Comments on issues and reviews of pull requests are just as welcome: we are
+smarter together than we are on our own. Reviews from novices and newcomers are
+particularly valuable: 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 *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. As a rule, if you want to introduce a new
-idea, you must (a) estimate how long it will take to teach and (b) explain what you would take out
-to make room for it. The first encourages contributors to be honest about requirements; the second,
-to think hard about priorities.
+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. As a rule, if you want to introduce a new idea, you must (a) estimate how
+long it will take to teach and (b) explain what you would take out to make room
+for it. The first encourages contributors to be honest about requirements; the
+second, to think hard about priorities.
 
-We are also not looking for exercises or other material that only run on one platform. Our workshops
-typically contain a mixture of Windows, macOS, and Linux users; in order to be usable, our lessons
-must run equally well on all three.
+We are also not looking for exercises or other material that only run on one
+platform. Our workshops typically contain a mixture of Windows, macOS, and
+Linux users; in order to be usable, our lessons must run equally well on all
+three.
 
 ## Using GitHub
 
-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]. To manage changes, we
-follow [GitHub flow][github-flow]. Each lesson has two maintainers who review issues and pull
-requests or encourage others to do so. The maintainers are community volunteers and have final say
-over what gets merged into the lesson. To use the web interface for contributing to a lesson:
-
-1.  Fork the originating repository to your GitHub profile.
-2.  Within your version of the forked repository, move to the `gh-pages` branch and create a new
-    branch for each significant change being made.
-3.  Navigate to the file(s) you wish to change within the new branches and make revisions as
-    required.
-4.  Commit all changed files within the appropriate branches.
-5.  Create individual pull requests from each of your changed branches
-to the `gh-pages` branch within the originating repository.
-6.  If you receive feedback, make changes using your issue-specific branches of the forked
-    repository and the pull requests will update automatically.
-7.  Repeat as needed until all feedback has been addressed.
-
-When starting work, please make sure your clone of the originating `gh-pages` branch is up-to-date
-before creating your own revision-specific branch(es) from there. Additionally, please only work
-from your newly-created branch(es) and *not* your clone of the originating `gh-pages` branch.
-Lastly, published copies of all the lessons are available in the `gh-pages` branch of the
-originating repository for reference while revising.
+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]. To manage
+changes, we follow [GitHub flow][github-flow]. Each lesson has two maintainers
+who review issues and pull requests or encourage others to do so. The
+maintainers are community volunteers and have final say over what gets merged
+into the lesson. To use the web interface for contributing to a lesson:
+
+1. Fork the originating repository to your GitHub profile.
+1. Within your version of the forked repository, move to the `gh-pages` branch
+   and create a new branch for each significant change being made.
+1. Navigate to the file(s) you wish to change within the new branches and make
+   revisions as required.
+1. Commit all changed files within the appropriate branches.
+1. Create individual pull requests from each of your changed branches to the
+   `gh-pages` branch within the originating repository.
+1. If you receive feedback, make changes using your issue-specific branches of
+   the forked repository and the pull requests will update automatically.
+1. Repeat as needed until all feedback has been addressed.
+
+When starting work, please make sure your clone of the originating `gh-pages`
+branch is up-to-date before creating your own revision-specific branch(es) from
+there. Additionally, please only work from your newly-created branch(es) and
+*not* your clone of the originating `gh-pages` branch. Lastly, published copies
+of all the lessons are available in the `gh-pages` branch of the originating
+repository for reference while revising.
 
 ## Other Resources
 
-General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-site] happens on the
-[discussion mailing list][discuss-list], which everyone is welcome to join. You can also
-[reach us by email][email].
+General discussion of [Software Carpentry][swc-site] and [Data
+Carpentry][dc-site] happens on the [discussion mailing list][discuss-list],
+which everyone is welcome to join. You can also [reach us by email][email].
 
 [email]: mailto:admin@software-carpentry.org
 [dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
@@ -116,3 +130,4 @@ General discussion of [Software Carpentry][swc-site] and [Data Carpentry][dc-sit
 [swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
 [swc-lessons]: https://software-carpentry.org/lessons/
 [swc-site]: https://software-carpentry.org/
+

Gemfile

@@ -1,3 +1,4 @@
 source "https://rubygems.org"
 gem "github-pages", group: :jekyll_plugins
 gem "kramdown-parser-gfm"
+gem "mdl"

LICENSE.md

@@ -1,6 +1,9 @@
 ---
 title: "Licenses"
 ---
+
+# CC BY 4.0
+
 ## Instructional Material
 
 All High Performance Computing Carpentry instructional material is
@@ -24,7 +27,7 @@ Under the following terms:
 * **Attribution**---You must give appropriate credit (mentioning that
   your work is derived from work that is Copyright © Software
   Carpentry and, where practical, linking to
-  http://software-carpentry.org/), provide a [link to the
+  <http://software-carpentry.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.

MAINTENANCE.md

@@ -34,40 +34,37 @@ There is also a [repo][mainsite-repo] for the main website covering
 all HPC-Carpentry activities. This is intended to be the "front door"
 of the HPC Carpentry community.
 
-### Slack:
+### Slack
 
 The main Carpentries Slack channel is reachable at
 [swcarpentry.slack.com][swc-slack]. To become a member, you can
 trigger in invitation from [here][slack-invite].
 
 You can go directly to the HPC Carpentry sub-channel at
-[#hpc-carpentry][hpc-slack]. These are the things to bookmark — once
-you go there, the Slack engine redirects you to particular views, so
-cutting/pasting URLs out of the browser's location bar is likely to be
-disappointing.
+[#hpc-carpentry][hpc-slack]. These are the things to bookmark —
+once you go there, the Slack engine redirects you to particular views,
+so copying and pasting URLs out of the browser's location bar is
+likely to be disappointing.
 
 Members of existing swcarpentry Slack channels can find the channel by
 typing "hpc-carpentry" into the Slack search box.
 
-
-### E-mail:
+### E-mail
 
 The top-level site is on The Carpentries' [Topicbox][topicbox]. There
 are two HPC-specific lists, "discuss-hpc" and "maintainers-hpc". These
 mailing lists are public: you may join any that catch your interest.
 The system does not use passwords; log-ins are via a verification code
 sent to your e-mail.
 
-
 ## Site Operation
 
-### DOIs for Releases 
+### DOIs for Releases
 
 There is a web-hook that calls out to [Zenodo][zenodo] to create a
 Digital Object Identifier (DOI) whenever a release is generated on the
 GitHub repo. The Zenodo account is owned by Peter Steinbach (@psteinb).
 
-
 ### Continuous Integration
 
 The high-level lesson structure is described reasonably well in the