Skip to content

sortitionfoundation/opendlp-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

21 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

OpenDLP Docs

Project Overview

This is the documentation site for OpenDLP (Open Democratic Lottery Platform), an open-source tool for running Citizens' Assemblies and democratic lotteries, built by the Sortition Foundation.

The site is built with Hugo and uses a custom theme styled after the GOV.UK Design System with Sortition Foundation branding.

OpenDLP Docs

The site is live at https://docs.gh.sortitionlab.org

The source code can be found at https://github.com/sortitionfoundation/opendlp-docs

Whenever you edit the site there are GitHub Actions that will rebuild the site and publish it.

Editing for most people

Quick version

Go to /admin/ on the live site - direct link 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.

Longer version

Prerequisites:

Editing

  • Go to /admin/ on the live site - direct link 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.

Editing and Developing locally

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.

Deployment

Live deployment is a little complicated - we have full deployment docs in this repo.

About

Docs static site for the OpenDLP repo

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors