Merge pull request #15 from uidaholib/aw_08082024_dc_docs_revision

update and reorganize docs

content/collections/00-overview.md

@@ -0,0 +1,42 @@
+---
+section_id: Creating Collections
+nav_order: 8
+title: Overview
+---
+
+Each Digital Collections consist of several parts:
+
+- Objects: the digitized files such as jpgs, pdfs, mp3s, etc.
+- Metadata: the spreadsheet describing the items.
+- CollectionBuilder template: a branch in collection template or separate project repository.
+
+This "Creating Collections" section describes the workflow for setting up a new collection using one of our standard templates at U of I library.
+The complete process to create a collection from a generic template is described in the [CB-Docs](https://collectionbuilder.github.io/cb-docs/)--this version adds context specific to the workflows of Digital Collection team.
+
+Most Digital Collections team members will not regularly need to complete the full process to create a new collection--many of the steps will be completed by core maintainers, with collaborators focusing on objects, metadata, and interpretive content. 
+
+## Overview of the Process
+
+1. Prepare collection objects and metadata.
+2. CDIL team loads prepared objects to libobjects server.
+3. Select collection template.
+4. Create new branch for collection. 
+5. Add metadata CSV to "_data" folder.
+6. Configure collection's "_config.yml".
+7. Configure pages and nav.
+8. Write interpretive content in "about.md".
+9. Test on local machine (ongoing).
+10. Notify CDIL team to publish to live web.
+11. DC QC process.
+12. Promote!
+
+## Naming Convention
+
+For ease of organization, we follow a naming convention to create an "id" for each collection that will be used for the web location, branch name, and metadata csv name--that we call the collection "stub".
+The stub will be all lowercase, no spaces, and no special characters (other than `-`).
+Generally it will correspond to an existing identifier, nickname, or acronym as appropriate.
+
+For example, for the "Agricultural Economics Research Series" collection, the stub is "aers", thus the URL is "https://www.lib.uidaho.edu/digital/aers/", the branch is "aers", libobjects folder "aers", and metadata is "aers.csv".
+If you are generating objectids for your collection, you can also use the stub as the base, e.g. "aers339".
+
+Select your stub name and ensure it does not conflict with existing collections!

content/collections/01-metadata_object_prep.md

@@ -0,0 +1,42 @@
+---
+section: Creating Collections
+nav_order: 1
+title: Objects and Metadata
+---
+
+Collection creation starts with the digital objects and metadata. 
+This is often work completed with students, fellows, and other collaborators.
+
+The processes for creating objects and metadata from scratch are described in other sections of these Docs.
+When ready, there are a few steps to prepare for creating a new collection.
+
+## Objects
+
+Once the objects have been prepared, they should be gathered in a single folder.
+Filenames and extensions should be carefully checked over to ensure they exactly match the "filename" field in your metadata (this is case sensitive!).
+
+## Metadata
+
+At this point you should ensure all required fields are completed and fill out the technical fields required for CollectionBuilder:
+
+- Ensure all "objectid" are filled in and unique.
+- Ensure metadata follows [formatting best practices](https://collectionbuilder.github.io/cb-docs/docs/metadata/formatting/).
+- Fill in ["display_template"](https://collectionbuilder.github.io/cb-docs/docs/metadata/csv_metadata/#display-template) with the appropriate value.
+- Fill in [object location fields](https://collectionbuilder.github.io/cb-docs/docs/metadata/csv_metadata/#object-location-fields) using the url for the libobjects server, following the patterns:
+    - "object_location": `https://objects.lib.uidaho.edu/collectionstub/filename.jpg`
+    - "image_small": `https://objects.lib.uidaho.edu/collectionstub/small/filename_sm.jpg`
+    - "image_thumb": `https://objects.lib.uidaho.edu/collectionstub/thumbs/filename_th.jpg`
+    - *Note: this can be done in bulk using equations or OpenRefine, or automatically generated. Please ask if you have questions!*
+
+If you have been using Excel, the XLSX file will need to be uploaded to Google Sheets (Excel cannot create a properly formatted CSV). 
+From Google Sheets or OpenRefine, export a CSV version of your metadata and rename to match the collection stub (and do not accidentally open in Excel!). 
+
+## Transfer 
+
+Share the completed folder of objects and metadata to the CDIL staff via shared drive.
+CDIL staff will:
+
+- QC objects
+- [Generate derivatives](https://collectionbuilder.github.io/cb-docs/docs/objects/derivatives/#generate-derivatives-rake-task) using `rake generate_derivatives`
+- Copy the folder to the libobjects server (in a folder matching the collection name)
+- Copy the full quality objects and metadata to the archive drive (if this has not already been completed)

content/collections/02-setup.md

@@ -0,0 +1,39 @@
+---
+section: Creating Collections
+nav_order: 2
+title: Setup
+---
+
+To access and develop our digital collections, you will need a GitHub account and some software installed on your computer. 
+For collaborators focusing on metadata and object work, this is unnecessary--however, if you would like to preview and test a collection on your computer, write Harvester posts, or contribute to the library website, having this "development environment" set up will be helpful!
+
+## GitHub 
+
+To access the collection templates you will need a GitHub account. Check the [notes on CB-Docs for more information](https://collectionbuilder.github.io/cb-docs/docs/software/github/#github-account).
+
+We suggest setting one up with a "professional" non-U of I email account--this ensures you will have access even if you leave U of I, but also not connected to your personal email--if you don't have one, set up a new Gmail account since we often end up on Google Sheets and Docs for work anyway!
+
+Once you have a GitHub account set up, email your account name to the maintainers to get added to our GitHub organization. 
+
+Our org, [uidaholib](https://github.com/uidaholib) owns all the project repositories to ensure continued access and easy collaboration. 
+Digital Collection team members will be added to the [digital-collections-team](https://github.com/orgs/uidaholib/teams/digital-collections-team). 
+This team has write access to all the relevant templates and project repositories. 
+
+Using the teams allows us to change membership and manage access with out needing to add/remove individual accounts to every repository--please use the teams and do not unnecessarily add individuals to repositories!
+
+## Software 
+
+To be able to develop and test a collection on your local computer you will need Git, VS Code, Ruby, and Jekyll installed.
+To generate image derivatives you will need ImageMagick and GhostScript (not all DC team members will need to do this!).
+
+Please follow the [software install instructions on cb-docs](https://collectionbuilder.github.io/cb-docs/docs/software/).
+
+| Software | Process |
+| --- | --- |
+| Google Sheets | Create and edit metadata spreadsheets; create CSV |
+| Git, GitHub Desktop | Copy the templates to your local and sync work |
+| VS Code | Edit the project files |
+| Ruby, Jekyll | Test the site locally; build the final site |
+| ImageMagick, GhostScript | Generate image derivatives |
+| OpenRefine | Bulk transform and improve metadata |
+{:.table .table-bordered}