Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Description of the Technical Documentation Subteam

The Technical Documentation sub-team (TechDocs) facilitates maintenance and enhancement of all ArchivesSpace technical documentation.

This page is intended to document the internal processes of the Technical Documentation sub-team to facilitate continuity between terms. It is currently very sparse and will be filled out throughout the remainder of the 2022-2023 term.

Roles and Responsibilities for TechDocs Members

TechDocs Github Repository

About the Repository

The primary source of technical documentation for ArchivesSpace is the archivesspace/tech-docs Github repository (tech-docs repo). A public, more user-friendly version of the content is available at https://archivesspace.github.io/tech-docs/.

The technical documentation is openly accessible and does not require ArchivesSpace membership, in contrast to the User Manual available through the ArchivesSpace Help Center. The two sets of documentation were created and are maintained in different environments due to this difference in access, as well as their difference audiences.

Access and Permissions

All TechDocs sub-team members should have write permissions to the tech-docs repository. Before the beginning of each term, the sub-team lead should email Christine DiBella with the Github handles of the sub-team members to facilitate access.

Pull Requests

 

Issues