yume/juniper
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
juniper/docs/book
History
Christian Legnitto b96879e2db Add a git ssh origin when pushing docs 
Azure apparently downloads the source via http,
so when we go to push the ssh keychain is not used.
adding origin shoudl fix it, as was done in
https://cloudblogs.microsoft.com/opensource/2019/04/05/publishing-github-pages-from-azure-pipelines/
2019-04-16 21:52:58 -07:00
..
content (book) Remove inexistant tutorial link 2019-04-10 03:00:35 +02:00
tests Add support for the canonical introspection query 2019-04-04 09:11:20 +02:00
.gitignore (book) Update and fix book compilation and tests 2019-03-08 11:47:13 +01:00
book.toml (book) Update and fix book compilation and tests 2019-03-08 11:47:13 +01:00
ci-build.sh Add a git ssh origin when pushing docs 2019-04-16 21:52:58 -07:00
README.md (book) Update and fix book compilation and tests 2019-03-08 11:47:13 +01:00
yarn.lock (book) Update and fix book compilation and tests 2019-03-08 11:47:13 +01:00

README.md

Juniper Book

Book containing the Juniper documentation.

Contributing

Requirements

The book is built with mdBook.

You can install it with:

cargo install mdbook

Starting a local test server

To launch a local test server that continually re-builds the book and autoreloads the page, run:

mdbook serve

Building the book

You can build the book to rendered HTML with this command:

mdbook build

The output will be in the ./_rendered directory.

Running the tests

To run the tests validating all code examples in the book, run:

cd ./tests
cargo test

Test setup

All Rust code examples in the book are compiled on the CI.

This is done using the skeptic library.