RCP Documentation Repository README

Author
Katie Alsua

Updated
2026-01-06, KA

This project documents usage and best practices for the HBS Research Computing Platform.

Documentation

The documentation is available in the user guide.

Documentation Updates

Document authors:

• Please create the how-to document in whatever application you prefer.
• Include all the items marked with a red asterisk (*), as noted below.
• Items not marked with an * are optional.

---

• * Heading
  • Title of article or documentation section
    • Ex: “Extracting Archived / Compressed Files”
• Tutorial Tags (if applicable)
  • Used to categorize articles on tutorial page
    • (Ex: “7-zip”)
• Synopsis (optional)
  • A brief summary of the topics covered in the article or documentation section
    • Ex: "On the Grid, there are two sets of system-wide tools for extracting files from an archive/compressed file: unzip and gunzip. This article explains how to use the unzip command to extract from common archive formats such as ZIP and RAR."
• * Author Name(s) (for internal use only, not for public view unless specified)
  • List the main author(s) and significant contributor(s)
• * Name(s) of Peers who reviewed (for internal use only, not for public view)
  • List any significant peer reviewers
• * Date Written or Updated / Changelog (changelog for internal use, date of recent update publicly visible)
  • Ex: “2024-12-12, authored by Katie Yosua. 2025-12-12, updated by Paul DiBello”
• * Body of Text, code blocks, links etc. + examples, use cases
  • This will vary at the author’s discretion. May wish to include:
    • practical, copy-and-pasteable examples
    • both common and non-obvious use cases
    • notes, caveats, cross references, and/or links to other useful resources An example text can be found at: https://hbs-rcs.github.io/hbsgrid-docs/tutorials/uncompress/

After authoring your “how-to” draft, please notify Katie Alsua and forward to peers for review.
Questions: contact Katie Alsua at kyosua@hbs.edu

Issues and Documentation Requests

If you find incorrect or outdated information, if a piece of documentation is unclear or otherwise unhelpful, or if there is documentation missing that you believe we should include, please let us know so we can fix it. We appreciate any and all feedback!