Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

restore HPC content, remove Carpentries content #22

Merged
merged 19 commits into from
Apr 21, 2021

Conversation

tkphd
Copy link
Member

@tkphd tkphd commented Apr 17, 2021

This PR aims to remove material specific to The Carpentries, such as institutional sponsors and donation opportunities, and replace boilerplate or Carpentries-specific copy with HPC Carpentry equivalents.

The table enumerating HPC Carpentry lessons has been restored.

The Help Wanted page has been filtered to only show issues from HPC Carpentry lessons.

@tkphd tkphd requested review from reid-a and ocaisa April 17, 2021 03:03
Copy link
Member

@reid-a reid-a left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks like a good set of revisions to help the HPC lesson stand alone Thanks!

Copy link
Member

@ocaisa ocaisa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Overall I think this is really nice trimming of the site. I'd be concerned that it's a bit too agressive in some parts and removes some useful templates that we could use in the future.

_config.yml Show resolved Hide resolved
_config.yml Show resolved Hide resolved
_config.yml Show resolved Hide resolved
_data/lessons.yml Outdated Show resolved Hide resolved
_data/lessons.yml Outdated Show resolved Hide resolved
pages/request-workshop.md Outdated Show resolved Hide resolved
pages/strategic-plan.md Show resolved Hide resolved
pages/task-forces.md Outdated Show resolved Hide resolved
pages/teach.md Show resolved Hide resolved
pages/testimonials.md Outdated Show resolved Hide resolved
@tkphd
Copy link
Member Author

tkphd commented Apr 19, 2021

Thank you for the feedback, @reid-a and @ocaisa. Before responding to the individual comments, I want to summarize my mindset when I made these sweeping, often deep-cutting, changes.

HPC Carpentry is a nascent organization, and we aspire to join The Carpentries. It remains to be seen whether that will occur, and if it does, on what timeline. With that in mind:

  1. The repository this one is based upon is CC BY, so we can copy all of it.
  2. The upstream repository is actively maintained by a larger organization, and subject to change -- often for the better -- that we can synchronize with as needed.
  3. When deploying the site to represent ourselves, it is important that we do not misrepresent HPC Carpentry as a formal member of The Carpentries.
  4. Parts of the upstream website interface with AMY, where contributors opt in to be publicly listed. That permission is granted to The Carpentries, not to HPC Carpentry. It is unethical to include those parts.
  5. We are a small team, and each additional line of code represents a maintenance burden.
  6. If a feature, page, or parameter is of immediate use, it stays.
  7. If a feature, page, or parameter might come in handy -- let the upstream maintainers improve those parts and, when the time comes for us to include them, we can pull the latest versions.

@reid-a
Copy link
Member

reid-a commented Apr 19, 2021

I think I concur with @tkphd that, when we become official, we'll want to match up with the then-current Carpentries scheme, which may not match the material that's been removed here. FWIW.

Copy link
Member

@ocaisa ocaisa left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think removing comments that potentially provide people with quick and useful information increases the maintenance effort rather than reduces it. I'm not sure it is so realistic to believe that anyone editing this repo will automatically cross-reference with the upstream site.

_config.yml Show resolved Hide resolved
_config.yml Show resolved Hide resolved
_config.yml Show resolved Hide resolved
_data/lessons.yml Outdated Show resolved Hide resolved
_data/navigation.yml Show resolved Hide resolved
_data/navigation.yml Show resolved Hide resolved
_data/navigation.yml Show resolved Hide resolved
_data/socialmedia.yml Show resolved Hide resolved
_data/lessons.yml Outdated Show resolved Hide resolved
@tkphd
Copy link
Member Author

tkphd commented Apr 20, 2021

Valid points, @ocaisa, thank you for the patient replies. I will revise.

@tkphd
Copy link
Member Author

tkphd commented Apr 20, 2021

For fellow travelers, the back-and-forth between @ocaisa (who originally ported this website, and is the expert) and myself (not a Jekyll noob either) is a healthy exchange, and at the end, we'll have a better website for it. This is why we have pull requests and peer review, rather than making changes to the production website directly. Plus, it looks like this has spurred some awesome upgrades -- much appreciated, Alan!

@tkphd
Copy link
Member Author

tkphd commented Apr 21, 2021

OK, @ocaisa! I've done my best to resolve your detailed comments & objections. Site build locally, and now displays our shared Google Calendar and presents @megan-guidry as our Regional Coordinator for New Zealand. Let me know what you think.

@tkphd tkphd requested a review from ocaisa April 21, 2021 00:32
_config.yml Outdated
- data: badges_stats
json: 'https://feeds.carpentries.org/badges_stats.json'
# - data: community_lessons
# json: 'https://feeds.carpentries.org/community_lessons.json'
- data: community_lessons
Copy link
Member

@ocaisa ocaisa Apr 21, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

At the moment this is a manually curated file (but that will change with #25) so this needs to remain commented out or we will pull in all the Carpentries Incubator information

@ocaisa
Copy link
Member

ocaisa commented Apr 21, 2021

This is great, thanks a lot for spending so much time on it @tkphd !

@ocaisa ocaisa merged commit 47de46d into main Apr 21, 2021
@ocaisa ocaisa deleted the Carpentries-specific-content branch April 21, 2021 07:16
@tkphd
Copy link
Member Author

tkphd commented Apr 21, 2021

Of course, @ocaisa -- happy to do my part!

@tkphd tkphd mentioned this pull request Apr 21, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants