PeachCloud/peach-devdocs
0
0
Fork 0
Code Issues 1 Pull Requests Projects Releases Wiki Activity
Developer documentation for PeachCloud in the form of a Markdown book.
83 Commits 1 Branch 0 Tags 461 KiB
JavaScript 41.6%
CSS 33.4%
Handlebars 25%
main
Go to file
Max Fowler 039ffeff9f
Merge pull request #18 from peachcloud/setup-guides 
Add setup guides
2021-03-29 15:41:54 +02:00
src Add sections for peach-package-builder and peach-img-builder 2021-03-29 12:04:43 +02:00
.gitignore Add flags to quick_deployment.md 2020-11-20 13:23:19 +01:00
.travis.yml Fix syntax highlighting and remove CI code tests 2020-10-22 13:37:09 +01:00
book.toml Initial commit with draft chapter outline 2019-10-14 19:01:25 +01:00
GITHOOK_DEPLOYMENT.md Fix formatting 2020-10-23 10:57:56 +01:00
notes Update notes with question about RTC 2020-10-16 10:44:19 +01:00
README.md Bump version 2021-03-04 08:47:52 +00:00

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