Merge pull request #13 from tkphd/remote-carpentries-theme

Lean on remote carpentries-theme

Author: tkphd

.gitignore

@@ -2,6 +2,14 @@
 *~
 .DS_Store
 .ipynb_checkpoints
+.jekyll-cache
 .sass-cache
 __pycache__
 _site
+files/*.gtf
+files/*.fb
+files/*.fastq
+files/*.tsv
+Gemfile.lock
+scratch/
+.vendor

.travis.yml

@@ -0,0 +1,37 @@
+# Travis-CI config for https://github.com/hpc-carpentry/hpc-chapel
+# Results at https://travis-ci.org/github/hpc-carpentry/hpc-chapel
+
+dist: xenial
+language: python
+python: 3.7
+
+branches:
+  only:
+  - gh-pages
+  - /.*/
+
+before_install:
+install:
+script:
+
+jobs:
+  include:
+    - stage: "Check for typos and spelling mistakes"
+      before_install: # Don't need everything to build the site
+      install:
+        pip install codespell
+      script:
+        codespell --skip="assets,*.svg,bin" --quiet-level=2  -L "rouge,dropse,namd,hist"
+    - stage: "Build the site"
+      before_install: 
+        - sudo apt-get update -y
+        - rvm default
+        - gem install bundler jekyll json kramdown
+        - bundle config build.nokogiri --use-system-libraries
+        - bundle install
+      install:
+        pip install pyyaml
+      script:
+        - make lesson-check-all
+        - make --always-make site
+

CODE_OF_CONDUCT.md

@@ -0,0 +1,11 @@
+---
+layout: page
+title: "Contributor Code of Conduct"
+---
+As contributors and maintainers of this project,
+we pledge to follow the [Carpentry Code of Conduct][coc].
+
+Instances of abusive, harassing, or otherwise unacceptable behavior
+may be reported by following our [reporting guidelines][coc-reporting].
+
+{% include links.md %}

CONDUCT.md

@@ -1,163 +1,118 @@
-# Contributing - HPC Carpentry
+# Contributing
 
-**This lesson is currently under active development by the HPC Carpentry team.**
+[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.
 
-Although this is intended to be an open lesson that follows the general 
-Software and Data Carpentry contribution guidelines,
-we are currently focusing on delivering our initial lesson pass.
-
-Although we appreciate external input, 
-contributions and input from the wider community will be reviewed only once initial lesson generation is complete.
-(We want this lesson as much as you do!)
+## Contributor Agreement
 
-## General contribution guidelines
+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).
 
-[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.
+## How to Contribute
 
-## Contributor Agreement
+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.
 
-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](CONDUCT.md).
+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.
 
-## How to Contribute
+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.
 
-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][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][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).
+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).
 
 ## 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/swcarpentry/FIXME>, which
+    can be viewed at <https://swcarpentry.github.io/FIXME>.
 
-2.  If you wish to change the example lesson,
-    please work in <https://github.com/swcarpentry/lesson-example>,
-    which documents the format of our lessons
-    and can be viewed at <https://swcarpentry.github.io/lesson-example>.
+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>.
 
-3.  If you wish to change the template used for workshop websites,
-    please work in <https://github.com/swcarpentry/workshop-template>.
-    The home page of that repository explains how to set up workshop websites,
-    while the extra pages in <https://swcarpentry.github.io/workshop-template>
-    provide more background on our design choices.
+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.
 
-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/swcarpentry/styles>.
+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>.
 
 ## 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 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 list of issues for this repository][issues],
-or 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.
+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.
 
 ## 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, Mac OS X, 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].
-In brief:
-
-1.  The published copy of the lesson is in the `gh-pages` branch of the repository
-    (so that GitHub will regenerate it automatically).
-    Please create all branches from that,
-    and merge the [master repository][repo]'s `gh-pages` branch into your `gh-pages` branch
-    before starting work.
-    Please do *not* work directly in your `gh-pages` branch,
-    since that will make it difficult for you to work on other contributions.
-
-2.  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.
-    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 [master 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.
-
-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.
+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.
 
 ## 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][contact].
+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].
 
-[contact]: mailto:[email protected]
+[email]: mailto:[email protected]
 [dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
 [dc-lessons]: http://datacarpentry.org/lessons/
 [dc-site]: http://datacarpentry.org/
 [discuss-list]: http://lists.software-carpentry.org/listinfo/discuss
-[github]: http://github.com
+[github]: https://github.com
 [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/swcarpentry/FIXME/issues/
-[repo]: https://github.com/swcarpentry/FIXME/
+[issues]: https://guides.github.com/features/issues/
 [swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
-[swc-lessons]: http://software-carpentry.org/lessons/
-[swc-site]: http://software-carpentry.org/
+[swc-lessons]: https://software-carpentry.org/lessons/
+[swc-site]: https://software-carpentry.org/

CONTRIBUTING.md

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gem "github-pages", group: :jekyll_plugins