Skip to content

Commit 0151c81

Browse files
JeffCarverJeffCarver
authored
Merge pull request #1 from hamasoasis/dev
Change in README file
2 parents 3b6bb1a + ece1e63 commit 0151c81

518 files changed

Lines changed: 107740 additions & 2 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎.circleci/circle_urls.sh‎

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
REPO_ID=$(curl https://api.github.com/repos/${CIRCLE_PROJECT_USERNAME}/${CIRCLE_PROJECT_REPONAME} | jq --raw-output '.id')
2+
echo "Repo ID is ${REPO_ID}"
3+
4+
URL=https://output.circle-artifacts.com/output/job/${CIRCLE_WORKFLOW_JOB_ID}/artifacts/${CIRCLE_NODE_INDEX}
5+
BASEURL=/intersect-training.github.io
6+
IMGURL=${URL}${BASEURL}/images/
7+
8+
echo "URL is ${URL}"
9+
10+
sed -i "35 s,.*,baseurl: $BASEURL,g" "_config.yml"
11+
sed -i "48 s,.*,urlimg: $IMGURL,g" "_config.yml"
12+
sed -i "34 s,.*,url: $URL,g" "_config.yml"

‎.circleci/config.yml‎

Lines changed: 79 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,79 @@
1+
version: 2.1
2+
3+
workflows:
4+
version: 2
5+
6+
# The build workflow will build a preview for the site, intended for PRs
7+
# don't need to build gh-pages only other branches
8+
build:
9+
jobs:
10+
- build-site:
11+
filters:
12+
branches:
13+
ignore: gh-pages
14+
15+
install: &install
16+
name: install dependencies for build
17+
command: |
18+
$HOME/conda/bin/pip install -r ~/repo/.circleci/requirements.txt
19+
install_python_3: &install_python_3
20+
name: install Python 3.5 dependencies
21+
command: |
22+
ls $HOME
23+
if [ ! -d "/home/circleci/conda" ]; then
24+
wget https://repo.continuum.io/miniconda/Miniconda3-latest-Linux-x86_64.sh
25+
/bin/bash Miniconda3-latest-Linux-x86_64.sh -b -p $HOME/conda
26+
export PATH=$HOME/conda/bin:$PATH
27+
else
28+
echo "Miniconda 3 is already installed, continuing to build."
29+
fi
30+
build_jekyll: &build_jekyll
31+
name: Jekyll Build
32+
command: |
33+
if [ -z "$CIRCLECI_TRIGGER" ]; then
34+
echo "Building EASI Site for Preview"
35+
cp ~/repo/.circleci/circle_urls.sh ~/repo/circle_urls.sh
36+
cd ~/repo
37+
chmod u+x circle_urls.sh
38+
bash circle_urls.sh
39+
cat _config.yml
40+
bundle install
41+
bundle exec jekyll build
42+
else
43+
echo "Triggered by something else."
44+
fi
45+
jobs:
46+
build-site:
47+
docker:
48+
- image: cimg/ruby:3.1
49+
working_directory: ~/repo
50+
environment:
51+
- JEKYLL_ENV: production
52+
- NOKOGIRI_USE_SYSTEM_LIBRARIES: true
53+
- BUNDLE_PATH: ~/repo/vendor/bundle
54+
steps:
55+
- checkout
56+
- restore_cache:
57+
keys:
58+
- v1-dependencies
59+
- rubygems-v1
60+
- run: *install_python_3
61+
- run: *install
62+
- save_cache:
63+
paths:
64+
- /home/circleci/conda
65+
key: v1-dependencies
66+
- run:
67+
name: Bundle Install
68+
command: |
69+
cd ~/repo
70+
bundle install
71+
bundle check || bundle install
72+
- save_cache:
73+
key: rubygems-v1
74+
paths:
75+
- vendor/bundle
76+
- run: *build_jekyll
77+
- store_artifacts:
78+
path: ~/repo/_site
79+
destination: EASI.github.io

‎.circleci/requirements.txt‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
pyaml>=17.12.1

‎.gitignore‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
2+
.bundle
3+
.DS_Store
4+
.jekyll-metadata
5+
.sass-cache
6+
Gemfile.lock

‎CNAME‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
intersect-training.org

‎Gemfile‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
source 'https://rubygems.org'
2+
3+
#gem 'jekyll'
4+
5+
group :jekyll_plugins do
6+
gem 'jekyll-gist'
7+
gem 'jekyll-paginate'
8+
gem "jekyll-asciidoc"
9+
end
10+
11+
gem 'asciidoctor', '~> 1.5.4'
12+
gem 'coderay', '1.1.1'
13+
14+
15+
gem "webrick", "~> 1.7"

‎LICENSE‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
1-
MIT License
1+
The MIT License (MIT)
22

3-
Copyright (c) 2023 AdaptiveExperiments
3+
Copyright (c) 2014 Moritz »mo.« Sauer // Phlow.de
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

‎README.md‎

Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,74 @@
11
# AdaptiveExperiments.github.io
22
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+
![](https://i.imgur.com/9qujX6H.png)
69+
70+
71+
### Contacts
72+
Jeffrey Carver, University of Alabama
73+
74+

0 commit comments

Comments
 (0)