Research Software Alliance Website

This repository contains the source files that generates the Research Software Alliance website. The repository is monitored by Netlify, which generates and hosts the live website. All content files are written in Markdown and are processed into HTML by Netlify.

Editing content

Using VS Code (or any suitable Integrated Development Environment (IDE))

• You can clone a local copy of this repository using:

git clone https://github.com/researchsoft/website.git

• Change to the 'website' directory:

cd website

• Create a branch OR switch to an existing branch that you want to work on:

git checkout -b new_branch_name # if you want to create a new branch
git checkout existing_branch_name # if you want to switch to an existing branch

• Make the necessary changes and stage them using:

git add --all # if you want to stage all the modified files
git add path_to_file # if you want to stage any specific modified file. 
# To find the path to files that are modified use `git status`

• Commit the staged changes using:

git commit -m ":tada: an informative commit message"

• Finally push your committed changes:

git push --set-upstream origin new_branch_name # if pushing for the first time 
# to a new branch
git push # if pushing to an existing branch

• Create a Pull Request (PR) on GitHub repo and direct it to the dev branch from your branch. Tag any relevant issue(s), add relevant label(s), and request reviews where required.

Using GitHub text editor interface

The only files that should be edited as a matter of course are in content. Images generally go into static/images.

When editing existing content, it is possible to use the GitHub text editor interface to make changes. When viewing the file you would like to edit, click the Edit button to make your changes. If you do not have permissions for the repository directly, you will need to submit a pull request for an administrator to adopt the changes.

Editing CSS

In order to add SASS or CSS rules, add them into assets/scss/custom.scss. This is compiled into wowchemy.css in the head.

Extra information

Due to limitations in the version of Hugo that Netlify runs, changing the style of the website will require pulling this entire repo to a computer and building the site with hugo-extended. The resulting files generated in resources/_gen/assets/scss/styles then need to be committed back to the repository.

Adding ORCID Support to Blog Post Authors

The Atom feed supports ORCID identifiers for authors. ORCIDs are rendered as <uri> elements in the feed, which is the standard for Rogue Scholar and other scholarly aggregators.

Two Formats Supported

Format 1: Simple Strings (No ORCIDs)

authors:
  - Michelle Barker
  - Daniel S. Katz

Renders as:

<author>
  <name>Michelle Barker</name>
</author>
<author>
  <name>Daniel S. Katz</name>
</author>

Format 2: Objects with ORCIDs (Recommended for Scholarly Feeds)

authors:
  - name: Michelle Barker
    orcid: https://orcid.org/0000-0002-3623-172X
  - name: Daniel S. Katz
    orcid: https://orcid.org/0000-0001-5934-7525
  - name: Kim Hartley
    # No ORCID - still works

Renders as:

<author>
  <name>Michelle Barker</name>
  <uri>https://orcid.org/0000-0002-3623-172X</uri>
</author>
<author>
  <name>Daniel S. Katz</name>
  <uri>https://orcid.org/0000-0001-5934-7525</uri>
</author>
<author>
  <name>Kim Hartley</name>
</author>

ORCID Lookup

To find ORCIDs for authors:

1. Visit https://orcid.org/
2. Search for the author's name
3. Copy the full ORCID URL (e.g., https://orcid.org/0000-0001-2345-6789)

Migration Path

You can update posts gradually:

1. Keep existing posts with simple string authors
2. Add ORCID data to new posts using the object format
3. Gradually update older posts as needed

The template supports both formats simultaneously.

Testing

After updating a post with ORCIDs:

1. Rebuild: hugo
2. Check feed: grep -A10 "PostTitle" public/index.xml | grep -E "<author>|<name>|<uri>"
3. Validate at: https://validator.w3.org/feed/