hamasoasis / adaptexp.github.io

Code for Adaptive Experiments Website

AdaptiveExperiments.github.io

Code for Adaptive Experiments Website

EASI

This is the repository containing the webpages for the EASI project.

Contributing

The EASI website encourages community contributions consistent with our goals and code of conduct.

To suggest a change, fork the repository and make your proposed changes. Then test locally (see below) to ensure your changes are behaving as anticipated. If it's a very minor change (a typo, one line addition) a local preview may not be necessary, but for all other modifications, it's strongly encouraged to test locally before submitting a pull request. After previewing and confirming things look good create a pull request against gh-pages.

Adding a Training Links

Links to exiting training material can be added with an entry to _data/training.yml. Each entry must have at a minimum

  name: The title of the talk/tutorial
  url: url with direct link to the material

Where possible each entry should also include:

author: Name of the author(s) of the material
location: Event where training was given
location_url: url of event where training was given
date: Date or training event {CI, Collaboration, Git, Licensing, Packaging, Performance, Reproducibility}
description: A 2-3 sentence description of the material
tags: A list of categorical tags for training topics. Comma separated list contained in {}
      e.g {CI, Collaboration, Git, Licensing, Packaging, Performance, Reproducibility}
      These are currently used to sort the entries on the /training-links page.
      The tags are case sensitive. 

Adding authorship

Posts should include the author: field using the name defined by an entry in the '_data/authors.yml'

Build and Preview locally

To build and preview the site locally, you'll need to install jekyll It's then typical to go to the root directory of the site and issue (just once):

$ bundle install

And then (also in the top level directory of your forked repository) run

$ jekyll serve --config _config.yml,_config_dev.yml
# or
$ bundle exec jekyll serve --config _config.yml,_config_dev.yml

and open your browser to http://localhost:4000. Note the --config _config.yml,_config_dev.yml enables easy local previewing by using the _config_dev.yml file to replace certain values in _config.yml, avoiding the need to make local changes.

Troubleshooting local previews

If you are having trouble with your local preview try rm -rf _site, followed by bundle update, then bundle exec jekyll serve.

Funding

This project is supported by National Science Foundation awards 2209821. Any opinions, findings, conclusions or recommendations expressed in this material are those of the developers and do not necessarily reflect the views of the National Science Foundation.

Contact

Jeffrey Carver, University of Alabama