usrse/usrse.github.io

US RSE umbrella web page

The United States (US) Research Software Engineer Association

https://us-rse.org

What is this?

These are the files for the official US RSE community website hosted at https://us-rse.org. The site is built with Jekyll and hosted on GitHub.

Members of US-RSE have access to the organizational Slack space. The #website channel, referenced frequently below, is part of that space. It's the best place to ask questions and get help.

How do I contribute?

We encourage the community to contribute to the content of the website.
To do this: fork the repository, make your proposed changes, and then create a pull request against main. More details below.

Where is the page I'm looking for?

The webpage text exist in markdown files (.md) in several places like _events, _pages, and wg. The best way to find the page you're trying to edit is to follow the path in the URL of the page itself. Example: editing the page for "https://us-rse.org/events/2022/2022-10-funder-talk-series/" would be in /_events/2022/2022-10-funder-talk-series.md

Can't find what you're looking for? You're not alone. Ask on the Slack #website channel.

How do I add an image/file?

Small files like .png images go into /assets/img

Larger files like slides from a speaker series currently go into a read-only Google Drive. One exists for the speaker series here.

• You'll need to ask to add slides to that folder if you are not an editor.
• Managers will need to change the permissions of files added there to be read-only and provide a share link that is accessible to anyone with the link to view.

How do I add a job?

Please fill out the form. Jobs are reviewed for relevance.

How do I add an event?

Fill out the form, or see the events details page on how to create an event file directly.

How do I...?

Further content editing tips are in the details file

Pull Request (PR) Process

PRs should be made on the main branch only.

Those who have full permissions to the repository should still be working on separate branches and creating PRs for any changes.

What to Include

Give the PR a descriptive title. The PR template asks you for a description of the changes - a brief description is fine for simple/routine changes.

Three things to do after creating the PR:

1. Preview the site, either locally (necessary for complex functionality changes - see docs/local_previews.md for details) or with the CircleCI preview (fine for routine content changes and additions - see docs/tests_ci.md for details).
2. Ask others to review content if needed. For example, if your change is part of a working group's activities, you may need to check with other members of the working group to review your update.
3. Once the content is settled, post a link to the PR on the Slack #website channel to get reviewers for functionality and basic website style conformity.

Review Policy

PR reviews are not content reviews. While corrections to basic grammatical issues, links, clarity problems, etc. in the files that are part of the review can be noted, the content of things to be posted to the website should generally be discussed and resolved before creating a PR. If you create a PR that needs a content review before a technical review by the website group, please note that in the PR info.

Those with merge permissions on the repo: use your judgment as to whether you need a reviewer. Routine edits, additions, changes that are part of the normal activities of US-RSE do not need to be reviewed unless you want. For larger edits (things requiring discussion or assistance), please ask for someone else to review. Generally "squash" when merging.

For those without merge permissions:

• 1 reviewer for routine/small edits, additions, and changes. If you get a review from someone who doesn't have merge permissions, ping the #website channel on Slack to let people know your PR has been reviewed but needs to be merged.
• 2 reviewers (and likely discussion in the PR, an issue, or the Slack #website channel) for changes to the layout, functionality, or style of the website

Anyone in US-RSE who is familiar with the website is welcome to review PRs.

Want merge permissions? Join the #website channel in Slack, help out a bit with tasks that come up, and then ask - we're happy to have new website maintainers.

Checks and Tests

When you create a PR, automated tests run; see docs/tests_ci.md for details.

What the PR submitter is responsible for:

• URL Checker: This does NOT check internal relative links on the site, only absolute/full URLs. If the URL checker fails, click on the Details link, and then expand the URLs-checker section of the report that comes up to try to find the failed URL.
  • Failed URL in a file that is part of your PR: you must fix it.
  • Failed URLs in the job listings: OK to ignore
  • Failed URL check where you know the URL is actually OK: OK to ignore.
  • Failed URL on another page outside of your PR: fix it if you can. If you can't fix it (not sure what to replace it with, etc.), please note the problem in the PR discussion. The person who merges the PR may choose to ignore the issue.
• Spellchecker: Click on the Details link, then expand the Check Spelling section of the report that comes up to identify the issue.
  • Spelling issue in a file that is part of the PR: you must fix it. If it's a legitimate word, you may need to add an exception to .github/workflows/typo_config.toml
  • Spelling issue in a file that is not part of the PR: this generally shouldn't happen, as previous PRs have also had the spellchecker run.

Questions? Not sure what to do or what the problem is? Ask on the #website channel on Slack.

Supporting Documentation

More details can be found in:

• docs/events.md: formatting for events, how the events and calendar work
• docs/details.md: redirects, embedding videos, last modified dates on pages, etc.
• docs/tests_ci.md: further details on CI processes
• docs/local_previews.md: how to run and preview the site locally on your computer
• docs/feeds.md: RSS and JSON feeds available for the site

Contributors

We use the all-contributors tool to generate a contributors graphic below.

Vanessasaurus 💻 📖 📝 🖋 🎨 🤔 🚇 🚧 🔧	Ian Cosden 💻 📝 🖋 📋 🤔 🔍 👀	Chris Hill 💻	Christina Maimone 💻	Charles Ferenbaugh 💻	Daniel S. Katz 📝 💻 📋 🤔	Jordan Perr-Sauer 💻
Lance Parsons 💻	Mahmood M. Shad 💻	kir0ul 💻	Anastasia Baryshnikova 💻	Gregory Lemieux 💻	Jonathan Dursi 💻	Julia Damerow 💻
Kevin Manalo 💻	Nam Pho 💻	Noam Ross 💻	Philip Durbin 💻	Sandra Gesing 💻	Simon Byrne 💻	Tai Sakuma 💻
neisty 💻	toreliza 💻	Kenton McHenry 💻	Abhishek Dutta 💻	JeffCarver 💻	Nicole Brewer 💻	Sajid Ali 💻
frolovsa 💻	Carlos Eduardo Arango Gutierrez 💻	clairecporter 💻	Jordan P. Lefebvre 💻	Max Hutchinson 💻	Greg Watson 💻	Jonathon Anderson 💻
Alexander Koufos 💻	Peter Williams 💻	BRG 💻	David E. Bernholdt 💻	Andrew Su 💻	Christopher Blanton 💻	Guilherme Castelão 💻
Abbey Roelofs 💻	Mark Carroll 💻	David Nicholson 💻	Blake Joyce 💻	Ilya Sytchev 💻	Emil Østergaard 💻	Joseph H Kennedy 💻
Chad Dougherty 💻	Miranda Mundt 💻	Bryan Raney 💻	sb 💻	rkakodkar 💻	Thomas A Caswell 💻	Alfredo Rodriguez 💻
Dylan McReynolds 💻	Joshua Teves 💻	chrisvam 💻	Dr. Phil Maffettone 💻	Lauren Milechin 💻	Adam Cooper 💻	Rafael M Mudafort 💻
Luke R. 💻	David Beckingsale 💻	Rinku Gupta 💻	adamrubens 💻	T. Andrew Manning 💻	Richard Littauer 💻	Jamil Gafur 💻
Henry Burgess 💻	Pete Peterson 💻	Kevin Bonham 💻	Aaron Holmes 💻	jbteves-sandia 💻	Keith Beattie 💻	William F. Broderick 💻
sanyatonwu 💻	David Brownell 💻

usrse.github.io's Issues

External link to code of conduct failed

This is likely transient since tests just passed on the PR before merging, but the linked CoC here failed the recent merge to master:

- ./_site/code-of-conduct/index.html

  *  External link https://nips.cc/public/CodeOfConduct failed: response code 0 means something's wrong.

             It's possible libcurl couldn't connect to the server or perhaps the request timed out.

             Sometimes, making too many requests at once also breaks things.

             Either way, the return message (if any) from the server is: Couldn't resolve host name

The link looks fine so I think we can safely ignore for now. If any admins on Travis can trigger a re-run @USRSE/usrse-admin it would be great to get the badge green again :)

Make sure princeton url is back up

Maybe tomorrow.
https://puwebp.princeton.edu/AcadHire/apply/application.xhtml?listingId=16041

Write instructions to preview PR on CircleCI

Wrote up very basic version on Google Doc, but need to put this in as part of the README or something here.

https://docs.google.com/document/d/1KLYdJniQoRTOQZ4L5FmmqnbJonSPl09pHC-mS-oebfM/edit?usp=sharing

Northwestern has bad certificates

A recent action run shows:

HTTPSConnectionPool(host='www.it.northwestern.edu', port=443): Max retries exceeded with url: /research/ (Caused by SSLError(SSLError("bad handshake: Error([('SSL routines', 'tls_process_server_certificate', 'certificate verify failed')])")))
https://www.it.northwestern.edu/research/
HTTPSConnectionPool(host='www.it.northwestern.edu', port=443): Max retries exceeded with url: /research/ (Caused by SSLError(SSLError("bad handshake: Error([('SSL routines', 'tls_process_server_certificate', 'certificate verify failed')])")))
https://www.it.northwestern.edu/research/
HTTPSConnectionPool(host='www.it.northwestern.edu', port=443): Max retries exceeded with url: /research/ (Caused by SSLError(SSLError("bad handshake: Error([('SSL routines', 'tls_process_server_certificate', 'certificate verify failed')])")))
https://www.it.northwestern.edu/research/

@cmaimone is there anyone you can ask about this? I'll do a re-run tomorrow to see if it's transient. To reproduce, you can just do:

import requests
response = requests.get("https://www.it.northwestern.edu/research/")

documentation on testing and integrations

In addition to #99, we also need documentation more for admins as to what tests are running, what integrations exist, etc. It's possible that info will need to go somewhere else other than this repo if there is sensitive credential info or other details that should not be publicly exposed.

PR reviewers

We need a policy/procedure for editing the webpages. Should gh-pages be protected? Things like blog posts I think need to be a PR, with independent reviewers. But what about smaller changes, like adding groups?

Shared link should not include jinja2!

This speaks for itself :)

This content is likely derived from some meta tag, so we need to fix that up :)

Fix twitter image

I can come back to this when I have time if no one else knows the best way to to it. #31 uses site.title-img but then that just points twitter to /assets/img/logo.png, not https://us-rse.org/assets/img/logo.png.

It probably means changing in _config.yml title-img to have the full url, or putting in the twitter metadata in head.html something like {{ site.url }}.

Add old events to appear in "events archive"

We only added the Sept 2020 and Oct 2020 community calls to the US-RSE calendar, and not the events pages. I think it would be a mistake to lose track of them. So for archival purposes, we should go through and makes sure we have everything that belongs in the archive (https://us-rse.org/events-archive/) listed. This should just mean creating a page for each event with it's original date.

I know we are missing at least the two recent calls, but at the same time we should go through and look for any other community calls or events that are missing.

member count for august?

How does the member count get updated? I'm looking for the version with August included for the RSEconUK19 slides...

documentation for pull requests

It would be helpful to have more documentation about how the workflow around a pull request happens.

When I make a pull request, there are some automated tests -- which of these need to pass, how do I get information about failures, etc.

Then should I request review? From who? If they suggest changes what happens? Who makes ultimate merge? All of these details.

@vsoch assigning you since you have details on some parts of this process that others don't have, and @lparsons volunteered to learn some of these details.

Happy to help write this, except I don't know the content, so my role is mostly what info I and others are likely to need and whether what is put together is sufficient.

Heads up about build artifacts!

Since we manipulate the static URL for our previews to work, this tweak might (or might not) impact us. Let's keep an eye on it!

Add Continuous Integration to Preview Site

We can very easily use Travis to test the content, and Circle to preview. Travis won't work for artifact preview because they require the user to specify a location to upload (e.g., AWS).

Add resources page

We need a place to put useful links (resources) (under the "Resources" tab? I assume), as discussed in the call today. It might be good to start with contributions here / slack for examples to clarify what a resource is.

Add download button for membership / join image

The visitor should be able to click on the canvas, and have it download.

Nav bar issues

On chrome on my android phone I can't open the hamburger menu on the home page. I can see the button, but I can't select it. This is not the case on the beautiful jekyll base site, so something must have gone wrong along the way.

Add SORSE

I'm not sure the best place to put it. Maybe just in links (https://us-rse.org/links/), but linked in the calendar might also make sense.

Update US-RSE Association

We have different names for the organization all over the place and it would be good to be consistent. Following the lead of the UK, and where we'd like to go, it should all be "US Research Software Engineer Association" and abbreviated with the hyphen as "US-RSE". It's just a matter of going through and checking (and updating the logo).

Bug with switch to new year

It looks like the timestamp is okay, but since we are running the action later in the day, on GitHub time it's already 2021! So the year is erroneously flagged as 2021. I'll fix this tomorrow, meaning:

• setting the action to run earlier in the day before it's a new day/year
• manually updating the membership counts for December

Test out ways to automate adding new member count

Assigned myself.

add mailing list link for website footer

From Kelle Cruz: Consider putting mailing list link in the Footer. Can do near the twitter and GitHub.

Package cloud expired key

It looks like our automated updated job is hitting an issue with an expired key on package cloud, or some issue that returns 402 "payment required"

This seems to generally pop up over the years when a key expires

• git-lfs/git-lfs#3474
• r-lib/actions#204

Importantly, I (think) the actions team is aware of the issue:

• actions/runner-images#1983

and it just occurred for others as well! My thinking is that we should wait and retry, and if there is no resolution in a few days see if we can also make some additional noise.

add logos to website under resources?

Should we add a logos item under the website's resources menu?

Add Newsletter

Now that we have one, we should have a place to archive past newsletters. Probably under "community" but perhaps "resources."

I can do it soon(ish).

Don’t expire jobs with working links

In #308 I removed a number of expired jobs from 2+ months ago. So it looks like clean_jobs.py isn't working correctly, or isn't being run.

map confusion

I'm confused that the link from the main site under RSE Map goes to https://us-rse.org/map/, and there is also https://us-rse.org/usrse-map/ which doesn't seem to have any way to get to from the main site.

Also as a side note, there's a dot in Pasadena, Newfoundland, Canada that should be in Pasadena, CA, USA

website URL

the website is
https://usrse.github.io/usrseweb/

can we make
https://usrse.github.io/
work too?

Add small logo to mobile navbar

UK RSE site having SSL Error

In recent clean jobs action:

HTTPSConnectionPool(host='rse.ac.uk', port=443): Max retries exceeded with url: /rse-international-leaders-meeting/ (Caused by SSLError(SSLError("bad handshake: Error([('SSL routines', 'tls_process_server_certificate', 'certificate verify failed')])")))
https://rse.ac.uk/rse-international-leaders-meeting/
HTTPSConnectionPool(host='rse.ac.uk', port=443): Max retries exceeded with url: /rse-international-leaders-meeting/ (Caused by SSLError(SSLError("bad handshake: Error([('SSL routines', 'tls_process_server_certificate', 'certificate verify failed')])")))
https://rse.ac.uk/rse-international-leaders-meeting/
HTTPSConnectionPool(host='rse.ac.uk', port=443): Max retries exceeded with url: /rse-international-leaders-meeting/ (Caused by SSLError(SSLError("bad handshake: Error([('SSL routines', 'tls_process_server_certificate', 'certificate verify failed')])")))
https://rse.ac.uk/rse-international-leaders-meeting/

to reproduce:

import requests
requests.get("https://rse.ac.uk/rse-international-leaders-meeting/")

I'll see if I can ping someone on the UK list to look into it.

Fix TravisCI scripts

The travis tests are broken and need fixing.

Update allcontributors to skip bots

Right now we would update and add manbat back in, but we don't want to do that. I'll work on this and update the action when I'm done.

Redirect for subpages

The redirect for the "April Meeting" page works for https://us-rse.org/2020-april-workshop/ but not for https://us-rse.org/2020-april-workshop/agenda/. Can a wild card be added to the redirect header:

 ---
 layout: page
 title: US-RSE Community Building Workshop
 permalink: /2020-april-workshop/*       <------ like this?
 redirect: https://us-rse.org/first-community-workshop
 ---

Or would this require all subpage-redirects to be listed individually?

staticman documentation needed for developers

Whomever configure and added static man, could you please write up docs that review:

• what staticman is
• how our site interacts with it
• how to use it / update it
  https://github.com/USRSE/usrseweb/blob/bd9f1e93bf639bdc1a9f859d5485512cd4e8c3a0/staticman.yml#L9

Events page redesign for past events

Now that PEAR19 is in the rear view mirror, we should probably decide if we want to keep old events somewhere (I think likely yes) and if so, where/how.

Hide contribution graph on small screens

@danielskatz pointed out that the contributors graph is squished on small screens:

It would be a simple solution to add css to hide it given under some number of pixels.

Renames for repository

A few things to rename:

• The link will work for a bit (GitHub redirects from old repos) but we should update it to https://us-rse.org/. I'm not able to since I don't have write to the repo.
• The travis build status link is no longer valid.

Broken link in newsletter

How should we deal with this? There is a broken link to the Cal Tech job (https://chm.tbe.taleo.net/chm03/ats/careers/v2/viewRequisition?org=CALTECH&cws=37&rid=4938) that went out with the October newsletter (https://us-rse.org/2019-10-24-newsletter/). If travis is going to check everything, this is inevitably going to happen over and over again.

Should we remove the link in the post and write something about this say, "[link removed Nov 2019: no longer valid]"?

Add dynamic graphic for membership counts

Discussed in #71

Zoom links need to be ignored

The urlchecker is failing because of an expired Zoom link. This, we should whitelist them. I’ll put in a PR in the next day or so!

Better instructions for adding calendar

I'm not sure where this is linked, but we should do a better job of sharing the calendar:

https://calendar.google.com/calendar/embed?src=kgh79lg13k1d8a2o1s6megfuhc%40group.calendar.google.com&ctz=America%2FNew_York

And then also providing enough information within the events so that people know how to participate (for example, the community call next week at 2pm has no information for how to join).
Finally, we should make it easy to add the calendar - it's not totally obvious clicking the plus in the bottom right will do that.

I'm not sure where the calendar is shared (I saw in newsletter) but we should start there!

Protect master?

I was in the web editor on github to make a small addition and I very nearly clicked commit to master. It was just a small change, and it's late so I'm barely thinking properly.
That said, is it time to protect master to force a PR and a review? To protect against people like me who tend to do things when they are tired.
I know it hasn't been an issue yet, but we are essentially already doing a PR with one review already, so it's not a major inconvenience.

date problem in graph

Lance points out that in our graph on https://us-rse.org/join/

somehow October 2019 seems to have already happened (and before Dec 2018).

rename to usrse.github.io

Doing so will serve the CNAME across the organization, for a common branding.

This will require also changing the DNS record I believe, @cosden you tried this before (and I think we needed to have the DNS changed too?) I'll assign this to you, since you know who controls the domain. And definitely no rush - it will take me a bump and a leap to get the template and then filled in instance for Stanford ready.

Update profile

Hello,
I have already joined in the past, but now my institution and location have changed. I do not see a way to update this info from the website. I only see how to join again (which I don't think should be used in this case).

Is there any other way I haven't discovered so far?

Job Postings: Add date posted and sort reverse chronologically

Looks like "date job was posted" is not currently captured in https://github.com/USRSE/usrse.github.io/blob/master/_data/jobs.yml . Would be nice to have that info and then sort reverse chronologically by that.

Thanks!

lack of consistency in website(s)

We have a website (https://us-rse.org) that has a menu bar across the top, and for most options that are selected, the menu bar doesn't change. But if you pick something under resources, you get taken to a different website with a different menu bar, where it's not really clear what website you are in - the USRSE logo in the top left makes it seem like it's the same website, but the different menu bar makes it seem like perhaps it's not. But clicking on "home" in the second one goes back to the first one, not to the home of the second one.

How does a user know what website they are in? And this changing look and feel of the menu bar seems confusing to me.

My suggestion is that we just have one consistent website, and if we need to have a second, we make the look and feel distinct enough that a user knows that they are no longer in the UR-RSE website, but something else. A home link there should not go back to the US-RSE website.

The second site right now seems to be the community blog site (https://us-rse.org/blog/), but I also think we are also almost ready to add what looks like a third site (https://us-rse.org/find-an-rse/) in #50 where it's not clear what search actually will search.

I'm very happy to further discuss this here or elsewhere

List of US RSE groups

I think it would be great to have a page with a list (and links) to the institutions/groups of existing US RSEs along with clear instructions on how to get your institution/organization/group listed.

html-proofer needs retry

There is currently no variable you can set in html-proofer to allow for a retry, and this is a huge pain point because travis is failing every other time with a URL that otherwise is fine. There are two issues to track here - the first is for the underlying library:

• typhoeus/typhoeus#182

And the second then will need to bubble up and be represented here:

• gjtorikian/html-proofer#310

I've been re-running them every time, but it's a PITA.

URL in website

Can we add the URL into the website text?

So if some does a screenshot, they can see the URL in the text...

This might be better to do after #4 once there is a simpler URL

Rename master to main

Per discussion in #246 we also want to rename master to main, and ideally GitHub (which has already announced moving forward with it) https://www.zdnet.com/article/github-to-replace-master-with-alternative-term-to-avoid-slavery-references/ will release some tooling to make this easier. I’m opening this issue to track this - and we should go for a manual approach if there is no further response from from GitHub by early fall.

Cc @danielskatz @cosden @christophernhill