This is a static site built to house documents for the UK Democracy Sector. It is based on the documentation site for OpenDLP. More complete documentation can be found there.
The site is built with Hugo and uses a custom theme styled after the GOV.UK Design System with Sortition Foundation branding.
When fully configured the site will be live at https://sortitionfoundation.github.io/democracy-sector
The source code can be found at https://github.com/sortitionfoundation/democracy-sector
Whenever you edit the site there are GitHub Actions that will rebuild the site and publish it.
Go to /admin/ on the live site - [direct link](fill this in) and click the "sign in with github" link. Once you've done that, you can edit in the browser and click "save". Around 30 seconds later your edit will be live on the site.
Prerequisites:
- You need an account on https://github.com/ - if you don't have one, create an account here.
- One of the technical team needs to allow you to edit this git repo. For the technical team, you can manage access here.
Editing
- Go to
/admin/on the live site - [direct link](fill this in) click the "sign in with github" link. - Edit in the browser and click "save".
- Around 30 seconds later your edit will be live on the site.
What happens when you edit? You don't need to know this but for interest:
- The admin page running in your browser adds a git commit to the github repo.
- That triggers a process that rebuilds the site with your edits and then copies it to the live site.
- You can then reload the updated site in your browser.
You need to install hugo and install just.
Then you can build the site with just build and you can open public/index.html in your web browser.
If you want live updates in your web browser while you edit and save the local files, you can run just serve and then open http://localhost:1313/ in your web browser.
If you add a new folder under content/ and want to be able to edit the files in the browser, you'll need to add to the Sveltia CMS config. Detailed instructions are in AGENTS.md - under "Adding a new section folder to the CMS" - so you can just ask your agent to do that for you.
Live deployment is a little complicated - we have full deployment docs in this repo.