Drexel CCUH Data Infrastructure Documentation

Preface

Note

This documentation site is a resource for the CCUH data infrastructure team and other climate related projects. Other useful links include:

• Public Notion Page for easy access to CCUH databases
• Internal Notion Page for documentation
• CCUH GitHub Project for project management
• CCUH GitHub Repository for data infrastructure codebase

Why?

Problem:

• need standard operating practices for within project tasks
• help on-baording for new team members
• need to have transparency for CCUH as a part of scaling or capacity development for other projects.

Proposal:

• Quarto book that is published onlien and as a static page
• docuemnt protocls and share insights, methods from CCUH project.
• very similiar to how other P20 centers are doing things see CAFE data management page

How? Quarto Books

This is a book created from markdown and executable code. See Knuth (1984) for additional discussion of literate programming. Importantly, we write it in a single format (Quarto) which allows us to convert to all the usualy formats that best fit audiences:

• Interactive Book
  • to publish use quarto publish gh-pages
  • result: CCUH Data Infrastructure Documentation Page
• Word doc
  • run quarto render --to docx
  • Drexel-CCUH-Data-Infrastructure-Documentation.docx
• PDF
  • run quarto render --to epub
  • Drexel-CCUH-Data-Infrastructure-Documentation.pdf
• EPUB
  • run quarto render --to pdf
  • Drexel-CCUH-Data-Infrastructure-Documentation.epub

Knuth, Donald E. 1984. “Literate Programming.” Comput. J. 27 (2): 97–111. https://doi.org/10.1093/comjnl/27.2.97.