Skip to content

Commit 33b3f19

Browse files
tkphdtkphd
authored
Merge pull request #93 from hpc-carpentry/email-address-fixes
Fixed to the e-mail addresses.
2 parents 967908b + 7bb97d1 commit 33b3f19

11 files changed

+145
-121
lines changed

Diff for: ‎CONTRIBUTING.md

+130-110
Original file line numberDiff line numberDiff line change
@@ -1,133 +1,153 @@
11
# Contributing
22

3-
Like the official [Carpentries][c-site] sites [Software Carpentry][swc-site], [Data Carpentry][dc-site],
4-
and [Library Carpentry][lc-site]; [HPC Carpentry][hpcc-site] is an open source project,
5-
and we welcome contributions of all kinds:
6-
blog posts,
7-
fixes to existing material,
8-
bug reports,
9-
and reviews of proposed changes are all welcome.
3+
Like the official [Carpentries][c-site] sites---[Software
4+
Carpentry][swc-site], [Data Carpentry][dc-site], and
5+
[Library Carpentry][lc-site]---[HPC Carpentry][hpcc-site]
6+
is an open source project, and we welcome
7+
contributions of all kinds: blog posts, fixes to existing material,
8+
bug reports, and reviews of proposed changes are all welcome.
109

1110
## Contributor Agreement
1211

13-
By contributing,
14-
you agree that we may redistribute your work under [our license](LICENSE.md).
15-
Everyone involved in i[HPC Carpentry][hpcc-site]
16-
agrees to abide by our [code of conduct][conduct].
17-
12+
By contributing, you agree that we may redistribute your work under
13+
[our license](LICENSE). Everyone involved in
14+
[HPC Carpentry][hpcc-site] agrees to abide by our
15+
[code of conduct][conduct].
1816

1917
## How to Contribute a Fix or Suggested Change
2018

21-
The easiest way to get started is to file an issue
22-
to tell us about a spelling mistake,
23-
some awkward wording,
24-
or a factual error.
25-
This is a good way to introduce yourself
26-
and to meet some of our community members.
27-
28-
1. If you do not have a [GitHub][github] account,
29-
you can [send us comments by email][contact].
30-
However,
31-
we will be able to respond more quickly if you use one of the other methods described below.
32-
33-
2. If you have a [GitHub][github] account,
34-
or are willing to [create one][github-join],
35-
but do not know how to use Git,
36-
you can report problems or suggest improvements by [creating an issue][issues].
37-
This allows us to assign the item to someone
38-
and to respond to it in a threaded discussion.
39-
40-
3. If you are comfortable with Git,
41-
and would like to add or change material,
42-
you can submit a pull request (PR).
19+
The easiest way to get started is to file an issue to tell us about a
20+
spelling mistake, some awkward wording, or a factual error. This is
21+
a good way to introduce yourself and to meet some of our community
22+
members.
23+
24+
1. If you do not have a [GitHub][github] account, you can send
25+
comments to the [community email list][discuss-list].
26+
However, we will be able to respond more quickly if you use one of
27+
the other methods described below.
28+
29+
2. If you have a [GitHub][github] account, or are willing to
30+
[create one][github-join], but do not know how to use Git,
31+
you can report problems or suggest improvements by
32+
[creating an issue][issues].
33+
This allows us to assign the item to someone and to respond
34+
to it in a threaded discussion.
35+
36+
3. If you are comfortable with Git, and would like to add or change
37+
material, you can submit a pull request (PR).
4338

4439
## Where to Contribute
4540

46-
1. If you wish to change the website,
47-
please work in <https://github.com/hpc-carpentry/hpc-carpentry.github.io>,
48-
which can be viewed at <https://hpc-carpentry.org>.
41+
1. If you wish to change the website, please work in
42+
<https://github.com/hpc-carpentry/hpc-carpentry.github.io>,
43+
which can be viewed at <https://hpc-carpentry.org>.
4944

50-
2. If you wish to change CSS style files, tools,
51-
or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`,
52-
please work in <https://github.com/carpentries/carpentries.org> (on which
53-
this website is based).
45+
2. If you wish to change CSS style files, tools, or HTML boilerplate
46+
for lessons or workshops stored in `_includes` or `_layouts`,
47+
please work in <https://github.com/carpentries/carpentries.org>
48+
(on which this website is based).
5449

5550
## How to Contribute a Blog Post
5651

57-
1. If you wish to contribute a blog post,
58-
please work in <https://github.com/hpc-carpentry/hpc-carpentry.github.io>,
59-
which can be viewed at <https://hpc-carpentry.org>.
60-
61-
2. Posts go in the `_posts` folder, which is divided up first by year,
62-
e.g. `2018`, and then by month, e.g. `04`. Be sure to start creating your file in
63-
the correct folder.
64-
65-
3. Posts need to be created in [Markdown](https://guides.github.com/features/mastering-markdown/) and named
66-
according to this convention (all-lower-case filenames are preferred):
67-
68-
`YYYY-MM-DD-filename.md`
69-
70-
e.g.
71-
72-
`2017-07-10-assess_report.md`
73-
74-
4. In order to render correctly, posts need to have a [header block, which should be created like this example](https://raw.githubusercontent.com/carpentries/carpentries.org/main/_posts/2018/04/2018-04-11-launch-handbook.md), e.g.
75-
76-
```
77-
---
78-
layout: page
79-
authors: ["Tracy Teal", "Maneesha Sane", "Belinda Weaver"]
80-
title: "Launching our New Handbook"
81-
teaser: "Find new pathways to a range of Carpentries material"
82-
date: 2018-04-11
83-
time: "9:00:00"
84-
tags: ["Communications"]
85-
---
86-
```
87-
88-
Separate the header block from the post proper by a new line.
89-
90-
5. `Time`, but the other fields should be filled in. If there is more than one author,
91-
separate the author names like this: `["Name 1", "Name 2"]`. Separate any tags the same way.
92-
93-
6. Images should be uploaded to the appropriate year in the `files/<year>/<month>` folder. Images should be linked using
94-
Markdown, and paths to the image should be relative.
95-
Example:
96-
```
97-
![Image Description]({{ site.filesurl }}/2017/07/myimage.jpg)
98-
```
99-
A web link should be used for images hosted elsewhere.
100-
Example:
101-
```
102-
![Image Description](https://web_address/pathway_to_full_image_filename)
103-
```
104-
105-
If you are not sure how to add images in Markdown format, look at an [existing Software Carpentry post with a locally hosted image](https://raw.githubusercontent.com/swcarpentry/website/main/_posts/2017/06/2017-06-19-mqu-ttt.md) or [one with a web link](https://raw.githubusercontent.com/swcarpentry/website/main/_posts/2017/07/2017-07-10-assess_report.md) and copy the formatting from there.
106-
107-
7. Once you have previewed your file, commit the Markdown file to your fork and start a Pull Request. We automatically run tests using [GitHub Actions](https://github.com/features/actions) on your Pull Requests. Please review your pull request a few minutes after you've submitted it to make sure those tests have passed. These tests look for valid YAML headers and make sure that the post will build properly.
52+
1. If you wish to contribute a blog post, please work in
53+
<https://github.com/hpc-carpentry/hpc-carpentry.github.io>,
54+
which can be viewed at <https://hpc-carpentry.org>.
55+
56+
2. Posts go in the `_posts` folder, which is divided up first by
57+
year, e.g. `2018`, and then by month, e.g. `04`. Be sure to start
58+
creating your file in the correct folder.
59+
60+
3. Posts need to be created in [Markdown][md-guide] and named
61+
according to this convention (all-lower-case filenames are
62+
preferred):
63+
64+
`YYYY-MM-DD-filename.md`
65+
66+
e.g.,
67+
68+
`2017-07-10-assess_report.md`
69+
70+
4. In order to render correctly, posts need to have a header block,
71+
which should be [created like this example][hdr-block]:
72+
73+
```yaml
74+
---
75+
layout: page
76+
authors: ["Tracy Teal", "Maneesha Sane", "Belinda Weaver"]
77+
title: "Launching our New Handbook"
78+
teaser: "Find new pathways to a range of Carpentries material"
79+
date: 2018-04-11
80+
time: "9:00:00"
81+
tags: ["Communications"]
82+
---
83+
```
84+
85+
Separate the header block from the post proper by a new line.
86+
You can leave the `time` field as-is or set it to a meaningful
87+
value. Please make your best effort to accurately populate the
88+
rest of the fields.
89+
90+
5. If there is more than one author, separate the quoted author
91+
names using commas, like this:
92+
93+
```yaml
94+
["Name 1", "Name 2"]
95+
```
96+
97+
Separate any tags the same way.
98+
99+
6. Images should be uploaded to the appropriate year in the
100+
`files/<year>/<month>` folder. Images should be linked using
101+
Markdown, and paths to the image should be relative. Example:
102+
103+
```markdown
104+
![Image Description]({{ site.filesurl }}/2017/07/myimage.jpg "alt text")
105+
```
106+
107+
A web link should be used for images hosted elsewhere.
108+
Example:
109+
110+
```markdown
111+
![Image Description](https://web_address/pathway_to_full_image_filename)
112+
```
113+
114+
If you are not sure how to add images in Markdown format,
115+
look at an existing Carpentries post with a
116+
[locally hosted image][md-img-local] or
117+
[one with a web link][md-img-remote] and copy the formatting
118+
from there.
119+
120+
7. Once you have previewed your file, commit the Markdown file to
121+
your fork and start a Pull Request. We automatically run tests
122+
using [GitHub Actions][actions] on your Pull Requests. Please
123+
review your pull request a few minutes after you've submitted it
124+
to make sure those tests have passed. These tests look for valid
125+
YAML headers and make sure that the post will build properly.
108126

109127
## Other Resources
110128

111-
General discussion of [HPC Carpentry][hpcc-site]
112-
happens on the [discussion mailing list][discuss-list],
113-
which everyone is welcome to join.
114-
You can also [reach us by email][contact].
129+
General discussion of [HPC Carpentry][hpcc-site] happens on the
130+
[discussion mailing list][discuss-list], which everyone is welcome
131+
to join. You can also [reach the maintainers by email][contact].
115132

116-
[contact]: mailto:[email protected]
133+
<!-- HPCC links -->
134+
135+
[actions]: https://github.com/hpc-carpentry/hpc-carpentry.github.io/actions
117136
[conduct]: https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html
118-
[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry
119-
[dc-lessons]: https://datacarpentry.org/lessons/
120-
[dc-site]: https://datacarpentry.org/
137+
[contact]: mailto:[email protected]
121138
[discuss-list]: https://carpentries.topicbox.com/groups/discuss-hpc
122-
[github]: http://github.com
123-
[github-flow]: https://guides.github.com/introduction/flow/
124-
[github-join]: https://github.com/join
125-
[how-contribute]: https://egghead.io/series/how-to-contribute-to-an-open-source-project-on-github
126139
[issues]: https://github.com/hpc-carpentry/hpc-carpentry.github.io/issues/
127-
[repo]: https://github.com/hpc-carpentry/hpc-carpentry.github.io
128-
[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry
129-
[swc-lessons]: http://software-carpentry.org/lessons/
130-
[swc-site]: http://software-carpentry.org/
131-
[lc-issues]: https://github.com/issues?q=user%3Adatacarpentry
132-
[lc-lessons]: https://librarycarpentry.org/lessons/
140+
[hpcc-site]: https://www.hpc-carpentry.org
141+
142+
<!-- Outside links -->
143+
144+
[c-site]: https://carpentries.org
145+
[dc-site]: https://datacarpentry.org/
146+
[github-join]: https://github.com/join
147+
[github]: http://github.com
148+
[hdr-block]: https://github.com/hpc-carpentry/hpc-carpentry.github.io/blob/967908bd97f2e30f34185ad98d575a9125754b01/_posts/2024/08/2024-08-13-llnl-workshop-blog-post.md?plain=1#L1
133149
[lc-site]: https://librarycarpentry.org/
150+
[md-guide]: https://guides.github.com/features/mastering-markdown/
151+
[md-img-local]: https://github.com/carpentries/carpentries.org/blob/5524366743246303aa1dd80343dd4759685b44e9/_posts/2017/06/2017-06-19-mqu-ttt.md?plain=1#L29
152+
[md-img-remote]: https://github.com/carpentries/carpentries.org/blob/5524366743246303aa1dd80343dd4759685b44e9/_posts/2017/07/2017-07-10-assess_report.md?plain=1#L24
153+
[swc-site]: http://software-carpentry.org/

Diff for: ‎_config.yml

+2-1
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,8 @@ github_url : "https://github.com/hpc-carpentry"
3838
github_io_url : "http://hpc-carpentry.github.io"
3939
incubator_url : "https://github.com/carpentries-incubator"
4040
incubator_io : "https://carpentries-incubator.github.io"
41-
contact : "[email protected]"
41+
contact_org : "[email protected]" # Closed list
42+
contact_com : "[email protected]" # Community
4243
contact_dach : ""
4344
contact_nz : "[email protected]" # Megan Guidry, New Zealand
4445
contact_uk : ""

Diff for: ‎_includes/mailchimp_signup_form.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ <h3>Marketing Permissions</h3>
5656
<fieldset class="mc_fieldset gdprRequired mc-field-group" name="interestgroup_field">
5757
<label class="checkbox subfield" for="gdpr_963"><input type="checkbox" id="gdpr_963" name="gdpr[963]" value="Y" class="av-checkbox "><span>Email</span> </label>
5858
</fieldset>
59-
<p>You can change your mind at any time by clicking the unsubscribe link in the footer of any email you receive from us, or by contacting us at <a href="mailto:{{site.contact}}">{{site.contact}}</a>.
59+
<p>You can change your mind at any time by clicking the unsubscribe link in the footer of any email you receive from us, or by contacting us at <a href="mailto:{{site.contact_org}}">{{site.contact_org}}</a>.
6060

6161
Privacy policy: <a href="https://docs.carpentries.org/topic_folders/policies/privacy.html" target="_blank">Our Privacy Policy</a>
6262

Diff for: ‎pages/citations.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -26,4 +26,5 @@ reports about our impact can be found in our
2626
-->
2727

2828
Do you know about other works that should be listed here? If so, please
29-
[email us](mailto:{{ site.contact }}) to let us know. Thanks!
29+
[email the maintainers](mailto:{{ site.contact_org }}) to let them know.
30+
Thanks!

Diff for: ‎pages/community-lessons.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -60,7 +60,7 @@ needs and to use these materials freely (all lessons should be licensed
6060
[CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/)).
6161

6262
If you are interested in developing or submitting a lesson to the Carpentries
63-
Incubator, [contact us](mailto:{{ site.contact }}).
63+
Incubator, [contact the maintainers](mailto:{{ site.contact_org }}).
6464
Please read the information in The Carpentries' [Development of Lessons page](
6565
https://carpentries.org/involved-lessons/) if you would like to contribute to
6666
the development of a lesson already present in The Carpentries Incubator.

Diff for: ‎pages/contact.md

+4-2
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,11 @@ The members (with their GitHub handles and/or emails) are:
2828
<div class="row">
2929
<div class="medium-4 columns">
3030
<strong>by email:</strong>
31-
<br>General enquiries: <br>
32-
<a href="mailto:{{site.contact}}">{{site.contact}}</a><br>
31+
<br>Maintainer enquiries: <br>
32+
<a href="mailto:{{site.contact_org}}">{{site.contact_org}}</a><br>
3333
</div>
34+
<br>Ask the broader HPC Carpentry community: <br>
35+
<a href="mailto:{{site.contact_com}}">{{site.contact_com}}</a><br>
3436
<div class="medium-4 columns">
3537
<strong>on Twitter:</strong>
3638
<br><br>

Diff for: ‎pages/help-wanted-issues.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -85,7 +85,7 @@ The Carpentries Incubator
8585
or a repository listed in the [HPC Carpentry Listings]()
8686
and would like to add your repository to,
8787
or remove your repository from, this listing
88-
please <a href="mailto:{{site.contact}}">contact us</a>.
88+
please <a href="mailto:{{site.contact_org}}">contact the maintainers</a>.
8989

9090
[Read this guide to learn more about how and when to add "help wanted" and other labels to
9191
issues on your lesson repository][handbook-github-labels].

Diff for: ‎pages/jobs.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,5 +6,5 @@ permalink: /jobs/
66

77
Do you know of a job opening, vacancy, fundinging opportunity, or grants
88
related to high performance computing, scientific computing, or the work we are
9-
doing? If so, please [email us](mailto:{{ site.contact }}) to let us know.
9+
doing? If so, please [email us](mailto:{{ site.contact_org }}) to let us know.
1010
Thanks!

Diff for: ‎pages/lessons.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
---
99

1010
<p>
11-
Please <a href="mailto:{{site.contact}}">contact us</a> with any general questions.
11+
Please <a href="mailto:{{site.contact_org}}">contact the maintainers</a> with any general questions.
1212
</p>
1313

1414
<div class="row">

Diff for: ‎pages/regional_NZ.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ <h3>Megan Guidry</h3>
4343
Megan will get right back to you!
4444
<br><br>
4545
General questions about HPC Carpentry outside of New Zealand?
46-
Contact <a href="mailto:{{site.contact}}">{{ site.contact }}</a> and we’ll get
46+
Contact <a href="mailto:{{site.contact_org}}">{{ site.contact_org }}</a> and we’ll get
4747
your message to the right team member to follow up.
4848
<br><br>
4949

Diff for: ‎pages/testimonials.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,4 +11,4 @@ excerpt: testimonials about The Carpentries from our community
1111
-->
1212
<hr>
1313

14-
<p>Have a story of your own you'd like to share? Please <a href="mailto:{{site.contact}}?subject=testimonial">let us know</a>.</p>
14+
<p>Have a story of your own you'd like to share? Please <a href="mailto:{{site.contact_org}}?subject=testimonial">let the maintainers know</a>.</p>

0 commit comments

Comments
 (0)