hpc-carpentry/hpc-carpentry.github.io

The HPC Carpentry website

hpc-carpentry.github.io's Issues

Broken "contact us" link

On line 63 of pages/community-lessons.md, there's a "contact us" link that uses the site.contact variable as a target -- it looks like it's meant to be a mailto: link, maybe? But it resolves to https://www.hpc-carpentry.org/community-lessons/[email protected], which starts out looking like a web URL, but turns into an e-mail at the end.

This was spotted by Victor Eijkhout when he tried to reach out to us.

I'm creating this issue instead of fixing it because I'm not immediately familiar with the variable structure of the site -- I probably should be, and I may come back to it later, but if someone who is more current on the site wants to jump in and fix it, I certainly won't stop them!

Clarify core curriculum

As mentioned in #54 and #74, the lesson page is difficult to parse. This could be improved by outlining the core curriculum for an HPC Carpentry workshop like what's done on the Organization README. I personally like the table format used by the other Carpentries.

I could see two different places to add a table and short description:

1. To the current lesson page:
   • Pros: Brings structure to the page; keeps the same URL
   • Cons: Adds more to an already dense page; the Software Carpentry shell lesson does not fit into any of the three categories on the community-lessons page
2. To a new page:
   • Pros: Cleaner; clarifies what's being actively maintained(?)
   • Cons: Duplicates lesson listings

I personally lean towards option 2 for simplicity, but an overhaul of the lesson page could make 1 more attractive. In particular, the Library Carpentry's presentation is pretty clear and something similar could be adapted. I imagine one table with the Core Curriculum and another with the HPC Carpentry lessons as an Extended Curriculum along with "status" tags to clarify retired or no-longer-maintained lessons.

Add link to meetings information

@alansill Make it easy for people to join meetings

Create a "Steering Committee" page introducing ourselves

Contact Us page not rendering properly

See http://www.hpc-carpentry.org/contact/

Creating our own feeds for our repos

The Carpentries code for generating their feeds is at https://github.com/carpentries/feeds.carpentries.org. We could use this code ourselves to generate feeds related to our own repos that we automatically pull into our website. With our current build process we wouldn't need to do that as a separate step, we can run it as part of the process.

We could then create a cron Action to automatically build the page once every so often.

Rename this repo to hpc-carpentry.github.io

We should archive the existing hpc-carpentry.github.io repo and rename this one to that name. This has the benefit that all our lessons will then appear under hpc-carpentry.org/lesson-title.

add menu item to request/add a workshop

The link to the form is kinda hidden under Learn -> Upcoming -> Click to add.

Teach is a 404

Top-level "Teach" navbar item is not a valid link. Consequence of #22?

https://www.hpc-carpentry.org/teach/

Clarify Main Page

Delete logos & links to sister programs. Replace subscription box with Slack info, maybe calendar link.

Lesson links are outdated

List of lessons at https://www.hpc-carpentry.org/community-lessons/ is outdated,
in particular workflows lesson is in the incubator.

Accessibility issue with web site

Hello

I have just visited the HPC-Carpentry web site. I have some significant vision issues (I have sight just very poor). There are two issues with the font used in the paragraphs that make them unreadable to me. I was not able to see/find a maintainer email address but did find a link to the various carpentries repos. I opened an issue in one of them and they directed me here.

The problems are that the paragraph font color appears to be maybe mid-or light grey. and that the font is very thin. The grey text sinks into the white background and the thinness of the font type makes that worse.

Can you please change the font color to black on white background... actually black against all light/translucent backgrounds? Also please use "normal" weight fonts please.

Thank you

Citations & Publications

http://www.hpc-carpentry.org/citations/ is sparse as can be, and perhaps in the wrong scope. I propose moving it to "publications," and generating a list of resources useful to us as we develop the curriculum, to include the items mentioned on Slack:

• The Carpentries Curriculum Development Handbook
• Teaching Tech Together
• Exploratory study of introducing HPC to non-ICT researchers: institutional strategy is possibly needed for widespread adaption
• Intro to AWS and AWS for High Performance Computing (HPC)
• MagicCastle, JetStream, LearnHPC
• ...

Use Carpentries workshop database

Currently, our Workshop Registration form is our own tool. It would be much more efficient to use The Carpentries' toolchain, which feeds a public database of workshops.

weekly build failure

@ocaisa, the weekly site re-build hit this snag:

Lmod has detected the following error: These module(s) or extension(s) exist
but cannot be loaded as requested: "OpenBLAS/0.3.15-GCC-10.3.0"
   Try: "module spider OpenBLAS/0.3.15-GCC-10.3.0" to see how to load the
module(s).

Can you troubleshoot?

Clarify Footer

• About HPC Carpentry: rephrase to make it clear we operate in the spirit of The Carpentries, but not as an official program. (This is excerpted from the main About Us page, I think.)
• Links:
  • Create a landing page for our Code of Conduct, with instructions to contact a Steering Committee member to report a breach. Then link out to The Carpentries' policy.
  • Create a landing page for our Handbook, or drop it.
  • Create a landing page for our Privacy Policy, with instructions to contact a Steering Committee member to report a breach. Then link out to The Carpentries' policy.
  • Drop Annual Reports.
  • Create a new section for Carpentries Links to redirect to our sister programs.

branch protection

The branches in this repo are not protected.

• The main branch should require at least one approving review.
• If possible, the gh-pages branch should only be writable by Netlify.

document deployment infrastructure

Strange that build-and-deploy.yml uses gh-pages, not the default main branch where edits go.

hpc-carpentry.github.io/.github/workflows/build-and-deploy.yml

Line 53 in a1ea1dd

- name: Build and deploy gh-pages branch

Apparently, this is correct (see below), and necessary because this is not a vanilla deployment (i.e., not hosted by GitHub).

improve lessons page

The current list is a long page with lesson links placed almost towards the bottom. It might be confusing for beginners. We could improve the look of
https://www.hpc-carpentry.org/community-lessons/

may be using the upcoming templates.

testimonials

Get permission and create a page (under /pages/testimonials.md) for learner testimonials.
The following template may come in handy:

---
layout: page-fullwidth
permalink: /testimonials/
title: Testimonials from Workshop Attendees
excerpt: testimonials about The Carpentries from our community
---
{:auto_ids}
Anonymous scientist from the field of Magnetohydrodynamics
:    Well explained and thanks a lot for answering all my
     stupid questions. I had to work with a script (on the
     cluster) in the past without understanding what I did
     - now I know and can improve even more.

---

*Have a story of your own you'd like to share? Please [let us know](mailto:{{site.contact}}?subject=testimonial).*

Add links to relevant existing lessons

In the coordination repo, there's an issue where a number of interesting resources have been identified that could be linked to from the website.

This issue is for discussion and possibly implementation of the links in the site.

Clarify maintainers

There is a Maintainers page, but nobody listed. The current (commented out) mechanism for doing this does not easily translate to HPC Carpentry maintainers, so this might need to be done manually.

sync Makefile with other repositories

make serve should bundle install --local before bundle exec

Include High-Performance Linpack Tutorial

I've written a tutorial on high performance linpack (HPL) and HPCG appropriate for computer scientists who want to understand this historic benchmark for the top500 list.
It currently exists here: https://github.com/frobnitzem/hpl-hpcg
What's the best way to get it added to hpc-carpentry?

migration checks

• Has the existing content been migrated over from hpc-carpentry/hpc-carpentry.github.io?
• Is this repo publicly visible?
• Can new blog posts be submitted by community members?
• Does the new site successfully build?

using `orgs` API to try to access user repositories

The website builds are currently failing, due to the changes made to feeds/other_lessons.R in 13a0ea3.

The problem is that the get_org_topics function used on line 47 of that file

  frobnitzem <- get_org_topics("frobnitzem")

uses the get_list_repos function defined in feeds/utils.R, which makes a call to the GitHub organizations API, to try to get a list of repositories for an organisation. frobnitzem is a user account, so should be queried via the users API. See the difference between the current call that is being made

https://api.github.com/orgs/frobnitzem/repos

and the result of the equivalent call made via the users API

https://api.github.com/users/frobnitzem/repos

I am fairly certain that this is the problem, but less confident about the best solution. I suppose you would need to adjust get_list_repos to accept an optional parameter that tells it to query the users API instead of the orgs API?

Clarify Teach Menu

Entire menu links to, or duplicates verbatim, Carpentries pages.
Need to create customized versions, or drop over-reaching entries.

mission statement

In about.md:

Mission: We're still working on our mission statement, but when it lands it's going to be amazing!

Clarify Learn Menu

Workshops:

• Create a derivative work from The Carpentries' version, cleaned up for the parts relevant to our smaller organization.
• Create a YAML/JSON file for workshops, from which we can create a list of upcoming & past workshops. Possibly using a web form. Contents: Organizer's Name, Location, Link to Workshop, and Date.
• Create pre-, post-, and 3-month survey forms

CODEOWNERS to auto-request reviews

Add a .github/CODEOWNERS to request reviews automatically.