Week 1, Day 5: Friday, July 15, 2022
Synopsis
Collaborating on the edition. In session one we introduce the TEI ODD (One Document Does it all), a mechanism for documenting customizations to the TEI for project-specific purposes. Then, instructors lead small groups in applying ODD modeling to the laboratory edition. In session two we introduce GitHub Projects, a Kanban-style collaboration tool, and guide participants through debugging and resolving merge conflicts in Git. After exploring facets and fields on Thursday, we present the Advanced search feature in its final form and discuss the development journey for advanced features like this. A special topic session by Jeffrey Witt on the International Image Interoperability Framework (IIIF), a community-focused Linked Open Data (LOD) standard for image sharing, closes the day.
Outcome goals
- Introduce tools for task and issue management.
- Get ready to make your own app and set up your workspace.
- Understand tracking branches, development branches, pull requests as branches.
- Use your own repository to practice branches.
- Become comfortable with merge conflicts and using Git.
- Understand the development process for creating advanced features.
- Use several advanced features in eXist-db to support research outcomes.
Legend
- Presentation: by instructors
- Discussion: instructors and participants
- Talk lab: participants discuss or plan in small groups
- Code lab: participants code alone or in small groups
9:00–10:30: Setting up an app with Yeoman and VSCode sync
| Time | Topic | Type |
|---|---|---|
| 20 min | Project management tasks. | Presentation |
| 70 min | Yeoman and VSCode. | Discussion |
10:30–11:00: Coffee break
11:00–12:30: Git and GitHub in Real Life
Edition repo stages for session
| Time | Topic | Type |
|---|---|---|
| 40 min | Branches and you. | Presentation |
| 20 min | Practice with branches. | Code lab |
| 30 min | Create merge conflicts on purpose to gain familiarity with resolving them (without being thrown into a vim black hole). | Code lab |
12:30–2:00: Lunch
2:00–3:30: Search functionality
Edition repo stages for session
| Time | Topic | Type |
|---|---|---|
| 15 min | Facet theory. | Presentation |
| 30 min | Facets and fields in eXist-db searching. | Presentation |
| 45 min | Facets and you: thinking about your search interface. | Talk lab |
3:30–4:00: Coffee break
4:00–5:30: Catchup session
| Time | Topic | Type |
|---|---|---|
| 30 min | XQuery: taking stock. | Code lab |
| 30 min | Command line tips and tricks. | Code lab |
| 30 min | Slide slam. | Code lab |
We’ll end each day with a request for feedback, based on a general version of the day’s outcome goals, and we’ll try to adapt on the fly to your responses. Links to the feedback forms are in our Slack workspace in the #daily-feedback channel (posting from Mason on Mon, July 11).