This repository contains all the documentation for the SNAC Web Application and related frameworks, engines, and pieces.
- Technology Infrastructure Architecture Overview
- Overall Tech Plan Document (draft)
- Requirements and Specifications
- Requirements: The currently-being-revised Technical Requirements
- Specifications: Formal Specifications for the Technical Requirements
- Discussion and Documentation
- Database Schema Diagrams
- [Third Party Documentation](Third Party Documentation): Documentation on third-party software and applications being used
- [Historical Documentation](Historical Documentation): Documentation on previous iterations of SNAC
- Technical Discussions: Technical discussions related to the SNAC project
- Notes: Notes from the technical team.
- Help: Help on using Gitlab, Git, and the Markdown text format
This repository is stored in Gitlab, a work-alike clone of the Github web site, but installed locally on a SNAC server. Gitlab is a version control system with a suite of project management tools.
Ideally we will all create documentation in markdown format (.md files). You may create and edit files from the web interface here on Gitlab, or download files and edit locally. You can also upload any file type using standard git commands, or use a Git graphical client (see below). Choose a relevant directory for your docs, or create a new directory as necessary.
Markdown files are simple text files, which makes them easy to edit and universally portable. Markdown has a limited set of conventions to denote headers, lists, URLs and so on. When uploaded to gitlab or github, markdown files are rendered into nicely styled HTML. Tools are available to convert markdown into .doc, .pdf, LaTex and other formats. For more information on Markdown, see this guide.
To the extent possible under law,
SNAC Cooperative
has waived all copyright and related or neighboring rights to
SNAC Documentation.
This work is published from:
United States.