Quick start guide

Welcome to the documentation for opendata.scot!

This page is intended to point you to the information that matters most to you, dependent on whether you're coming to Open Data Scotland as an Analyst, Data Engineer or Web Developer.

Analyst

• See the opendata.scot dataset listing in json format
• Discover stories about visitor behaviour on opendata.scot by looking at our site analytics data output or in browser version
• Browse inspiring examples of other projects using open data both in Scotland and abroad
• Reference guides for working with Scottish open data
• As an analyst, you might not need to store to any of the repos, but have a look at what stories have made it to the website, and the ideas which haven't quite made it there yet. Any shared analytics code can be stored in repo the_od_bods/analytics
• Analysts will be most interested in tickets related to analytics

Data Engineer

• Learn about our pipeline architecture and the tools and tech we use in the pipeline
• Understand how the repos are used
• For data engineering, the three most important repos used in the pipeline are
  • the-od-bods for scaping and sourcing
  • opendata.scot_pipeline repo where the scheduled pipeline actions are, and
  • JKAN for output display.
• Data Engineers will be most interested in tickets related to adding new data sources or data engineering

Web Developer

• The most important repo for the web developer is the JKAN repo where all code for the static site is kept.
• Read this guide on how to deploy the front-end for testing locally
• Web developers will be most interested in tickets related to JKAN or front end

Other

• Read about the project, its history, what it's trying to do, what it's achieved, and where it's headed in the About section

• Browse the Contribute section for step-by-step guides on how to run the project locally and other repeating tasks we keep forgetting.

If you have any questions, feedback or general comments, definitely contact the team