CCRMA Documentation links:   index   contents   overview   rooms   account   staff   about

(contents of this file: links to each section)

About This CCRMA Documentation

CCRMA Documentation 2019-present. (For earlier documentation see overview.)

Auto-generated index and table of contents.

Email matt with additions, corrections, questions, requests, etc.

Everything lives in this git repo (for now): https://cm-gitlab.stanford.edu/matt/ccrma-docs

The source files use the Markdown format. There are lots of great Markdown guides, tutorials, cheatsheets etc. Also the Pandoc manual has lots of great info about Markdown in general and Pandoc’s extensions to Markdown in specific.

Every .html file comes from a corresponding .md file that you can also download; for example this file README.md generates the output README.html.

Diagram source files in formats such as Adobe Illustrator, OmniGraffle are also here.

This repo contains bash scripts to build the html or pdf with pandoc, deploy to the CCRMA webserver, and build the overall table of contents.

Here are some of the values and goals embodied in this project:

• Accurate, complete, pertinent information available to CCRMA users.
• No duplication: “factor out” common information to a single location and point to there from everywhere relevant.
• Source content stored in simple files not some software’s internal database
• Simple, lightweight open-source toolchain; not tied to any “heavy” infrastructure such as Drupal.
• Structure pages to make it easy to find “how to” information for common tasks.

This documentation project initiated by Matt Wright in 2019.

This page of CCRMA documentation last committed on Mon Feb 15 13:04:17 2021 -0800 by Matthew James Wright. Stanford has a page for Digital Accessibility.