Creates a static website of Case Law and Scholarship data from around the world based on Google Form responses and manually curated:
Please note that this project is released with a Contributor Code of Conduct
(CODE_OF_CONDUCT.md). By participating in this
project you agree to abide by its terms.
- Gather information via Google Forms.
- Copy new responses from Form Responses Google Sheets to the Caselaw - Primary Data Google Sheet
- Review and copy-edit the new responses in the Caselaw - Primary Data Google Sheet
- Update the Repository CSVs - Generated CSVs by running:
./scripts/overwrite-data.sh
- Commit and push the resulting changes. For example:
git commit -a -m 'Latest changes' git push origin master- Please use a more detailed/specific commit message
- On the hosting server, pull the latest changes into your clone repository.
- On the hosting server, build the site and copy it into place by running:
./scripts/build.sh
- (The script will ask for your password in order to run
sudowhen copying the built files into position.)
- (The script will ask for your password in order to run
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 World - jVectorMap. This means that, for example, we must use "United Kingdom" rather than "Scotland" or "Wales".
"Jurisdiction" is an option this can be used to more accurately describe th resource's origin. I (RobM) apologize for this.
Generated CSVs:
Notes:
- These are the CSV (Comma Separated Values) format spreadsheets that are used to build the site pages.
- Do not edit the content of these files. Instead:
- Edit the Caselaw - Primary Data - Google Sheet
- Run
./scripts/overwrite-data.sh
Google Sheet:
Notes:
- This is the Google sheet that details are copied to from the Results spreadsheets and given editorial attention on.
- There are two sheets: CASES and SCHOLARSHIP
- Do not copy the contributor's name into these if they have not selected the option to receive credit.
- When a given entry is ready to be published, set the value of the "Publish" column to "Publish" for it. Otherwise leave it blank or set it to "N".
- The Sheet ID is
1Z9IcBgdDYoeZw0Xx573ZMp5JcJDCNhOUHrj0guU9byo. If this changes, update theSHEET_IDin./scripts/overwrite-data.sh.
Google Sheets:
- Caselaw - Cases Form Responses (for copying from, do not edit; Restricted Access)
- Caselaw - Scholarship Form Responses (for copying from, do not edit; Restricted Access)
Notes:
- These Google Sheets 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
Manually Managed CSV:
Notes:
- This is the list of countries we have data for. If a country is not listed here, its data will not be used.
codecolumn contains the uppercase two-letter code for the country (ISO 3166-1 alpha-2). See World - jVectorMap.countrycolumn contains the name of the country in English. It must be from World - jVectorMapnotescolumn contains optional text to be included in the country page.
Error text:
caselaw/jekyll/_plugins/data_page_generator.rb:45:in `eval': undefined method `tr' for nil:NilClass (NoMethodError)
You have probably missed out the 'Country' entry for one of the rows in the spreadsheet.
This error indicates that a value being used in a dir: entry for page_gen:
in _config_yml cannot be found. As we use data["Country"] in these, if it
cannot be found this will fail.
- Jekyll • Simple, blog-aware, static sites | Transform your plain text into static websites and blogs
- avillafiorita/jekyll-datapage_gen: Generate one page per yaml record in Jekyll sites.
- jVectorMap
The following potential work has been identified:
- Remove the Caselaw - Primary Data Google Sheet cut and paste process. Instead manipulate the data in the Google Form Responses Google Sheets.
- Schedule updates so that a tech person does not need to be wrangled to apply them.