Prior to adding or editing content, all additions and changes must be approved as specified in the Rockefeller Archive Center Documentation Site Content Approval Policy. All public content must be approved by the Director of Archives and President.
developmentin the target repository.
developmentbranch every few minutes. When a repository is first created, it has to be manually added to the development server. See the Documentation Site Info Sheet.
masterbranch of the GitHub repo.
masterbranch where it will be incorporated into docs.rockarch.org. See the Documentation Site Info Sheet for directions on adding the master branch to the production server.
Documentation will be created in or converted to the Markdown format (see Using Markdown) to be leveraged by Jekyll to build the website. Add simple documentation like a short policy or one-page informational sheet to the GitHub repository as a single Markdown file (named
At the beginning of each Markdown file that is part of the documentation, include a title and the type of layout. The title should start with “Rockefeller Archive Center”. This is the title that will be displayed as the title of the webpage.
title: "Rockefeller Archive Center Guide to Processing Collections"
The title of the page is Header 1. Note that Header 2s (##) in Markdown appear as the side navigation display on the webpages.
Any institution or other’s work that we relied on in drafting our own documentation should be credited on the
Every GitHub repository requires a
README.md file that includes information about what is in the repo, how to access and use the content, and defines documentation authorship. The README should be formatted in Markdown and include a link to docs.rockarch.org.
All RAC documentation that is shared publicly on this platform will be made available under a Creative Commons Zero (CC0) public domain dedication, and all project-associated code is made available on the RAC organizational GitHub under an MIT License. For public content, choose a CC0 License for the GitHub repository. Do not select a license for private content.
To add a license after the repo is created:
Create a file called
_config.yml. See the docs-build README for the specific variables required in
_config.yml. This configuration file provides information to determine whether the documentation in the repo is designated as public or private, the title and description, associated tags, and pages information that is used to create the side navigation table of contents for each set of documentation.
public: falseuntil it has been approved for public access by the Director of Archives and President.
More complicated documentation might be more appropriately split into multiple files, which will translate into a corresponding number of web pages. In deciding how to divide the documentation, structure and present the content in a way that enhances navigation and use.
For example, in addition to an index.md file, the Rockefeller Archive Center Guide to Processing Collections includes two other Markdown files that represent as two different pages on docs.rockarch.org: Planning and Processing. All files should be in the root directory (no subfolders). The exception is if there are images, which should be in a subfolder titled
Filenames should be short with no special characters or spaces. Use a hyphen between words instead of spaces. The filename will be part of the url of the site, so simple and concise are best.
Note that Header 2s (##) in Markdown appear as the side navigation display on the webpages.
Add links between documents and sections using the format:
This is a link to [another section](#header-name) in the same document
This is a link to [another file](file-name) in the same repository
The docs-build repo contains the CSS stylesheets for docs.rockarch.org. However, it is possible to add HTML and CSS markup directly into a Markdown file.
To style text as an example that will be set apart from the other text, assign the block of text a <div> tag and css class “docs-example.” As specified in our custom CSS for the site, this will change the font and center the text.
<div class="docs-example"><p> This is some example text </p> </div>