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.
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.
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.
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.
Please fill out the form. Jobs are reviewed for relevance.
Fill out the form, or see the events details page on how to create an event file directly.
Further content editing tips are in the details file
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.
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:
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:
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.
When you create a PR, automated tests run; see docs/tests_ci.md for details.
What the PR submitter is responsible for:
.github/workflows/typo_config.toml
Questions? Not sure what to do or what the problem is? Ask on the #website channel on Slack.
More details can be found in:
We use the all-contributors tool to generate a contributors graphic below.