search

code4lib / 2018.code4lib.org

site for the 2018 code4lib conference in Washington, DC
http://2018.code4lib.org
6 stars 10 forks source link

readme

2018.code4lib.org

Intro

This site was developed by the Code4Lib 2018 Conference Committee Website Working Group based on a design by the 2016 working group. The site was designed to provide a comprehensive overview of the Code4Lib 2018 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.

Resources

More details are available in the GitHub wiki for the 2017 page.

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 2016 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.

Setup:

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

Contributing:

  1. Make sure you're on the master branch
    • git checkout master
  2. Make sure your master branch is up to date
    • git pull origin master
  3. Start up jekyll
  4. create a new branch for your changes
    • git checkout -b issue#3
  5. make changes, check http://localhost:4000 to see your changes
  6. add your changed files
    • git add {changed-files}
  7. commit your changes with a fancy message
    • git commit -m "fixes issue #3"
  8. add your branch to the repo
    • git push --set-upstream origin issue#3
  9. switch back to the master branch
    • git checkout master
  10. go to https://github.com/code4lib/2017.code4lib.org
  11. make a pull request base:master and compare:issue-3
  12. wait for someone to test your changes and merge
  13. do the dance of joy

Managing Pull Requests

  1. Follow steps 1-3 from Subsequent work
  2. Get any remote branches
    • git fetch
  3. Switch to the branch in question
    • git checkout BRANCHNAME
  4. Check http://localhost:4000 that nothing is broken
  5. Merge that branch and master (easiest to manage on the github site)