ANS 2021 Student Conference Website

This repository holds the ANS 2021 Student Conference Website.

Using Git to Make Website Edits

This guide will show you how to make edits to the ANS Student Conference Website, specifically. It should also give you a sense of how to use git and GitHub for version control, a very useful skill.

Two Rules of using GitHub

1. Do not push to master.
2. Do not merge your own pull requests. If you follow these two rules you will avoid a lot of headaches in the future.

Quick Set Up Guide

1. Make a Github account and join the organization (ansuiuc).
2. Install Git on your computer
3. Set up SSH Keys (this step is optional but will save you a lot of time later)
   • Windows users after you have installed Git you can navigate to the Git Bash app which allows you to use the commands in the guide. Linux and Mac can use the commands directly in Terminal.
4. Install the build dependencies
   • ruby
   • jekyll
   • jekyll-scholar
5. Fork the repository to a logical place on your computer.
6. Clone the fork on your computer with the following command (USERNAME is your username):
   • git clone [email protected]:USERNAME/conference-build-here.git
   • Caution: Do not clone to another git repository (i.e. a folder that uses git tracking -- I'm not even sure if it's possible but don't try it).
7. Run the following commands to finish setting up:
   • cd conference-build-here
   • gem install bundler
   • jekyll serve if this fails run bundle exec jekyll serve
8. Adding your information to the website
   • git checkout source
   • Add your image to the ./img/members/ folder. If your name is Jane Doe you will add doej.png
   • Open the file contact_us.html and add your information to that file.
   • git add img/members/doej.png
   • git commit -m "adds image of jane doe"
   • git add contact_us.html
   • git commit -m "adds jane doe information"

Errors

After cloning the repository and attempting to run

jekyll serve

I received the error

`Configuration file: C:/Users/samgd/conference-build-here/_config.yml

jekyll 3.8.5 | Error: The jekyll-theme-cayman theme could not be found.`

Solution:

This problem arose because there was no Gemfile. I learned about Gemfiles from this website.

Gemfile.lock is a built file and should not be included in a commit.