Designed by Kristie Taylor-Muise based on Halcyonic by HTML5 UP.
These are rather draft instructions, but they should serve as a loose guide.
- Sign up for Github
- Go to https://github.com/ICAPS2022/icaps2022.github.io and click the 'Fork' button in the upper right. This should create and bring you to your own copy of the ICAPS website repository.
- Use git to clone your repository
After you've cloned the ICAPS on GitHub and set it up on your local machine, you should add a remote repository for tracking changes to the main site:
$ git remote add icaps git@github.com:ICAPS2022/icaps2022.github.io.git
You only need to do this once for your local repository.
Use git-fetch to update the remote repository, and then create a new branch for the pull request you plan to make:
$ git fetch icaps
$ git checkout -b <branch-name> icaps/master
Edit your files normally.
If you add a new file, remember to add it with git add
. Commit your changes with git commit
, and push it back to GitHub with git push
:
$ git add <path-to-new-file>
$ git commit -am <useful but terse change description>
$ git push origin
You should repeat this part of the procedure for each new pull request.
The website is built using jekyll
, a web framework built on top of the Ruby language. On Linux, you can install this with apt install jekyll
, and similar instructions exist for other OS'. After installing, you will need to install the required gems via bundle install
.
You can test your changes by running jekyll serve
from the base directory (icaps2022.github.io), which will start a webserver on http://localhost:4000
Depending on your system configuration, sudo
may be required for any of these.
Use https://github.com/ICAPS2022/icaps2022.github.io/pulls to create a "Pull request", which will notify us that your changes are ready to apply, and we'll log on to merge them into the main site. I've created an example pull request here: https://github.com/ICAPS2022/icaps2022.github.io/pull/
The website maintainers will be notified and (hopefully) approve the changes to the site, at which point they'll go live.
If you have future edits to make, you can restart the process at "Branch to Make your Edits"