Documentation Site Guide | Using GitHub

Using GitHub

A GitHub repository is a central storage space to save all the files associated with a set of documentation, and where all of the versions of those files can be accessed. Each set of documentation will be added to its own GitHub repository, which will be leveraged by the docs-build repository to create the site and enable us to separate public and private documentation.

To add and manage files in a GitHub repository, become familiar with the principles of version control and Git. Here are some helpful outside resources to get started:

A Visual Introduction to Git. A visual guide from Ashley Keller.

Understanding the GitHub Flow. GitHub guide to the basic workflow

Learn Git. Code Academy course to learn the basics of the Git workflow

A Beginner’s Guide to Git — How to Write a Good Commit Message. Short post on the basics of writing meaningful commit messages.

Get Started with GitHub

To work with GitHub:

  1. Create or have an existing GitHub account. Sign up for GitHub.
  2. Send the username to a member of the Digital Programs Team to add the new user as a member to the RAC GitHub Organization.
  3. Work with GitHub in one of three ways: directly in the browser, locally using GitHub Desktop, or from the command line:

Create a Repo

Create a Repo Instructions from GitHub.

  1. Choose a template: use RockefellerArchiveCenter/docs-template.
  2. Designate the owner as the Rockefeller Archive Center.
  3. Format the name using lowercase letters and dashes between words “short-name” (e.g. processing-manual).
  4. Add a short description of the documentation.
  5. Choose to make the repo public or private based on its pre-approved designation (see the Rockefeller Archive Center Documentation Site Content Approval Policy). The designation must be approved by the RAC Assistant Director for the relevant function area, and documentation that is made publicly available must also be approved by the Director of Archives.
  6. A README file, as specified in this documentation, is included in the template.
  7. A License, as specified in this documentation, is included in the template.