diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index b289e1699..62e98830e 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,133 +1,153 @@ # Contributing -Like the official [Carpentries][c-site] sites [Software Carpentry][swc-site], [Data Carpentry][dc-site], -and [Library Carpentry][lc-site]; [HPC Carpentry][hpcc-site] is an open source project, -and we welcome contributions of all kinds: -blog posts, -fixes to existing material, -bug reports, -and reviews of proposed changes are all welcome. +Like the official [Carpentries][c-site] sites---[Software +Carpentry][swc-site], [Data Carpentry][dc-site], and +[Library Carpentry][lc-site]---[HPC Carpentry][hpcc-site] +is an open source project, and we welcome +contributions of all kinds: blog posts, 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). -Everyone involved in i[HPC Carpentry][hpcc-site] -agrees to abide by our [code of conduct][conduct]. - +By contributing, you agree that we may redistribute your work under +[our license](LICENSE). Everyone involved in +[HPC Carpentry][hpcc-site] agrees to abide by our +[code of conduct][conduct]. ## How to Contribute a Fix or Suggested Change -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). +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 + comments to the [community email list][discuss-list]. + 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). ## Where to Contribute -1. If you wish to change the website, - please work in , - which can be viewed at . +1. If you wish to change the website, please work in + , + which can be viewed at . -2. If you wish to change CSS style files, tools, - or HTML boilerplate for lessons or workshops stored in `_includes` or `_layouts`, - please work in (on which - this website is based). +2. If you wish to change CSS style files, tools, or HTML boilerplate + for lessons or workshops stored in `_includes` or `_layouts`, + please work in + (on which this website is based). ## How to Contribute a Blog Post -1. If you wish to contribute a blog post, - please work in , - which can be viewed at . - -2. Posts go in the `_posts` folder, which is divided up first by year, - e.g. `2018`, and then by month, e.g. `04`. Be sure to start creating your file in - the correct folder. - -3. Posts need to be created in [Markdown](https://guides.github.com/features/mastering-markdown/) and named - according to this convention (all-lower-case filenames are preferred): - - `YYYY-MM-DD-filename.md` - - e.g. - - `2017-07-10-assess_report.md` - -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. - -``` ---- -layout: page -authors: ["Tracy Teal", "Maneesha Sane", "Belinda Weaver"] -title: "Launching our New Handbook" -teaser: "Find new pathways to a range of Carpentries material" -date: 2018-04-11 -time: "9:00:00" -tags: ["Communications"] ---- -``` - -Separate the header block from the post proper by a new line. - -5. `Time`, but the other fields should be filled in. If there is more than one author, - separate the author names like this: `["Name 1", "Name 2"]`. Separate any tags the same way. - -6. Images should be uploaded to the appropriate year in the `files//` folder. Images should be linked using - Markdown, and paths to the image should be relative. - Example: - ``` - ![Image Description]({{ site.filesurl }}/2017/07/myimage.jpg) - ``` - A web link should be used for images hosted elsewhere. - Example: - ``` - ![Image Description](https://web_address/pathway_to_full_image_filename) - ``` - - 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. - -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. +1. If you wish to contribute a blog post, please work in + , + which can be viewed at . + +2. Posts go in the `_posts` folder, which is divided up first by + year, e.g. `2018`, and then by month, e.g. `04`. Be sure to start + creating your file in the correct folder. + +3. Posts need to be created in [Markdown][md-guide] and named + according to this convention (all-lower-case filenames are + preferred): + + `YYYY-MM-DD-filename.md` + + e.g., + + `2017-07-10-assess_report.md` + +4. In order to render correctly, posts need to have a header block, + which should be [created like this example][hdr-block]: + + ```yaml + --- + layout: page + authors: ["Tracy Teal", "Maneesha Sane", "Belinda Weaver"] + title: "Launching our New Handbook" + teaser: "Find new pathways to a range of Carpentries material" + date: 2018-04-11 + time: "9:00:00" + tags: ["Communications"] + --- + ``` + + Separate the header block from the post proper by a new line. + You can leave the `time` field as-is or set it to a meaningful + value. Please make your best effort to accurately populate the + rest of the fields. + +5. If there is more than one author, separate the quoted author + names using commas, like this: + + ```yaml + ["Name 1", "Name 2"] + ``` + + Separate any tags the same way. + +6. Images should be uploaded to the appropriate year in the + `files//` folder. Images should be linked using + Markdown, and paths to the image should be relative. Example: + + ```markdown + ![Image Description]({{ site.filesurl }}/2017/07/myimage.jpg "alt text") + ``` + + A web link should be used for images hosted elsewhere. + Example: + + ```markdown + ![Image Description](https://web_address/pathway_to_full_image_filename) + ``` + + If you are not sure how to add images in Markdown format, + look at an existing Carpentries post with a + [locally hosted image][md-img-local] or + [one with a web link][md-img-remote] and copy the formatting + from there. + +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][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. ## Other Resources -General discussion of [HPC Carpentry][hpcc-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 [HPC Carpentry][hpcc-site] happens on the +[discussion mailing list][discuss-list], which everyone is welcome +to join. You can also [reach the maintainers by email][contact]. -[contact]: mailto:maintainers-hpc@lists.carpentries.org + + +[actions]: https://github.com/hpc-carpentry/hpc-carpentry.github.io/actions [conduct]: https://docs.carpentries.org/topic_folders/policies/code-of-conduct.html -[dc-issues]: https://github.com/issues?q=user%3Adatacarpentry -[dc-lessons]: https://datacarpentry.org/lessons/ -[dc-site]: https://datacarpentry.org/ +[contact]: mailto:maintainers-hpc@lists.carpentries.org [discuss-list]: https://carpentries.topicbox.com/groups/discuss-hpc -[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/hpc-carpentry/hpc-carpentry.github.io/issues/ -[repo]: https://github.com/hpc-carpentry/hpc-carpentry.github.io -[swc-issues]: https://github.com/issues?q=user%3Aswcarpentry -[swc-lessons]: http://software-carpentry.org/lessons/ -[swc-site]: http://software-carpentry.org/ -[lc-issues]: https://github.com/issues?q=user%3Adatacarpentry -[lc-lessons]: https://librarycarpentry.org/lessons/ +[hpcc-site]: https://www.hpc-carpentry.org + + + +[c-site]: https://carpentries.org +[dc-site]: https://datacarpentry.org/ +[github-join]: https://github.com/join +[github]: http://github.com +[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 [lc-site]: https://librarycarpentry.org/ +[md-guide]: https://guides.github.com/features/mastering-markdown/ +[md-img-local]: https://github.com/carpentries/carpentries.org/blob/5524366743246303aa1dd80343dd4759685b44e9/_posts/2017/06/2017-06-19-mqu-ttt.md?plain=1#L29 +[md-img-remote]: https://github.com/carpentries/carpentries.org/blob/5524366743246303aa1dd80343dd4759685b44e9/_posts/2017/07/2017-07-10-assess_report.md?plain=1#L24 +[swc-site]: http://software-carpentry.org/ diff --git a/_config.yml b/_config.yml index 4936bc351..b91c4b457 100644 --- a/_config.yml +++ b/_config.yml @@ -38,7 +38,8 @@ github_url : "https://github.com/hpc-carpentry" github_io_url : "http://hpc-carpentry.github.io" incubator_url : "https://github.com/carpentries-incubator" incubator_io : "https://carpentries-incubator.github.io" -contact : "maintainers-hpc@lists.carpentries.org" +contact_org : "maintainers-hpc@lists.carpentries.org" # Closed list +contact_com : "discuss-hpc@lists.carpentries.org" # Community contact_dach : "" contact_nz : "admin-nz@carpentries.org" # Megan Guidry, New Zealand contact_uk : "" diff --git a/_includes/mailchimp_signup_form.html b/_includes/mailchimp_signup_form.html index 8b07e4313..06f091f4d 100644 --- a/_includes/mailchimp_signup_form.html +++ b/_includes/mailchimp_signup_form.html @@ -56,7 +56,7 @@

Marketing Permissions

-

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 {{site.contact}}. +

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 {{site.contact_org}}. Privacy policy: Our Privacy Policy diff --git a/pages/citations.md b/pages/citations.md index 927b9e5f0..2c2a37176 100644 --- a/pages/citations.md +++ b/pages/citations.md @@ -26,4 +26,5 @@ reports about our impact can be found in our --> Do you know about other works that should be listed here? If so, please -[email us](mailto:{{ site.contact }}) to let us know. Thanks! +[email the maintainers](mailto:{{ site.contact_org }}) to let them know. +Thanks! diff --git a/pages/community-lessons.md b/pages/community-lessons.md index 78a898f01..fffdb0163 100644 --- a/pages/community-lessons.md +++ b/pages/community-lessons.md @@ -60,7 +60,7 @@ needs and to use these materials freely (all lessons should be licensed [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/)). If you are interested in developing or submitting a lesson to the Carpentries -Incubator, [contact us](mailto:{{ site.contact }}). +Incubator, [contact the maintainers](mailto:{{ site.contact_org }}). Please read the information in The Carpentries' [Development of Lessons page]( https://carpentries.org/involved-lessons/) if you would like to contribute to the development of a lesson already present in The Carpentries Incubator. diff --git a/pages/contact.md b/pages/contact.md index 15b4b9bfd..c2831cd61 100644 --- a/pages/contact.md +++ b/pages/contact.md @@ -28,9 +28,11 @@ The members (with their GitHub handles and/or emails) are:

by email: -
General enquiries:
-{{site.contact}}
+
Maintainer enquiries:
+{{site.contact_org}}
+
Ask the broader HPC Carpentry community:
+{{site.contact_com}}
on Twitter:

diff --git a/pages/help-wanted-issues.md b/pages/help-wanted-issues.md index 810dfa96c..18936f266 100644 --- a/pages/help-wanted-issues.md +++ b/pages/help-wanted-issues.md @@ -85,7 +85,7 @@ The Carpentries Incubator or a repository listed in the [HPC Carpentry Listings]() and would like to add your repository to, or remove your repository from, this listing -please contact us. +please contact the maintainers. [Read this guide to learn more about how and when to add "help wanted" and other labels to issues on your lesson repository][handbook-github-labels]. diff --git a/pages/jobs.md b/pages/jobs.md index cd75a4d31..889a58ab3 100644 --- a/pages/jobs.md +++ b/pages/jobs.md @@ -6,5 +6,5 @@ permalink: /jobs/ Do you know of a job opening, vacancy, fundinging opportunity, or grants related to high performance computing, scientific computing, or the work we are -doing? If so, please [email us](mailto:{{ site.contact }}) to let us know. +doing? If so, please [email us](mailto:{{ site.contact_org }}) to let us know. Thanks! diff --git a/pages/lessons.html b/pages/lessons.html index c70456ce0..48e3ee2cc 100644 --- a/pages/lessons.html +++ b/pages/lessons.html @@ -8,7 +8,7 @@ ---

- Please contact us with any general questions. + Please contact the maintainers with any general questions.

diff --git a/pages/regional_NZ.html b/pages/regional_NZ.html index c564b1346..bb808f0fa 100644 --- a/pages/regional_NZ.html +++ b/pages/regional_NZ.html @@ -43,7 +43,7 @@

Megan Guidry

Megan will get right back to you!

General questions about HPC Carpentry outside of New Zealand? -Contact {{ site.contact }} and we’ll get +Contact {{ site.contact_org }} and we’ll get your message to the right team member to follow up.

diff --git a/pages/testimonials.md b/pages/testimonials.md index db30a1443..a40a558c9 100644 --- a/pages/testimonials.md +++ b/pages/testimonials.md @@ -11,4 +11,4 @@ excerpt: testimonials about The Carpentries from our community -->
-

Have a story of your own you'd like to share? Please let us know.

+

Have a story of your own you'd like to share? Please let the maintainers know.