From 8404c00538580d44bbfc868d52b5c7f6923fe5a5 Mon Sep 17 00:00:00 2001 From: "William L. Close" Date: Tue, 7 Nov 2017 16:31:26 -0500 Subject: [PATCH 1/9] Updated lesson_initialize Clarified instructions for using GitHub to contribute, altered link for [issues] to direct to GitHub page on navigating issues to avoid FIXME issue with link when initializing, removed link to master repo to avoid FIXME issue with link when initializing. These suggestions were based on a pull request initially done elsewhere swcarpentry/shell-novice#639 --- bin/lesson_initialize.py | 61 ++++++++++++++++++---------------------- 1 file changed, 28 insertions(+), 33 deletions(-) diff --git a/bin/lesson_initialize.py b/bin/lesson_initialize.py index 3ee1ace6..30881d07 100755 --- a/bin/lesson_initialize.py +++ b/bin/lesson_initialize.py @@ -45,7 +45,7 @@ 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]. + 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. @@ -89,9 +89,9 @@ 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] +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: @@ -119,41 +119,37 @@ ## Using GitHub -If you choose to contribute via GitHub, -you may want to look at +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. +A published copy of the lesson is available in the `gh-pages` branch of the master repository. +Before starting work, please make sure your clone of the master `gh-pages` branch is up-to-date +and create your own revision-specific branch(es) from there. +Please only work on your newly-created branch(es) and *not* +your clone of the master `gh-pages` branch. +To manage changes, we follow [GitHub flow][github-flow]. In brief: + +1. Fork the repository to your GitHub profile and create a clone on your desktop. +2. Create a new branch in your desktop copy of this repository for each significant +change being made. +3. Make revisions as required. +4. Stage all changed files and commit them within the appropriate branch. +5. Push any new branches to your forked copy of this repository on GitHub. +6. Submit a pull request from that branch to the master repository. +7. If you receive feedback, make changes using your desktop copy of the repository and +push to your branch on GitHub. The pull request will update automatically. +8. Repeat as needed. + +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. ## 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]. +You can also [reach us by email][contact]. -[email]: mailto:admin@software-carpentry.org +[contact]: mailto:admin@software-carpentry.org [dc-issues]: https://github.com/issues?q=user%3Adatacarpentry [dc-lessons]: http://datacarpentry.org/lessons/ [dc-site]: http://datacarpentry.org/ @@ -162,8 +158,7 @@ [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/ From 55b723add97606b7616549cb443d6366ffc40a8e Mon Sep 17 00:00:00 2001 From: "William L. Close" Date: Wed, 6 Dec 2017 21:20:27 -0500 Subject: [PATCH 2/9] Made requested revisions to lesson_initialize Changed the keyword for emailing from 'contact' to 'email' per https://github.com/swcarpentry/styles/issues/178 and changed the description for how to use GitHub to reflect usage of the web interface. --- bin/lesson_initialize.py | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/bin/lesson_initialize.py b/bin/lesson_initialize.py index 30881d07..5ec918ea 100755 --- a/bin/lesson_initialize.py +++ b/bin/lesson_initialize.py @@ -45,7 +45,7 @@ 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]. + 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. @@ -126,18 +126,18 @@ and create your own revision-specific branch(es) from there. Please only work on your newly-created branch(es) and *not* your clone of the master `gh-pages` branch. -To manage changes, we follow [GitHub flow][github-flow]. In brief: - -1. Fork the repository to your GitHub profile and create a clone on your desktop. -2. Create a new branch in your desktop copy of this repository for each significant -change being made. -3. Make revisions as required. -4. Stage all changed files and commit them within the appropriate branch. -5. Push any new branches to your forked copy of this repository on GitHub. -6. Submit a pull request from that branch to the master repository. -7. If you receive feedback, make changes using your desktop copy of the repository and -push to your branch on GitHub. The pull request will update automatically. -8. Repeat as needed. +To manage changes, we follow [GitHub flow][github-flow]. Using the web interface: + +1. Fork the master 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 master 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. 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. @@ -147,9 +147,9 @@ 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]. +You can also [reach us by email][email]. -[contact]: mailto:admin@software-carpentry.org +[email]: mailto:admin@software-carpentry.org [dc-issues]: https://github.com/issues?q=user%3Adatacarpentry [dc-lessons]: http://datacarpentry.org/lessons/ [dc-site]: http://datacarpentry.org/ From af2df7aafe1cfed8c6064bd8fda1be3edea62304 Mon Sep 17 00:00:00 2001 From: "William L. Close" Date: Wed, 6 Dec 2017 21:31:30 -0500 Subject: [PATCH 3/9] Made minor revision to order of information Reorganized description of process for contributing to clarify/increase readability --- bin/lesson_initialize.py | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/bin/lesson_initialize.py b/bin/lesson_initialize.py index 5ec918ea..3f713c96 100755 --- a/bin/lesson_initialize.py +++ b/bin/lesson_initialize.py @@ -121,12 +121,10 @@ 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]. -A published copy of the lesson is available in the `gh-pages` branch of the master repository. -Before starting work, please make sure your clone of the master `gh-pages` branch is up-to-date -and create your own revision-specific branch(es) from there. -Please only work on your newly-created branch(es) and *not* -your clone of the master `gh-pages` branch. -To manage changes, we follow [GitHub flow][github-flow]. Using the web interface: +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 master repository to your GitHub profile. 2. Within your version of the forked repository, move to the `gh-pages` branch and @@ -139,8 +137,12 @@ repository and the pull requests will update automatically. 7. Repeat as needed until all feedback has been addressed. -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. +When starting work, please make sure your clone of the master `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 master `gh-pages` branch. +Lastly, published copies of all the lessons are available in the `gh-pages` branch of the master +repository for reference while revising. ## Other Resources From 6a3a8071f7cbc137e86bb53706cc057fe610a6fb Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Mon, 29 Jan 2018 11:29:15 +0000 Subject: [PATCH 4/9] Fix CSS to use .language-X class --- assets/css/lesson.scss | 18 ++++++++++++------ 1 file changed, 12 insertions(+), 6 deletions(-) diff --git a/assets/css/lesson.scss b/assets/css/lesson.scss index abbaecb7..2317cb9c 100644 --- a/assets/css/lesson.scss +++ b/assets/css/lesson.scss @@ -39,22 +39,28 @@ $color-testimonial: #fc8dc1 !default; .output { @include cdSetup($color-output); } .source { @include cdSetup($color-source); } -.bash { @include cdSetup($color-source); } -.make { @include cdSetup($color-source); } -.matlab { @include cdSetup($color-source); } -.python { @include cdSetup($color-source); } -.r { @include cdSetup($color-source); } -.sql { @include cdSetup($color-source); } +.bash, .language-bash { @include cdSetup($color-source); } +.make, .language-make { @include cdSetup($color-source); } +.matlab, .language-matlab { @include cdSetup($color-source); } +.python, .language-python { @include cdSetup($color-source); } +.r, .language-r { @include cdSetup($color-source); } +.sql, .langauge-sql { @include cdSetup($color-source); } .error pre, .output pre, .source pre, .bash pre, +.language-bash pre, .make pre, +.language-make pre, .matlab pre, +.language-matlab pre, .python pre, +.language-python pre, .r pre, +.language-r pre, .sql pre { +.language-sql pre { border-radius: 0 4px 4px 0; } From b9a00c86e1640565de1c1dc249a2e11a69a923b9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Fran=C3=A7ois=20Michonneau?= Date: Mon, 12 Feb 2018 15:52:11 -0500 Subject: [PATCH 5/9] fix svg files --- assets/img/swc-icon-blue.svg | 5 +- assets/img/swc-logo-blue.svg | 364 +++++++++++----------------------- assets/img/swc-logo-white.svg | 364 +++++++++++----------------------- 3 files changed, 228 insertions(+), 505 deletions(-) diff --git a/assets/img/swc-icon-blue.svg b/assets/img/swc-icon-blue.svg index d2ebb553..c60af9c8 100644 --- a/assets/img/swc-icon-blue.svg +++ b/assets/img/swc-icon-blue.svg @@ -1,6 +1,5 @@ - - + @@ -68,4 +67,4 @@ - \ No newline at end of file + diff --git a/assets/img/swc-logo-blue.svg b/assets/img/swc-logo-blue.svg index 00c1b076..4a0fa227 100644 --- a/assets/img/swc-logo-blue.svg +++ b/assets/img/swc-logo-blue.svg @@ -1,252 +1,114 @@ -image/svg+xml \ No newline at end of file + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + diff --git a/assets/img/swc-logo-white.svg b/assets/img/swc-logo-white.svg index 473f9978..1a7f7ad0 100644 --- a/assets/img/swc-logo-white.svg +++ b/assets/img/swc-logo-white.svg @@ -1,252 +1,114 @@ -image/svg+xml \ No newline at end of file + + + + + image/svg+xml + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + From accf26a0c7a258e08057846778979b13e2d3220a Mon Sep 17 00:00:00 2001 From: jcoliver Date: Wed, 10 Jan 2018 11:15:19 -0700 Subject: [PATCH 6/9] Add current year to copyright of workshop footer --- _includes/workshop_footer.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/workshop_footer.html b/_includes/workshop_footer.html index 897e421d..bc44f286 100644 --- a/_includes/workshop_footer.html +++ b/_includes/workshop_footer.html @@ -5,7 +5,7 @@

- Copyright © 2016 + Copyright © 2016–{{ 'now' | date: "%Y" }} {% if site.carpentry == "swc" %} Software Carpentry Foundation {% elsif site.carpentry == "dc" %} From a1707b0c1746ea1264af877c60e92cc2e88e8869 Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Thu, 15 Feb 2018 10:49:12 +0000 Subject: [PATCH 7/9] Fix broken link for Contact --- _includes/lesson_footer.html | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/_includes/lesson_footer.html b/_includes/lesson_footer.html index f36bc09c..e88210ef 100644 --- a/_includes/lesson_footer.html +++ b/_includes/lesson_footer.html @@ -31,7 +31,7 @@

/ Cite / - Contact + Contact

From d1281913efdd2822675ce7afee5ee7de93c82416 Mon Sep 17 00:00:00 2001 From: Andrew Sanchez Date: Thu, 15 Feb 2018 13:51:04 -0700 Subject: [PATCH 8/9] Requested changes --- _includes/links.md | 1 + 1 file changed, 1 insertion(+) diff --git a/_includes/links.md b/_includes/links.md index 2dfecd6d..273d63ea 100644 --- a/_includes/links.md +++ b/_includes/links.md @@ -33,3 +33,4 @@ [yaml]: http://yaml.org/ [coc]: https://software-carpentry.org/conduct/ [coc-reporting]: https://software-carpentry.org/CoC-reporting/ +[lesson-example]: https://swcarpentry.github.io/lesson-example/ From 34b0d399d6318028ca0496d06f2fa792d24837e5 Mon Sep 17 00:00:00 2001 From: Raniere Silva Date: Mon, 19 Feb 2018 16:10:30 +0000 Subject: [PATCH 9/9] Fix issue with CSS --- assets/css/lesson.scss | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/assets/css/lesson.scss b/assets/css/lesson.scss index 2317cb9c..d2a2f29f 100644 --- a/assets/css/lesson.scss +++ b/assets/css/lesson.scss @@ -59,7 +59,7 @@ $color-testimonial: #fc8dc1 !default; .language-python pre, .r pre, .language-r pre, -.sql pre { +.sql pre , .language-sql pre { border-radius: 0 4px 4px 0; }