You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
This repo is archived. You can view files and clone it, but cannot push or open issues/pull-requests.
 
 
Chris Mahoney c40729f8d9 Document COLO rack and get some data on elephant 2 months ago
src Document COLO rack and get some data on elephant 2 months ago
theme document table changes 3 months ago
.gitignore init book 3 months ago
Dockerfile setup mdbook to auto update 3 months ago
README.md Add content to the README 3 months ago
book.toml reformat project structure 3 months ago
docker-compose.yml docker 3 months ago
nginx.conf docker 3 months ago

README.md

book

An online copy of the COSI book is currently hosted at https://book.cosi.clarkson.edu.

Invest in documentation and prefer simple solutions that are maintainable and transferable to others.

This repo is intended to be our new documentation solution for the labs. It's easy to serve, it's convenient to keep an offline copy, and it's backed with markdown.

Development

The COSI book is built with mdbook. Its highly recommended you skim over the User Guide to get a jist for how the tool works. If you would like to preview your changes while you code follow these steps to setup mdbook.

  1. Install the rust programming lanague.
  2. After setting up rust run cargo install mdbook to get the latest version of the tool.
  3. Clone this repo git clone https://gitea.cosi.clarkson.edu/COSI_Maintainers/book
  4. Within the repo run mdbook serve
  5. Document!

It is not strictly necessary to install mdbook to contribute to the book.

Deployment

Until we get a good webhook solution updates to this repo must be manually deployed on dubsdot2.

As root on dubsdot2 run:

cd /opt/book
git pull
docker-compose up --build -d

If you notice mdbook has been updated and it needs to be recompiled run:

docker-compose build --no-cache
docker-compose up -d