This is a build system for credibilitycoalition.org

This environment uses Jekyll with Contentful. It uses Contentful's Jekyll-Contentful-Data-Import plugin. See the readme on the repository page to learn how to configure data import.

Quick start

1. Install Ruby 2.x (eg with rvm)
2. bundle install or bundle install --path vendor/bundle to install all the packages. If this fails and you get An error occurred while installing idn-ruby (0.1.0), and Bundler cannot continue., you may need to install libidn.
3. Add Contentful Space and Access Token variables to your shell's configuration file (.bashrc or .bash_profile):

export CONTENTFUL_CC_SPACE_ID=abc123
export CONTENTFUL_CC_ACCESS_TOKEN=abc123
export CONTENTFUL_API_URL="cdn.contentful.com"

Variables are set in the contentful section of _config.yml. Get your Contentful space id and access token using the Contentful web app. Open the space that you want to access (the top left corner lists all spaces), and navigate to the Settings > API keys. Select the API keys option and there should be an existing API key under Microsite for Popup.news.

And run source ~/.bashrc or open new terminal to enable changes.

4. bundle exec jekyll contentful --rebuild to build the site by fetching content from Contentful
5. bundle exec jekyll serve to serve the site at http://127.0.0.1:4000
6. Edit .scss, .html and .js files. The browser should live-reload.

Page Generation from Contentful Data

To generate pages in Jekyll based on Contentful data we are using the jekyll-datapage_gen plugin. Specify in _config.yml the data files for which you want individual page to be generated. See plugin's documentation and our config.yml for the settings.

All pages are generated using the page layout template based on the entries in pages.yaml that were imported from Contentful.

Deploy settings on Netlify

credibilitycoalition.org is deployed on Netlify. Adding a website on Netlify is super easy. All these settings are under Build & Deploy section of Netlify's web app. Here are the main steps:

1. Select which Github repository and branch to deploy.
2. Specify this build command: CONTENTFUL_ENVIRONMENT=master bundle exec jekyll contentful --rebuild
3. Add build environment variables CONTENTFUL_CC_SPACE_ID and CONTENTFUL_CC_ACCESS_TOKEN. CONTENTFUL_ENVIRONMENT is specified with the build command so no need to add it as an environment variable.
4. Add build hooks for Contentful's master and develop environment. Get the webhook urls using the Contentful web app. Open the space and navigate to the Settings > Webhooks. You will see two webhooks already setup. See their details to copy the url or adjust what triggers it. See Contentful's Intro to webhooks to learn more.
5. To configure custom build command for deploying changes made to the Develop environment in Contentful, use Netlify's Deploy Contexts to specify the build command in a netlify.toml file. To deploy develop use this build command: CONTENTFUL_ENVIRONMENT=develop bundle exec jekyll contentful --rebuild

See Continuous Deployment on Netlify docs to learn more.

CredCatalog

CredCatalog is a database of credibility initiatives stored on Airtable. Assuming you have access to the correct database there, you first need to download the tables locally before building the site. Here's how:

• Download tables Initiatives, Organizations, Scale Options and Funders/Sponsors as CSV.
• Run each CSV through the supplied script _scripts/csv2json.rb, sending the JSON output to _data/credcatalog as per the existing filenames.