Skip to content

Latest commit

 

History

History
92 lines (70 loc) · 4.51 KB

README.md

File metadata and controls

92 lines (70 loc) · 4.51 KB
Raw

2016.code4lib.org

![Gitter](https://badges.gitter.im/Join Chat.svg)

Intro

This site was developed by the Code4Lib 2016 Conference Committee Website Working Group. The site was designed to provide a comprehensive overview of the Code4Lib 2016 Annual Conference. A great deal of conference and organizational info can be found on the Code4Lib Wiki and the Code4Lib Site, but this site should serve as a gateway to the various sources of Code4Lib information while providing visitors with a user-friendly way to find conference-specific info.

This site was designed with future users in mind, so the group chose platforms that would be accessible to a wide range of users: Jekyll and GitHub Pages. We also custom build Bootstrap 3.3.4 from less files for basic site colors and fonts.

About Jekyll

Jekyll is a Rails gem that generates static websites from markdown, HTML, and other formats. See the official Jekyll documentation for details.

Contributing

Steps for contributing have been documented in the wiki on the site's GitHub page and will be updated as needed.

See a list of outstanding issues. The following example uses "issue#3" as a subject. That's the branch name and used in the commit message.

Here's how to get started and contribute:

The first time you want to contribute

  1. cd to repo root and git pull
  2. bundle install
  3. Continue with step 3 below

Subsequent work

  1. Make sure you're on the master branch (necessary if you skipped step 9)
  • git checkout master
  1. Make sure your master branch is up to date
  • git pull origin master
  1. Start up jekyll
  • bundle exec jekyll serve
  • check http://localhost:4000
  • make sure that your _data/path.yml file's content is simply '/'
  1. create a new branch for your changes
  • git checkout -b issue#3
  1. make changes, check http://localhost:4000 to see your changes
  2. add your changed files
  • git add {changed-files}
  1. commit your changes with a fancy message
  • git commit -m "fixes issue #3"
  1. add your branch to the repo
  • git push --set-upstream origin issue#3
  1. switch back to the master branch
  • git checkout master
  1. go to https://github.com/code4lib/2016.code4lib.org
  2. make a pull request base:master and compare:issue-3
  3. wait for someone to test your changes and merge
  4. do the dance of joy

Making changes to site CSS

Most of the base colors and fonts are set in Bootstrap 3.3.4's variables.less file located in prototype/bootstrap/less/. More info on compiling Bootstrap CSS with Grunt can be found on their Getting Started page. Other styles can be found in the css/main.css directory.

Managing the Site

Checking pull requests

  1. Follow steps 1-3 from Subsequent work
  2. Get any remote branches
  • git fetch
  1. Switch to the branch in question
  • git checkout BRANCHNAME
  1. Check http://localhost:4000 that nothings broken
  2. Merge that branch and master

Keeping master and gh-pages in sync

Original source

When master is ready to get published:

git add . //add any outstanding files
git status // to see what changes are going to be commited
git commit -m 'Some descriptive commit message'
git push origin master // syncs local and origin master
git checkout gh-pages // go to the gh-pages branch
git rebase master // bring gh-pages up to date with master
git push origin gh-pages // commit the changes
git checkout master // return to the master branch

Additionally, this can be done in the GUI

  1. make a pull request base:gh-pages and compare:master
  2. Master should be up to date; you can merge your own pull request here.

Resources

More details are available in the GitHub wiki for this page

Conference Website Working Group wiki page: Working Group Documents