Skip to content
HTML CSS JavaScript Other
Branch: master
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.
docs
examples
template
w
.gitignore
.nojekyll
LICENSE
Makefile
README.md
getcontent.sh
index.html
reference.md.tmpl

README.md

OpenStorage API Website

This stores the sources and output for https://libopenstorage.github.io. This website is created using gitbook. All sources and markdown files are in the docs directory. The output html created by gitbook is located in w directory.

Environment setup

First, you may need to install npm. Then install gitbook:

$ npm install -g gitbook-cli

To build:

make

To serve locally on http://localhost:4000 while editing, run:

make serve

Generating API Documentation

To generate it, you will need to install protoc-gen-doc

Then type make api to generate the API documentation.

Releasing

When releasing new version use the following method to maintain that release version on the documentation website:

  1. Add an entry to getcontent.sh
  2. Edit reference.md.tmpl
  3. Add an entry in the reference in docs/SUMMARY.md
  4. Create docs/swagger-ui/<branch>.index.html and adjust the json file accordingly

More information

You can’t perform that action at this time.