https://github.com/code4lib/2022.code4lib.org

Website for the 2022 Conference
https://github.com/code4lib/2022.code4lib.org

Last synced: about 1 month ago
JSON representation

Website for the 2022 Conference

• Host: GitHub
• URL: https://github.com/code4lib/2022.code4lib.org
• Owner: code4lib
• Created: 2021-09-28T00:53:32.000Z (about 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-10T15:07:07.000Z (almost 2 years ago)
• Last Synced: 2024-03-25T21:14:29.915Z (9 months ago)
• Language: HTML
• Homepage: https://2022.code4lib.org/
• Size: 45.1 MB
• Stars: 2
• Watchers: 15
• Forks: 3
• Open Issues: 3
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# 2022.code4lib.org

## Intro

This site is developed by the [Code4Lib 2022 Conference Committee Website Working Group](https://wiki.code4lib.org/Code4Lib_2022_Conference_Committees#Website_Working_Group) based on a design by the [2016 working group](https://wiki.code4lib.org/2016_Conference_Committees#Website_Working_Group). A great deal of conference and organizational info can be found on the [Code4Lib Wiki](https://wiki.code4lib.org/Main_Page) and the [Code4Lib Site](https://code4lib.org), 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 is designed with future users in mind, so the group chose platforms that would be accessible to a wide range of users: [Jekyll](https://jekyllrb.com) and [GitHub Pages](https://pages.github.com).

## Resources

More details are available in the [GitHub wiki](https://github.com/code4lib/2022.code4lib.org/wiki).

## About Jekyll

[Jekyll](https://jekyllrb.com) is a Ruby gem that generates static websites from markdown, HTML, and other formats. See the [official Jekyll documentation](https://jekyllrb.com/docs/home/) for details.

## Contributing

Steps for contributing have been documented in the [wiki on the 2016 site's GitHub page](https://github.com/code4lib/2016.code4lib.org/wiki) and will be updated as needed.

See a list of [open issues](https://github.com/code4lib/2022.code4lib.org/issues). 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](https://github.com/code4lib/2022.code4lib.org) 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 main branch

  * ```git checkout main```

2. Make sure your main branch is up to date

  * ```git pull origin main```

3. Start up jekyll

  * ```bundle exec jekyll serve```

  * open [http://localhost:4000](http://localhost:4000) in your browser

4. Create a new branch for your changes

  * ```git checkout -b issue#3```

5. Make changes, check [http://localhost:4000](http://localhost:4000) to see your changes live

  * We strongly recommend performing an accessibility audit (e.g. [with Chrome](https://developers.google.com/web/tools/chrome-devtools/accessibility/reference)) 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 main branch

  * ```git checkout main```

10. Go to https://github.com/code4lib/2022.code4lib.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](http://localhost:4000) that nothing is broken

6. Merge that branch into master (easiest to manage on the GitHub site)