search

alaoweb / 2020.alaoweb.org

Virtual Conference for ALAO
https://2020.alaoweb.org/
MIT License
1 stars 0 forks source link

readme

2020.alaoweb.org

PRODUCTION

GitHub Pages build from master branch: https://2020.alaoweb.org

STAGING

Netlify build from staging branch: https://2020-staging.alaoweb.org

Netlify Status

Intro

This site was developed by the ALAO 2020 Virtual Conference Website Team based on a design by the Project Zeppelin / GDG DevFest. A great deal of conference and organizational info can be found on the ALAO Website. This site should serve as a gateway to the various sources of ALAO 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.

About Jekyll

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

Resources

More details are available in the GitHub wiki.

Contributing

Pre-Requisite:

The following example uses "issue#3" as a subject. That's the branch name and is used in the commit message.

Setup

  1. git clone the repo from GitHub
  2. cd to repo root and git pull
  3. bundle install
  4. 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 live
    • We strongly recommend performing an accessibility audit (e.g. with Chrome) if you've made structural or stylistic changes (not adding text content or additional posts)
  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/alaoweb/2020.alaoweb.org
  11. Make a pull request base:master and compare:issue-3
  12. Wait for someone to test your changes and merge the pull request
  13. Do the dance of joy 🎉

Managing Pull Requests

  1. Follow steps 1 - 3 above
  2. Get any remote branches
    • git fetch
  3. Switch to the branch in question
    • git checkout BRANCHNAME
  4. bundle exec jekyll serve
  5. Check http://localhost:4000 that nothing is broken
  6. Merge that branch into master (easiest to manage on the GitHub site)