GitHub Pages build from main branch: https://2021.alaoweb.org
Content Completeness Audit: https://2021.alaoweb.org/audit
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.
Jekyll is a Ruby gem that generates static websites from markdown, HTML, and other formats. See the official Jekyll documentation for details.
More details are available in the GitHub wiki.
Pre-Requisite:
- A Package Manager: Homebrew or Chocolatey
- git
- Ruby
- Jekyll
The following example uses "issue#3" as a subject. That's the branch name and is used in the commit message.
git clonethe repo from GitHub- cd to repo root and
git pull bundle install- Continue with step 3 below
- Make sure you're on the main branch
git checkout main
- Make sure your main branch is up to date
git pull origin main
- Start up jekyll
bundle exec jekyll serve- open http://localhost:4000 in your browser
- Create a new branch for your changes
git checkout -b issue#3
- 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)
- Add your changed files
git add {changed-files}
- Commit your changes with a fancy message
git commit -m "fixes issue #3"
- Add your branch to the repo
git push --set-upstream origin issue#3
- Switch back to the main branch
git checkout main
- Go to https://github.com/alaoweb/2020.alaoweb.org
- Make a pull request base:main and compare:issue-3
- Wait for someone to test your changes and merge the pull request
- Do the dance of joy 🎉
- Follow steps 1 - 3 above
- Get any remote branches
git fetch
- Switch to the branch in question
git checkout BRANCHNAME
bundle exec jekyll serve- Check http://localhost:4000 that nothing is broken
- Merge that branch into main (easiest to manage on the GitHub site)