|
1 | 1 | # AdaptiveExperiments.github.io |
2 | 2 | Code for Adaptive Experiments Website |
| 3 | +## EASI |
| 4 | + |
| 5 | + |
| 6 | +This is the repository containing the webpages for the EASI project. |
| 7 | + |
| 8 | +### Contributing |
| 9 | + |
| 10 | +The EASI website encourages community contributions consistent with our goals and code of conduct. |
| 11 | + |
| 12 | +To suggest a change, fork the repository and make your proposed changes. |
| 13 | +Then test locally (see below) to ensure your changes are behaving as anticipated. |
| 14 | +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. |
| 15 | +After previewing and confirming things look good create a pull request against `gh-pages`. |
| 16 | + |
| 17 | +### Adding a Training Links |
| 18 | + |
| 19 | +Links to exiting training material can be added with an entry to _data/training.yml. |
| 20 | +Each entry must have at a minimum |
| 21 | +```yml |
| 22 | + name: The title of the talk/tutorial |
| 23 | + url: url with direct link to the material |
| 24 | +``` |
| 25 | +Where possible each entry should also include: |
| 26 | +```yml |
| 27 | +author: Name of the author(s) of the material |
| 28 | +location: Event where training was given |
| 29 | +location_url: url of event where training was given |
| 30 | +date: Date or training event {CI, Collaboration, Git, Licensing, Packaging, Performance, Reproducibility} |
| 31 | +description: A 2-3 sentence description of the material |
| 32 | +tags: A list of categorical tags for training topics. Comma separated list contained in {} |
| 33 | + e.g {CI, Collaboration, Git, Licensing, Packaging, Performance, Reproducibility} |
| 34 | + These are currently used to sort the entries on the /training-links page. |
| 35 | + The tags are case sensitive. |
| 36 | +``` |
| 37 | +#### Adding authorship |
| 38 | +
|
| 39 | +Posts should include the `author:` field using the name defined by an entry in the '_data/authors.yml' |
| 40 | + |
| 41 | +#### Build and Preview locally |
| 42 | + |
| 43 | +To build and preview the site locally, you'll need to [install jekyll](https://jekyllrb.com/docs/installation/) |
| 44 | +It's then typical to go to the root directory of the site and issue (just once): |
| 45 | + |
| 46 | +```bash |
| 47 | +$ bundle install |
| 48 | +``` |
| 49 | + |
| 50 | +And then (also in the top level directory of your forked repository) run |
| 51 | + |
| 52 | +```bash |
| 53 | +$ jekyll serve --config _config.yml,_config_dev.yml |
| 54 | +# or |
| 55 | +$ bundle exec jekyll serve --config _config.yml,_config_dev.yml |
| 56 | +``` |
| 57 | + |
| 58 | +and open your browser to <http://localhost:4000>. |
| 59 | +Note the |
| 60 | +`--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. |
| 61 | + |
| 62 | +#### Troubleshooting local previews |
| 63 | +If you are having trouble with your local preview try `rm -rf _site`, followed by `bundle update`, then `bundle exec jekyll serve`. |
| 64 | + |
| 65 | +## Funding |
| 66 | +This project is supported by National Science Foundation awards [2209821](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2209821&HistoricalAwards=false). 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. |
| 67 | + |
| 68 | + |
| 69 | + |
| 70 | + |
| 71 | +### Contacts |
| 72 | +Jeffrey Carver, University of Alabama |
| 73 | + |
| 74 | + |
0 commit comments