Skip to content

How do we create our own NRP

brockfanning edited this page Jan 26, 2018 · 2 revisions

There are four basic steps.

A) Start with GitHub.

  1. Go to github.com and create an account.
  2. Learn the basics of GitHub. Try this introductory webinar and these resources.
  3. Set up your GitHub organization and identify relevant users of your IT team. Register your organization with GitHub if not already registered. IT team members should set up their own GitHub accounts.

Tip: Within a GitHub organization, you can define ‘teams.’ This can be a useful way to identify users who are part of the project, improve communication among team members, and set specific permissions. See this guide to learn more.

B) Decide which platform to start with

Decide whether to fork the US platform or another version, such as the UK platform. To inform this decision here is a helpful comparison.

If you decide to start with a platform other than the US platform, you should stop here and visit the other platform for specialized instructions. For example, if using the UK platform, follow the instructions here.

If you decide to start with the US platform, read on.

C) Fork the repository

These steps will set up your organization's separate version of the NRP code.

  1. Log into Github.com
  2. Go to the repository
  3. Click the "Fork" button in the upper right
  4. When asked where to fork, chose your organization account (not your personal account)
  5. When the forking is complete, you should be on this page: https://github.com/[your organization]/sdg-indicators

D) Trigger a build of "Github Pages"

In order to turn the code into a website that can be visited in a browser, you simply need to edit any file.

  1. In the list of files, click on _translations and then header.md.
  2. Click the pencil icon in the upper right.
  3. Under "en" (the English translations) change the "site-title" from "U.S. Indicators For The Sustainable Development Goals" to whatever you would like.
  4. Scroll all the way to the bottom and click "Commit changes".
  5. This triggers of a build of your platform in Github Pages.
  6. Visit the built platform now in a browser at https://[your-organization].github.io/sdg-indicators

E) Customize the platform

There are several places in the code where you may want to tweak the settings for your purposes. Here is a list of files and settings to change. None of these are required, but these are all places where the code is specific to the U.S. version of this platform.

  • _config.yml, _config_prod.yml, and _config_staging.yml: You can update these settings:
    • title
    • org_name
    • ga_prod (for Google Analytics)
  • _translations: You can update the language in all files in this folder. (See below for more on translations.)
  • _includes/footer.html: You can update the Google Analytics section here.
  • assets/img/favicons: You can update these images according to your own branding.

F) Remove the U.S. statistics and metadata from the repository

The US NRP currently houses both the platform code and the SDG statistics and metadata in the same repository (in the data folder). This means that forking the US NRP will copy both the functionality of the platform as well as the US data. Therefore, countries will want to remove the US statistics and metadata from their copy of the US NRP and replace it with their own data (see below).

Scripted solutions for this task, which will replace the US data with example data, are planned for future releases.

Clone this wiki locally