Skip to content
International reversionary rights resources site.
HTML Ruby CSS Shell
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github
jekyll
scripts
.cc-metadata.yml
.gitignore
CODE_OF_CONDUCT.md
CONTRIBUTING.md
LICENSE
README.md

README.md

Workflow

  1. Gather information via Google Forms.
  2. Review and copy-edit that information in Google Sheets.
  3. Update the data in jekyll/_data by running ./scripts/overwrite-data.sh .
  4. Commit the resulting changes to git, e.g. git commit -a -m "Latest changes" . Then push them, e.g. git push origin master .
  5. On the server, fetch the latest changes using git pull.
  6. Build the site and copy it into place by running ./scripts/build.sh . This will ask for your password in order to run sudo when copying the built files into position.

When working with countries, make sure to use the same name for the country in all the spreadsheets. For the purposes of this project, a "Country" is something that is named in http://jvectormap.com/maps/world/world , mentioned below. This means that (for example) we must use "United Kingdom" rather than "Scotland" or "Wales". Where "Jurisdiction" is an option this can be used to more accurately describe the resource's origin. I (RobM) apologize for this.

Spreadsheets

There are three sets of spreadsheets

Google Form Results

These are the results of people completing the Google Forms. Pay special attention to whether the contributor has selected the option to receive credit or not

Google Sheets

These are the Google sheets that details are copied to from the Results spreadsheets and given editorial attention on.

Do not copy the contributor's name into these if they have not selected the option to receive credit.

To export data from these sheets, run ./scripts/overwrite-data.sh as described above.

CSV Documents in _data

These are the CSV (Comma Separated Values) format spreadsheets in jekyll/_data that we use to build the pages.

Apart from countries.csv, do not edit the content of these files, rather edit the Google Sheets then export them and copy them into position.

countries.csv

jekyll/data/countries.csv

The list of countries we have data for. If a country is not listed here, its data will not be used.

code

The uppercase two-letter code for the country (ISO 3166-1 alpha-2). See http://jvectormap.com/maps/world/world/ .

country

The name of the country. This should be in English. See http://jvectormap.com/maps/world/world/ .

notes

Optional text to be included in the country page.

Used Software

https://jekyllrb.com/

https://github.com/avillafiorita/jekyll-datapage_gen

http://jvectormap.com/

You can’t perform that action at this time.