MdBook source for the Rusoto project (https://github.com/rusoto/rusoto)
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
rusoto_docs_tester Delete the cargo.lock file. Nov 22, 2018
src Merge pull request #98 from rusoto/add-extensions-page Nov 22, 2018
.gitignore Update for Rusoto 0.35.0 Nov 22, 2018
.travis.yml Run skeptic on our code. Sep 28, 2018
README.md Version update Oct 11, 2018
book.toml Try to get mdbook workin'. Sep 9, 2018

README.md

rusoto.github.io

Build Status

mdBook documentation for the rusoto project.

Publishing

Any changes made to the documentation will automatically get published to rusoto.org via Travis CI once the changes are merged into the source branch.

Requirements

Development

Install with cargo install mdbook --vers "^0.2.0".

mdbook watch will regenerate the static output HTML whenever a source file is changed. Use mdbook watch --open to open the files in your browser.

Branch Explanation

This repo has a slightly unconventional branching setup. This is leftover from when it was hosted on GitHub Pages:

Most GitHub Pages-based repos tend to use master for the source, and gh-pages for the rendered website. Because this repo is intended to host an organization webpage, then per GitHub's requirements the rendered website MUST appear on the master branch. Since the master branch can no longer be used to hold the source, a separate branch must be made for that, which in this case is called source.