https://github.com/libopenstorage/libopenstorage.github.io
Content for https://libopenstorage.github.io
https://github.com/libopenstorage/libopenstorage.github.io
Last synced: over 1 year ago
JSON representation
Content for https://libopenstorage.github.io
- Host: GitHub
- URL: https://github.com/libopenstorage/libopenstorage.github.io
- Owner: libopenstorage
- License: apache-2.0
- Created: 2018-03-29T18:42:08.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2024-01-16T22:56:20.000Z (over 2 years ago)
- Last Synced: 2025-01-12T20:42:10.124Z (over 1 year ago)
- Language: HTML
- Homepage:
- Size: 21.1 MB
- Stars: 1
- Watchers: 3
- Forks: 4
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# OpenStorage API Website
This stores the sources and output for https://libopenstorage.github.io.
## Build the website
To build:
```
make
```
To serve locally on `http://localhost:4000` while editing, run:
```
make serve
```
## 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`
1. Edit `reference.md.tmpl`
1. Add an entry in the reference in `mkdocs.yml'
1. Create `docs/swagger-ui/.index.html` and adjust the json file accordingly