Skip to content

Commit

Permalink
Document where & how this site is used
Browse files Browse the repository at this point in the history
  • Loading branch information
PeterJCLaw committed Mar 18, 2024
1 parent 540dd0c commit 5d56e14
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,18 @@ SRComp-HTTP instance separately.

1. View the site at <http://localhost:4000/competition-website/comp/>

## Deployment

The site defined in this repo is deployed onto GitHub Pages (using GitHub
Actions) and surfaced at <https://studentrobotics.org/comp/>.

During competition events the main page is also used as a takeover of our
website homepage. This is toggled via `enable_competition_homepage` in our
[ansible][srobo-ansible] config.


[SR]: https://studentrobotics.org
[srcomp]: https://github.com/PeterJCLaw/srcomp/wiki
[install-ruby]: https://www.ruby-lang.org/en/documentation/installation/
[clone-repo]: https://docs.github.com/en/repositories/creating-and-managing-repositories/cloning-a-repository
[srobo-ansible]: https://github.com/srobo/ansible/

0 comments on commit 5d56e14

Please sign in to comment.