constmoon / opendataday

Open Data Day website

opendataday

Open Data Day is a gathering of citizens in cities around the world to write applications, liberate data, create visualizations and publish analyses using open public data to show support for and encourage the adoption of open data policies by the world's local, regional and national governments.

You're invited. Again. The next Open Data Day will take place on Saturday 6 March 2021.

Check http://opendataday.org for public website.

Editing / contributing

• This site is built with Lektor.
• Install dependencies: make install
• Start dev server: make serve
• grunt will watch for changes to your SCSS files, and also icons (see svgstore).
• lektor deploy will deploy to the gh-pages branch, putting changes live, if you have deploy permissions.

Translations

To translate the site we need to duplicate the contents.lr file, and save with the language code in the file name, like contents+de.lr.

We also need to add translations to:

• global-content.ini
• events-content.ini
• reports-content.ini
• main-nav.json

If we are adding new language to the site we also need to:

• Add the new language to languages.json
• Add the language to project.lektorproject

Updating the Site

Events are populated using a very lightweight import script which:

• Imports data from a google sheet
• Does some cleaning and checks on it
• Writes it out to a JSON file
• Commits it to the repo
• Builds and deploys the site

This is run in a github action with a workflow_dispatch trigger, which allows our content manager to maintain the events in a spreadsheet update the site via a button in github.

There are three bits of setup we need to do each year:

• 1. Create a new import job:
  • Create ./etl/202x.py based on a previous year's file
  • Fill in IN_URL and THIS_YEAR
  • Update schema as applicable if the spreadsheet has changed, but we want to keep the JSON output the same if possible as every year's events page uses the same template to render the JSON to HTML
  • Update https://github.com/okfn/opendataday/blob/d51d490fe15c9b02e33f0e8460cadadb636f83f6/.github/workflows/update-data.yml#L31 to run the new job
  • Once we've run the job for the first time it will create a /databags/202x.json file. This is consumed by the events list page and the events map
• 2. Update the map:
  • Update https://github.com/okfn/opendataday/blob/d51d490fe15c9b02e33f0e8460cadadb636f83f6/assets/js/map.js#L1 to consume the new JSON file
• 3. Create a new events page:
  • Create ./content/events/202x/contents.lr based on a previous year's file
  • Fill in the fields
  • Create a stub ./content/events/202x/contents.<lang>.lr for each supported alternate language
  • It is not necessary to manually create the ./content/events/202x/reports dir or edit any content under it. This will be automatically generated by the import job.
  • Add the new 202x events page to the menu:
    • Add /events/202x to the list of events pages.
    • Update the 'Search events' link to the current year
    • Repeat for each supported alternate language

Previous version

The previous version of the site has been moved to the v1 branch.