CollectionBuilder-DHSI Workshop Tutorial

Day 1 - The Base Components and Workflows

This day's content will get you started with a basic overview of a CollectionBuilder site, some details on file naming, file extensions, documentation and metadata requirements.

Day 1: Monday, June 7

Topics: CollectionBuilder intro, GitHub, working in GitHub web interface

**Major Learning Objectives: **

Conceptual

• Have a basic understanding of the structure and design of a CollectionBuilder site
• Understand the importance of case in the naming of files and file extensions
• Recognize the required metadata fields for a CollectionBuilder-GH instance
• Understand how to find the CollectionBuilder docs and how to use them*

*Technical

• Be able to use Google Sheet formulas and filters to fill in your metadata
• Be able to start a CollectionBuilder project using the CollectionBuilder-GH Template
• Be able to recognize a .YML file and where to find a _config.yml file in a Jekyll project*

Day 1 Workshop Recording:

https://youtu.be/ZPOKRpxGJqg

Day 1 Outline:

1. CollectionBuilder introduction (https://collectionbuilder.github.io/) - slides (Devin)
   • Tour a CollectionBuilder demo site
2. Intro to CollectionBuilder docs (https://collectionbuilder.github.io/cb-docs/) (Olivia)
   • Documentation sections
   • Documentation search
3. Collection Objects (Evan)
   • Object types
   • File extensions
   • Filenaming conventions and issues
4. Metadata (Devin)
   • Why use Google Sheets?
   • Required fields
   • Google sheets tricks (Quick Tutorial/Presentation)
   • Formats, filenames, field names
5. Quick demo of setting up a collection (Olivia)
   • Copy CollectionBuilder-GH Template
   • Turn on GitHub Pages
   • Upload Objects
     • Commit changes
   • Upload Metadata
     • Commit changes
   • Configure site-wide settings using _config.yml
     • Commit changes
   • Create an Issue
6. Wrap-up
   • Questions?
   • Discuss homework (Olivia)
     • Introduce how homework instructions are laid out
     • Build a collection using your own data (run into trouble? Send us your questions as well as a link to your repository)
     • Create an issue in the dhsi-demo repository introducing yourself and your collection
   • Office hours!
7. Demo data:
   • Psychiana Collection Demo Data
     • Metadata: https://docs.google.com/spreadsheets/d/1x48Te3duPAxh53foEihQVKTfCKUjaCCbH7TrMMd_yU4/edit?usp=sharing
     • Objects: http://lib.uidaho.edu/collectionbuilder/demo-objects.zip
   • Carleton Watkins Mine Collection Demo Data
     • Metadata: https://docs.google.com/spreadsheets/d/1mThECwBYaUdvUrSbc9d2wbjedpYyvVD89jJ15R-7Qmo/edit?usp=sharing
     • . Objects: http://lib.uidaho.edu/collectionbuilder/watkins.zip

Homework

Create a collection using the objects you’ve prepared

1. Create a new CollectionBuilder-GH collection repository using the green “Use this template” button from the CollectionBuilder-GH repository (https://github.com/CollectionBuilder/collectionbuilder-gh)
   • Follow the “Generate from Template” documentation: https://collectionbuilder.github.io/cb-docs/docs/repository/create/
2. Create your collection’s metadata according to the metadata guidelines: https://collectionbuilder.github.io/cb-docs/docs/metadata/gh_metadata/
   • Use the CollectionBuilder-GH metadata template: https://docs.google.com/spreadsheets/d/1Uv9ytll0hysMOH1j-VL1lZx6PWvc1zf3L35sK_4IuzI/edit?usp=sharing
   • Be sure that you’ve included the required fields, and that filenames and file extensions in your metadata match the filenames and file extensions of your objects–filename is case sensitive!

3. Upload your metadata to your repository: https://collectionbuilder.github.io/cb-docs/docs/metadata/uploading/

4. Add your prepared objects to the objects folder in your repository: https://collectionbuilder.github.io/cb-docs/docs/objects/gh-objects/

5. Turn on GitHub Pages: https://collectionbuilder.github.io/cb-docs/docs/deploy/gh-pages/

6. Adjust site-wide settings in the “_config.yml” file: https://collectionbuilder.github.io/cb-docs/docs/config/

7. Create an issue on the dhsi-demo repository (https://github.com/CollectionBuilder/dhsi-demo/issues) that:
   • Describes your collection, and;
   • Includes links to your collection repository and live collection site.
8. Ensure software is set up on your personal computer (you’ve likely already done this by now)! https://collectionbuilder.github.io/cb-docs/docs/software/
   • Git
   • Text editor
   • Ruby
   • Jekyll + Bundler
9. Get in touch if you run into any issues or have any questions!

« Previous Step Next Step»