From Silo to Repo: Enforcing File Structure to Improve Workflow and Access

paper, specified "short paper"
Authorship
  1. 1. Jessica Dussault

    University of Nebraska–Lincoln

  2. 2. Laura K Weakly

    University of Nebraska–Lincoln

Work text
This plain text was ingested for the purpose of full-text search, not to preserve original formatting or readability. For the most complete copy, refer to the original conference program.

From Silo to Repo:Enforcing File Structure to Improve Workflow and AccessDussault, Jessica; Weakly, Laura K.University of Nebraska-Lincoln    The University of Nebraska-Lincoln’s Center for Digital Research in the Humanities (CDRH) has created more than 80 projects since 1998.1 Because of the collaborative and experimental nature of Digital Humanities projects, a variety of technologies and structures were utilized, which has proved challenging to support as we continue to develop projects.2 Recently the CDRH has implemented policies that separate data from websites and standardize file locations. These policies have been reinforced by building software with expectations about data location, which makes creating, maintaining, and upgrading sites more manageable. This paper examines the structural changes of organizing files, the impact on workflow, and the increased accessibility of data for researchers.File Organization    The CDRH’s largest and most well-known projects are document-driven digital archives, producing tens of thousands of encoded TEI-XML3 files. Historically, these files were part of a website's code base, but projects shared no common structure. The first step towards managing data for dozens of projects was to move the documents out of website code into "data repositories."4 Datura5, CDRH-developed software, provides customizable scripts for transforming a data repository's documents into other formats, such as HTML or JSON for search indexes. The location of documents is enforced by Datura's expectations of file types.Figure 1: The basic structure of a data repository. The source documents, stored in subdirectories by type, are transformed by scripts which apply overrides and configuration settings into files in the output directory. Most commonly, TEI files are transformed into HTML for display or JSON for populating search indexes.Images are stored separately from the website served with an International Image Interoperability Framework-compatible image server.6 These changes to data and image locations allow us to focus on standardizing other aspects of our websites, such as publishing documents with a center-wide API.WorkflowThis Datura-driven standardization has led to improvements in project workflow. Students and other researchers can be commonly trained on file naming and data structures. They are trained to use a version control system, currently git hosted on GitHub, allowing easier access to file sharing and virtually eliminating data being lost or overwritten. Previously students working on multiple projects needed training on each project as to where metadata files and images were stored, scan specifications, file naming, and file sharing. Now students can work across projects with little to no learning curve for each new project.Increased AccessibilityThe CDRH has a commitment to making data available for scholars. We have long exposed XML source files powering individual pages7, but the new data repository system makes downloading and working with project files even easier. The CDRH publishes data repositories on the code-sharing platform GitHub, tagged with "tei-xml" to aid discoverability.8 These public repositories can be downloaded or referenced remotely. An artist has already used repository documents to power a small site.9 The public repositories also provide student contributors with a resource to showcase their project work.10ConclusionThough this system has drawbacks that we will discuss during our presentation, our data-first approach has dramatically decreased development time spent on creating websites and on student training. Gathering documents together has improved the internal workflow of collaborators, laid the groundwork for future initiatives to renovate aging websites, and aided in the dissemination of data and scholarship to researchers around the globe. Discussion around designing Digital Humanities projects to enable future support is increasingly important in the discipline. Typically, each project has a single data repository, but in the case of larger and more complex projects like The Walt Whitman Archive, a project may have multiple data repositories to group documents with different concerns like marginalia or scribal documents.

If this content appears in violation of your intellectual property rights, or you see errors or omissions, please reach out to Scott B. Weingart to discuss removing or amending the materials.

Conference Info

In review

ADHO - 2020
"carrefours / intersections"

Hosted at Carleton University, Université d'Ottawa (University of Ottawa)

Ottawa, Ontario, Canada

July 20, 2020 - July 25, 2020

475 works by 1078 authors indexed

Conference cancelled due to coronavirus. Online conference held at https://hcommons.org/groups/dh2020/. Data for this conference were initially prepared and cleaned by May Ning.

Conference website: https://dh2020.adho.org/

References: https://dh2020.adho.org/abstracts/

Series: ADHO (15)

Organizers: ADHO