Upgrading to 2.2.0

This document is intended for developers, to help with the process of upgrading to version 2.2.0 of Open SDG, from 2.1.0 or higher.

Upgrade data repository to sdg-build 2.2.0¶

In your data repository, update your requirements.txt file to:

git+https://github.com/open-sdg/sdg-build@2.2.0

Upgrade translations to sdg-translations 2.2.0¶

In your data repository's config file, update the version of sdg-translations in the "translations" section:

translations:
  - class: TranslationInputSdgTranslations
    source: https://github.com/open-sdg/sdg-translations.git
    tag: 2.2.0

Update version of Open SDG to 2.2.0¶

In your site repository's _config.yml file, update the version of Open SDG in remote_theme, like so:

remote_theme: open-sdg/open-sdg@2.2.0

Update version of jekyll-open-sdg-plugins to 2.2.0¶

In your site repository's Gemfile, update the version of jekyll-open-sdg-plugins like so:

gem "jekyll-open-sdg-plugins", "2.2.0"

Updating overridden files¶

If you are overriding certain files, you may need to adjust your version in order to benefit from the latest features, bugfixes, and design changes. If you are unsure, check the _includes and _layouts folders in your site repository. If they contain any of the following files, you may want to incorporate the latest changes into your overrides. The links below will show you the latest changes for each file.

• _includes/assets/js/indicatorInit.js
• _includes/assets/js/indicatorModel.js
• _includes/assets/js/indicatorView.js
• _includes/assets/js/mapView.js
• _includes/assets/js/plugins/jquery.sdgMap.js
• _includes/assets/js/plugins/leaflet.disaggregationControls.js
• _includes/assets/js/view/chartHelpers.js
• _includes/assets/js/view/constants.js
• _includes/assets/js/view/helpers.js
• _includes/assets/js/view/seriesHelpers.js
• _includes/assets/js/view/tableHelpers.js
• _includes/components/charts/chart.html
• _includes/components/goal/goal-content.html
• _includes/components/goal/header.html
• _includes/components/indicator/indicator-main.html
• _includes/components/indicator/series-template.html
• _includes/components/reportingstatus/reporting-status-label.html
• _includes/components/reportingstatus/reporting-status-overall.html
• _includes/head.html
• _includes/javascript-variables.html
• _includes/polyfills.html
• _includes/title-tag.html
• _layouts/data-editor.html
• _layouts/indicator.html
• _layouts/reportingstatus.html

Note that we strive to avoid any breaking changes, so this process of updating overridden files is optional. However we strongly recommend keeping your overridden files as current as possible.

New features¶

This release introduces some optional features that you may be interested in adding to your platform.

Proxy¶

Open SDG now has the functionality to mark indicator data as “proxy” data with a label and definition, meaning that it is somehow different than the expected UN global indicator.

To set an entire indicator to be a "proxy", this line is needed in each indicator configuration file in the metadata section on indicator pages:

proxy: proxy

If your data has multiple series and not all of them are proxies, this is needed instead, to define which series are proxies (for example):

proxy: both
proxy_series:
  - my first proxy series
  - my other proxy series

To change the text that appears for the proxy description as default, add this to the site_config.yml file in your site repository to customise the description text. Note: you will need to update the translation for this if you use any other languages on the site.

proxy_indicators:
  label: Proxy
  description: My alternate proxy description