Skip to content

Commit 519cb8a

Browse files
lpabonlpabon
committed
Supports Ditaa images
1 parent 645ccb0 commit 519cb8a

70 files changed

Lines changed: 359 additions & 61 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎Makefile‎

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,12 @@
11
all: build
22

3-
build:
3+
images:
4+
$(MAKE) -C docs/images
5+
6+
build: images
47
gitbook build docs/ w
58

6-
serve:
9+
serve: images
710
gitbook serve docs/ w
811

912
# If you have updated any plugins in docs/book.json from https://plugins.gitbook.com/
@@ -12,4 +15,4 @@ update-modules:
1215
cd docs && rm -rf node_modules && gitbook install
1316

1417

15-
.PHONY: all build serve
18+
.PHONY: all build serve images

‎docs/README.md‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
# OpenStorage Library API
22

3+
![sdk.png](images/sdk.png)
4+
35
## Introduction
46
Welcome to the _OpenStorage Library API_ documentation. Here you will find the API functions, examples, and references to multiple client libraries which can communicate with a OpenStorage REST server.
57

‎docs/images/Makefile‎

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
HAS_DITAA := $(shell command -v ditaa 2> /dev/null)
2+
3+
DITAA_IMAGES := arch.png sdk.png
4+
DITAA_SRCS := $(patsubst %.png,%.ditaa,$(DITAA_IMAGES))
5+
6+
all: $(DITAA_IMAGES)
7+
8+
%.png: %.ditaa
9+
ifndef HAS_DITAA
10+
$(error "Please install ditaa to create images")
11+
endif
12+
$(info $(DITAA_SRCS))
13+
ditaa -o $<
14+
15+
clean:
16+
rm -f $(DITAA_IMAGES)
17+
18+
.PHONY: all

‎docs/images/arch.ditaa‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
+----------------------------------+
2+
| |
3+
| gRPC SDK |
4+
| |
5+
+----------------------------------+
6+
| |
7+
| OpenStorage Interfaces |
8+
| |
9+
+----------------------------------+

‎docs/images/arch.png‎

4 KB
Loading

‎docs/images/sdk.ditaa‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
+---------------+
2+
+---------------+ | |
3+
| gRPC Client | ---> | OpenStorage |
4+
+---------------+ | |
5+
+---------------+

‎docs/images/sdk.png‎

3.14 KB
Loading

‎w/Code.html‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1138,7 +1138,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
11381138
<script>
11391139
var gitbook = gitbook || [];
11401140
gitbook.push(function() {
1141-
gitbook.page.hasChanged({"page":{"title":"_Website tests","level":"3.1","depth":1,"next":{"title":"_WebTest","level":"3.1.1","depth":2,"path":"More.md","ref":"More.md","articles":[]},"previous":{"title":"enumerate","level":"2.3.5.10.3","depth":4,"path":"volumes/backups/scheds/enumerate.md","ref":"volumes/backups/scheds/enumerate.md","articles":[]},"dir":"ltr"},"config":{"plugins":["codetabs","toggle-chapters","toggle-headers","edit-link","prism","github","page-toc","-highlight","-sharing"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{},"github":{"url":"https://github.com/libopenstorage/openstorage/"},"search":{},"page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2","showByDefault":true},"codetabs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"toggle-headers":{},"fontsettings":{"theme":"white","family":"sans","size":2},"edit-link":{"label":"Edit this page","base":"https://github.com/libopenstorage/libopenstorage.github.io/tree/master/docs"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":true},"toggle-chapters":{}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"OpenStorage API","gitbook":">=3.2.1"},"file":{"path":"Code.md","mtime":"2018-03-29T19:06:14.770Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-04-09T19:12:08.359Z"},"basePath":".","book":{"language":""}});
1141+
gitbook.page.hasChanged({"page":{"title":"_Website tests","level":"3.1","depth":1,"next":{"title":"_WebTest","level":"3.1.1","depth":2,"path":"More.md","ref":"More.md","articles":[]},"previous":{"title":"enumerate","level":"2.3.5.10.3","depth":4,"path":"volumes/backups/scheds/enumerate.md","ref":"volumes/backups/scheds/enumerate.md","articles":[]},"dir":"ltr"},"config":{"plugins":["codetabs","toggle-chapters","toggle-headers","edit-link","prism","github","page-toc","-highlight","-sharing","livereload"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{},"github":{"url":"https://github.com/libopenstorage/openstorage/"},"livereload":{},"search":{},"page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2","showByDefault":true},"codetabs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"toggle-headers":{},"fontsettings":{"theme":"white","family":"sans","size":2},"edit-link":{"label":"Edit this page","base":"https://github.com/libopenstorage/libopenstorage.github.io/tree/master/docs"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":true},"toggle-chapters":{}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"OpenStorage API","gitbook":">=3.2.1"},"file":{"path":"Code.md","mtime":"2018-03-28T18:16:34.603Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-04-30T12:11:57.898Z"},"basePath":".","book":{"language":""}});
11421142
});
11431143
</script>
11441144
</div>
@@ -1176,6 +1176,10 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
11761176

11771177

11781178

1179+
<script src="gitbook/gitbook-plugin-livereload/plugin.js"></script>
1180+
1181+
1182+
11791183
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
11801184

11811185

‎w/Last.html‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1111,7 +1111,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
11111111
<script>
11121112
var gitbook = gitbook || [];
11131113
gitbook.push(function() {
1114-
gitbook.page.hasChanged({"page":{"title":"Last","level":"3.1.2","depth":2,"previous":{"title":"_WebTest","level":"3.1.1","depth":2,"path":"More.md","ref":"More.md","articles":[]},"dir":"ltr"},"config":{"plugins":["codetabs","toggle-chapters","toggle-headers","edit-link","prism","github","page-toc","-highlight","-sharing"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{},"github":{"url":"https://github.com/libopenstorage/openstorage/"},"search":{},"page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2","showByDefault":true},"codetabs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"toggle-headers":{},"fontsettings":{"theme":"white","family":"sans","size":2},"edit-link":{"label":"Edit this page","base":"https://github.com/libopenstorage/libopenstorage.github.io/tree/master/docs"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":true},"toggle-chapters":{}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"OpenStorage API","gitbook":">=3.2.1"},"file":{"path":"Last.md","mtime":"2018-03-29T19:06:14.770Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-04-09T19:12:08.359Z"},"basePath":".","book":{"language":""}});
1114+
gitbook.page.hasChanged({"page":{"title":"Last","level":"3.1.2","depth":2,"previous":{"title":"_WebTest","level":"3.1.1","depth":2,"path":"More.md","ref":"More.md","articles":[]},"dir":"ltr"},"config":{"plugins":["codetabs","toggle-chapters","toggle-headers","edit-link","prism","github","page-toc","-highlight","-sharing","livereload"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{},"github":{"url":"https://github.com/libopenstorage/openstorage/"},"livereload":{},"search":{},"page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2","showByDefault":true},"codetabs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"toggle-headers":{},"fontsettings":{"theme":"white","family":"sans","size":2},"edit-link":{"label":"Edit this page","base":"https://github.com/libopenstorage/libopenstorage.github.io/tree/master/docs"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":true},"toggle-chapters":{}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"OpenStorage API","gitbook":">=3.2.1"},"file":{"path":"Last.md","mtime":"2018-03-28T18:16:34.603Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-04-30T12:11:57.898Z"},"basePath":".","book":{"language":""}});
11151115
});
11161116
</script>
11171117
</div>
@@ -1149,6 +1149,10 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
11491149

11501150

11511151

1152+
<script src="gitbook/gitbook-plugin-livereload/plugin.js"></script>
1153+
1154+
1155+
11521156
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
11531157

11541158

‎w/More.html‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1128,7 +1128,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
11281128
<script>
11291129
var gitbook = gitbook || [];
11301130
gitbook.push(function() {
1131-
gitbook.page.hasChanged({"page":{"title":"_WebTest","level":"3.1.1","depth":2,"next":{"title":"Last","level":"3.1.2","depth":2,"path":"Last.md","ref":"Last.md","articles":[]},"previous":{"title":"_Website tests","level":"3.1","depth":1,"path":"Code.md","ref":"Code.md","articles":[{"title":"_WebTest","level":"3.1.1","depth":2,"path":"More.md","ref":"More.md","articles":[]},{"title":"Last","level":"3.1.2","depth":2,"path":"Last.md","ref":"Last.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["codetabs","toggle-chapters","toggle-headers","edit-link","prism","github","page-toc","-highlight","-sharing"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{},"github":{"url":"https://github.com/libopenstorage/openstorage/"},"search":{},"page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2","showByDefault":true},"codetabs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"toggle-headers":{},"fontsettings":{"theme":"white","family":"sans","size":2},"edit-link":{"label":"Edit this page","base":"https://github.com/libopenstorage/libopenstorage.github.io/tree/master/docs"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":true},"toggle-chapters":{}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"OpenStorage API","gitbook":">=3.2.1"},"file":{"path":"More.md","mtime":"2018-03-29T20:29:21.551Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-04-09T19:12:08.359Z"},"basePath":".","book":{"language":""}});
1131+
gitbook.page.hasChanged({"page":{"title":"_WebTest","level":"3.1.1","depth":2,"next":{"title":"Last","level":"3.1.2","depth":2,"path":"Last.md","ref":"Last.md","articles":[]},"previous":{"title":"_Website tests","level":"3.1","depth":1,"path":"Code.md","ref":"Code.md","articles":[{"title":"_WebTest","level":"3.1.1","depth":2,"path":"More.md","ref":"More.md","articles":[]},{"title":"Last","level":"3.1.2","depth":2,"path":"Last.md","ref":"Last.md","articles":[]}]},"dir":"ltr"},"config":{"plugins":["codetabs","toggle-chapters","toggle-headers","edit-link","prism","github","page-toc","-highlight","-sharing","livereload"],"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"pluginsConfig":{"prism":{},"github":{"url":"https://github.com/libopenstorage/openstorage/"},"livereload":{},"search":{},"page-toc":{"position":"before-first","selector":".markdown-section h1, .markdown-section h2","showByDefault":true},"codetabs":{},"lunr":{"maxIndexSize":1000000,"ignoreSpecialCharacters":false},"toggle-headers":{},"fontsettings":{"theme":"white","family":"sans","size":2},"edit-link":{"label":"Edit this page","base":"https://github.com/libopenstorage/libopenstorage.github.io/tree/master/docs"},"theme-default":{"styles":{"website":"styles/website.css","pdf":"styles/pdf.css","epub":"styles/epub.css","mobi":"styles/mobi.css","ebook":"styles/ebook.css","print":"styles/print.css"},"showLevel":true},"toggle-chapters":{}},"theme":"default","pdf":{"pageNumbers":true,"fontSize":12,"fontFamily":"Arial","paperSize":"a4","chapterMark":"pagebreak","pageBreaksBefore":"/","margin":{"right":62,"left":62,"top":56,"bottom":56}},"structure":{"langs":"LANGS.md","readme":"README.md","glossary":"GLOSSARY.md","summary":"SUMMARY.md"},"variables":{},"title":"OpenStorage API","gitbook":">=3.2.1"},"file":{"path":"More.md","mtime":"2018-03-28T18:16:34.603Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-04-30T12:11:57.898Z"},"basePath":".","book":{"language":""}});
11321132
});
11331133
</script>
11341134
</div>
@@ -1166,6 +1166,10 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
11661166

11671167

11681168

1169+
<script src="gitbook/gitbook-plugin-livereload/plugin.js"></script>
1170+
1171+
1172+
11691173
<script src="gitbook/gitbook-plugin-search/search-engine.js"></script>
11701174

11711175

0 commit comments

Comments
 (0)