Skip to content

Commit

Permalink
readme improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
ptheywood authored Sep 26, 2024
1 parent 57c82fa commit 36d4f8a
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@ GH pages repositories can only serve content to a single subdomain.

This repository enables the RSE website [RSE-Sheffield/RSE-Sheffield.github.io](https://github.com/RSE-Sheffield/RSE-Sheffield.github.io) to be served at both [rse.shef.ac.uk](https://rse.shef.ac.uk) **and** [rse.sheffield.ac.uk](https://rse.sheffield.ac.uk).

The CI workflow `.github/workflows/mirror.yaml` clones [RSE-Sheffield/RSE-Sheffield.github.io](https://github.com/RSE-Sheffield/RSE-Sheffield.github.io), builds the gh-pages gem and and deploys the website to github pages, in this case pointed at `rse.sheffield.ac.uk`, while the website repository deploys to `rse.shef.ac.uk`.
The CI workflow `.github/workflows/mirror.yaml` clones [RSE-Sheffield/RSE-Sheffield.github.io](https://github.com/RSE-Sheffield/RSE-Sheffield.github.io), installs dependencies, builds the [RSE-Sheffield/RSE-Sheffield.github.io](https://github.com/RSE-Sheffield/RSE-Sheffield.github.io) jekkyll website and deploys it to github pages, in this case pointed at `rse.sheffield.ac.uk`, while the website repository deploys to `rse.shef.ac.uk`.

Deployment is triggered by a workflow_dispatch event from the `publish.yaml` workflow in [RSE-Sheffield/RSE-Sheffield.github.io](https://github.com/RSE-Sheffield/RSE-Sheffield.github.io), when a valid PAT exists.
It can also be triggered by pushes to `master` on this repository, or by an authorised user manually triggering the workflow via a `workflow_dispatch`.
Deployment is triggered by a `workflow_dispatch` event from the `publish.yaml` workflow in [RSE-Sheffield/RSE-Sheffield.github.io](https://github.com/RSE-Sheffield/RSE-Sheffield.github.io), when a valid PAT exists.
It can also be triggered by pushes to `master` on this repository, or by an authorised user manually triggering the workflow via a `workflow_dispatch` event.

## GitHub settings

Expand Down

0 comments on commit 36d4f8a

Please sign in to comment.