Quick Start

This document will go over the quickest way to get this platform up and running. Here we will choose the simplest approach for automation and hosting, which is to use GitHub. Note, however, that there are alternatives to this approach, as detailed under the Automation and Hosting sections.

Need a quicker quick start?

This document recommends a double-repository approach, which separates your platform into a "site repository" and a "data repository". This is a good practice in general, and provides several logistical benefits. However, a simpler single-repository approach may be preferred if you just want to try out Open SDG locally. In this case, see the open-sdg-simple-starter project.

Signing up and creating repositories

  1. If you don't already have a Github.com account, go to Github.com to sign up and then log in.
  2. Go to the site starter and click the green "Use this template" button.
  3. Next you will be prompted to choose a name for your new repository. This will affect the URL at which you access the site later, so choose carefully. A suggestion might be: sdg-site-australia (adjusted for your country). Note that you can change this later if needed.
  4. Enter a description if you would like. Leave "Public" selected, check the "Include all branches" box, and click "Create repository from template".
    • Bookmark the created repository -- this is your "site repository".
  5. Go to the data starter and click the green "Use this template" button.
  6. As before, choose a name. This one should refer to "data" instead of "site" (eg, sdg-data-australia). As before, leave "Public" selected, check the "Include all branches" box, and click "Create repository from template".
    • Bookmark the created repository -- this is your "data repository".

Update the data repository configuration

This step is necessary before continuing, and also serves to demonstrate how to edit files on Github.com.

  1. Go to the data repository.
  2. In the list of files, click on config_data.yml.
  3. Click the pencil icon on the right (You can find it next to the "Raw" and "Blame" buttons.)
  4. Add a new line at the top: # This is a comment
  5. Towards the bottom, select "Create a new branch for this commit and start a pull request."
  6. Beneath this, click "Propose changes".
  7. Click on the green "Create pull request" button.
  8. Wait a moment to see the message that says "Test PRs / test (pull_request) - in progress"
  9. Wait until you see "All checks have passed". This takes about 5 minutes.
  10. Click on the green "Merge pull request" button.

Update the site repository configuration

  1. Go to the site repository.
  2. In the list of files, click on _config.yml.
  3. Click the pencil icon on the right (You can find it next to the "Raw" and "Blame" buttons.)
  4. Update the baseurl (line 8) according to the instructions above it. Note that the instructions refer to your site repository.
  5. Update the remote_data_prefix (line 12) according to the instruction above it. Note that the instructions refer to your data repository.
  6. Update the data_edit_url and metadata_edit_url (lines 16 and 18) according to the instructions above them.
  7. Towards the bottom, select "Create a new branch for this commit and start a pull request."
  8. Beneath this, click "Propose changes".
  9. Click on the green "Create pull request" button.
  10. Wait a moment to see the message that says "Test PRs / test (pull_request) - in progress"
  11. Wait until you see "All checks have passed". This takes about 5 minutes.
  12. Click on the green "Merge pull request" button.

View the site

  1. GitHub will now build and publish the site. Wait about 5 minutes.
  2. Go to the site repository.
  3. Under the repository name, click "Settings".
  4. Scroll down to the "GitHub Pages" section.
  5. You should see "Your site is published at" next to a link.
  6. Click that link to view your site.

Next steps

To get started with customising your implementation of Open SDG, try any of these tutorials:

  1. Changing the logo and favicon
  2. Frontpage configuration
  3. Adding indicators
  4. Adding languages
  5. Changing colors
  6. Changing the site-wide banner

Maintenance

To help with maintenance of your implementation, the following automation is recommended:

  1. Protection from breaking changes
  2. Triggered site builds

Troubleshooting

If this did not appear to work, please consult the troubleshooting page.