Developer documentation for PeachCloud in the form of a Markdown book.
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.
 
 
 
Max Fowler 039ffeff9f
Merge pull request #18 from peachcloud/setup-guides
1 year ago
src Add sections for peach-package-builder and peach-img-builder 1 year ago
.gitignore Add flags to quick_deployment.md 2 years ago
.travis.yml Fix syntax highlighting and remove CI code tests 2 years ago
GITHOOK_DEPLOYMENT.md Fix formatting 2 years ago
README.md Bump version 1 year ago
book.toml Initial commit with draft chapter outline 3 years ago
notes Update notes with question about RTC 2 years ago

README.md

peach-devdocs

Build Status Generic badge

Developer documentation for PeachCloud in the form of a Markdown book.

Read online here >> 📖

PeachCloud physical interface

Development

Dependencies:

  • mdBook (release binaries or cargo install)
$ git clone https://github.com/peachcloud/peach-devdocs
$ cd peach-devdocs
$ mdbook serve

This serves the current state of the book at localhost:3000. When changes to any files are saved, the browser view will automatically refresh to reflect the new state.

NOTES:

  • this assumes mdbook is in your PATH
    • the command for adding the default cargo bin directory is export PATH=$PATH:~/.cargo/bin.
    • if you downloaded the prebuilt binary then make sure the directory is in your PATH

Build a release

$ mdbook serve

This builds the book into a static release ready for publishing. Currently outputs to book/ directory.

Hosting

The PeachCloud developer documentation book is hosted at docs.peachcloud.org using a simple Nginx deployment on a virtual server. HTTPS configuration is pending.

This tutorial from Digital Ocean describes the deployment process: How To Set Up Nginx Server Blocks (Virtual Hosts) on Ubuntu 16.04.

Production Deployment

Deployment of the documentation book to production is automated using Git Hooks. Refer to the GITHOOK_DEPLOYMENT.md document for setup and usage instructions.

Licensing

AGPL-3.0