Skip to content

Commit

Permalink
fix https and anchor links in non-episode files
Browse files Browse the repository at this point in the history
During my processing of this lesson, I had not enabled link validation
of the auxilary markdown files (that is, non-episode files), so a lot of
them had https links and sneaky ways of creating anchor links that were
not accessible
(see
#1497 (comment))

As of the update to {pegboard} 0.5.0, these external files are now
processed.
  • Loading branch information
zkamvar committed Mar 31, 2023
1 parent 6499cb2 commit 9b7be0c
Show file tree
Hide file tree
Showing 7 changed files with 173 additions and 166 deletions.
116 changes: 59 additions & 57 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,43 +26,43 @@ 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).
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).

## Where to Contribute

1. If you wish to change this lesson,
please work in <https://github.com/swcarpentry/shell-novice>,
which can be viewed at <https://swcarpentry.github.io/shell-novice>.
1. If you wish to change this lesson,
please work in [https://github.com/swcarpentry/shell-novice](https://github.com/swcarpentry/shell-novice),
which can be viewed at [https://swcarpentry.github.io/shell-novice](https://swcarpentry.github.io/shell-novice).

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>.
2. If you wish to change the example lesson,
please work in [https://github.com/carpentries/lesson-example](https://github.com/carpentries/lesson-example),
which documents the format of our lessons
and can be viewed at [https://carpentries.github.io/lesson-example](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.
3. If you wish to change the template used for workshop websites,
please work in [https://github.com/carpentries/workshop-template](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](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>.
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](https://github.com/carpentries/styles).

## What to Contribute

Expand Down Expand Up @@ -106,22 +106,23 @@ 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.
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.
Expand All @@ -135,17 +136,18 @@ happens on the [discussion mailing list][discuss-list],
which everyone is welcome to join.
You can also [reach us by email][contact].

[swc-site]: https://software-carpentry.org/
[dc-site]: https://datacarpentry.org/
[github]: https://github.com
[contact]: 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-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/shell-novice/issues/
[repo]: https://github.com/swcarpentry/shell-novice/
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
[swc-lessons]: http://software-carpentry.org/lessons/
[swc-site]: http://software-carpentry.org/
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
[repo]: https://github.com/swcarpentry/shell-novice/
[github-flow]: https://guides.github.com/introduction/flow/
[discuss-list]: https://lists.software-carpentry.org/listinfo/discuss



19 changes: 11 additions & 8 deletions LICENSE.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -22,10 +22,10 @@ license terms.

Under the following terms:

* **Attribution**---You must give appropriate credit (mentioning that
- **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/](https://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.
Expand All @@ -36,10 +36,10 @@ anything the license permits. With the understanding that:

Notices:

* You do not have to comply with the license for elements of the
- 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
- 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.
Expand Down Expand Up @@ -77,6 +77,9 @@ are registered trademarks of [Community Initiatives][ci].

[cc-by-human]: https://creativecommons.org/licenses/by/4.0/
[cc-by-legal]: https://creativecommons.org/licenses/by/4.0/legalcode
[mit-license]: https://opensource.org/licenses/mit-license.html
[ci]: http://communityin.org/
[osi]: https://opensource.org
[mit-license]: https://opensource.org/licenses/mit-license.html
[ci]: https://communityin.org/



4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@ or run `make` in this directory for a list of helpful commands.
- [Jon Wheeler][wheeler_jon]: @jonathanwheeler01
- [Karen Word][word_karen]: @karenword

[swc-site]: http://software-carpentry.org
[dc-site]: http://datacarpentry.org
[swc-site]: https://software-carpentry.org
[dc-site]: https://datacarpentry.org
[lc-site]: https://librarycarpentry.org
[lesson-example]: https://carpentries.github.io/lesson-example
[brown_sarah]: https://carpentries.org/instructors/#brownsarahm
Expand Down
2 changes: 1 addition & 1 deletion index.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ The Carpentries website for details on admission.
Instructor Training events are hands-on throughout: short lessons alternate with individual
and group practical exercises, including practice teaching sessions. Those who attend the
full training and all three checkout steps will be certified as a Carpentries Instructor
and will be eligible to teach [Data Carpentry](http://datacarpentry.org/), [Library Carpentry](https://librarycarpentry.org/),
and will be eligible to teach [Data Carpentry](https://datacarpentry.org/), [Library Carpentry](https://librarycarpentry.org/),
and [Software Carpentry](https://software-carpentry.org/) workshops throughout our global community.

- All participants are required to abide by our [Code of Conduct][conduct].
Expand Down
6 changes: 3 additions & 3 deletions instructors/instructor-notes.md
Original file line number Diff line number Diff line change
Expand Up @@ -346,13 +346,13 @@ Suggested points to make during wrap-up:

[handbook]: https://docs.carpentries.org/topic_folders/instructor_training/index.html#for-trainers
[demos]: https://docs.carpentries.org/topic_folders/instructor_training/trainers_guide.html#running-a-teaching-demonstration
[etherpad-template]: http://pad.software-carpentry.org/ttt-template
[etherpad-template]: https://pad.software-carpentry.org/ttt-template
[training-template]: https://github.com/carpentries/training-template
[minute-cards-template]: https://docs.google.com/forms/d/1p7iOV5HNvy4POS4g6eottY8RSfKq4kaoKz1-jIFYTMI/template/preview
[checkout-checklist]: http://www.datacarpentry.org/checkout/
[checkout-checklist]: https://www.datacarpentry.org/checkout/
[post-template]: https://docs.carpentries.org/topic_folders/instructor_training/email_templates_trainers.html#email-after-training-event
[trainer-pad]: https://pad.carpentries.org/trainers
[training-repo]: http://carpentries.github.io/instructor-training/
[training-repo]: https://carpentries.github.io/instructor-training/
[great-slide-issue]: https://github.com/carpentries/instructor-training/issues/680
[slides-folder]: https://drive.google.com/drive/folders/10ncHtw4ZtNZD0ozW0rG5C-Q4yFetRY1t
[zoom-home]: https://www.zoom.us/
Expand Down
Loading

0 comments on commit 9b7be0c

Please sign in to comment.