Skip to content

Commit 8c441f6

Browse files
lpabonlpabon
committed
added concepts outline
1 parent 0ffbb6f commit 8c441f6

24 files changed

Lines changed: 3354 additions & 299 deletions

‎docs/SUMMARY.md‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,11 @@
11
### Concepts
22
* [Introduction](README.md)
3+
* [Status](status.md)
4+
* [Architecture](arch.md)
5+
* [Installing](installing.md)
36

47
### Reference
8+
* [Overview](reference.md)
59
* [Clusters](clusters/README.md)
610
* [alerts](clusters/alerts.md)
711
* [enumerate](clusters/enumerate.md)

‎docs/arch.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Architecture

‎docs/installing.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Installing OpenStorage SDK

‎docs/reference.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
# Reference
2+
3+
OpenStorage provides multiple API packages to manage the storage system.

‎docs/status.md‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
# Status

‎w/Code.html‎

Lines changed: 81 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -116,6 +116,51 @@
116116

117117

118118

119+
</li>
120+
121+
<li class="chapter " data-level="1.2" data-path="status.html">
122+
123+
<a href="status.html">
124+
125+
126+
<b>1.2.</b>
127+
128+
Status
129+
130+
</a>
131+
132+
133+
134+
</li>
135+
136+
<li class="chapter " data-level="1.3" data-path="arch.html">
137+
138+
<a href="arch.html">
139+
140+
141+
<b>1.3.</b>
142+
143+
Architecture
144+
145+
</a>
146+
147+
148+
149+
</li>
150+
151+
<li class="chapter " data-level="1.4" data-path="installing.html">
152+
153+
<a href="installing.html">
154+
155+
156+
<b>1.4.</b>
157+
158+
Installing
159+
160+
</a>
161+
162+
163+
119164
</li>
120165

121166

@@ -125,13 +170,28 @@
125170

126171

127172

128-
<li class="chapter " data-level="2.1" data-path="clusters/">
173+
<li class="chapter " data-level="2.1" data-path="reference.html">
129174

130-
<a href="clusters/">
175+
<a href="reference.html">
131176

132177

133178
<b>2.1.</b>
134179

180+
Overview
181+
182+
</a>
183+
184+
185+
186+
</li>
187+
188+
<li class="chapter " data-level="2.2" data-path="clusters/">
189+
190+
<a href="clusters/">
191+
192+
193+
<b>2.2.</b>
194+
135195
Clusters
136196

137197
</a>
@@ -141,12 +201,12 @@
141201
<ul class="articles">
142202

143203

144-
<li class="chapter " data-level="2.1.1" data-path="clusters/alerts.html">
204+
<li class="chapter " data-level="2.2.1" data-path="clusters/alerts.html">
145205

146206
<a href="clusters/alerts.html">
147207

148208

149-
<b>2.1.1.</b>
209+
<b>2.2.1.</b>
150210

151211
alerts
152212

@@ -156,12 +216,12 @@
156216

157217
</li>
158218

159-
<li class="chapter " data-level="2.1.2" data-path="clusters/enumerate.html">
219+
<li class="chapter " data-level="2.2.2" data-path="clusters/enumerate.html">
160220

161221
<a href="clusters/enumerate.html">
162222

163223

164-
<b>2.1.2.</b>
224+
<b>2.2.2.</b>
165225

166226
enumerate
167227

@@ -171,12 +231,12 @@
171231

172232
</li>
173233

174-
<li class="chapter " data-level="2.1.3" data-path="clusters/getnodeidfromip.html">
234+
<li class="chapter " data-level="2.2.3" data-path="clusters/getnodeidfromip.html">
175235

176236
<a href="clusters/getnodeidfromip.html">
177237

178238

179-
<b>2.1.3.</b>
239+
<b>2.2.3.</b>
180240

181241
get node id from ip
182242

@@ -186,12 +246,12 @@
186246

187247
</li>
188248

189-
<li class="chapter " data-level="2.1.4" data-path="clusters/inspect.html">
249+
<li class="chapter " data-level="2.2.4" data-path="clusters/inspect.html">
190250

191251
<a href="clusters/inspect.html">
192252

193253

194-
<b>2.1.4.</b>
254+
<b>2.2.4.</b>
195255

196256
inspect
197257

@@ -201,12 +261,12 @@
201261

202262
</li>
203263

204-
<li class="chapter " data-level="2.1.5" data-path="clusters/remove.html">
264+
<li class="chapter " data-level="2.2.5" data-path="clusters/remove.html">
205265

206266
<a href="clusters/remove.html">
207267

208268

209-
<b>2.1.5.</b>
269+
<b>2.2.5.</b>
210270

211271
remove
212272

@@ -216,12 +276,12 @@
216276

217277
</li>
218278

219-
<li class="chapter " data-level="2.1.6" data-path="clusters/setsize.html">
279+
<li class="chapter " data-level="2.2.6" data-path="clusters/setsize.html">
220280

221281
<a href="clusters/setsize.html">
222282

223283

224-
<b>2.1.6.</b>
284+
<b>2.2.6.</b>
225285

226286
setsize
227287

@@ -231,12 +291,12 @@
231291

232292
</li>
233293

234-
<li class="chapter " data-level="2.1.7" data-path="clusters/status.html">
294+
<li class="chapter " data-level="2.2.7" data-path="clusters/status.html">
235295

236296
<a href="clusters/status.html">
237297

238298

239-
<b>2.1.7.</b>
299+
<b>2.2.7.</b>
240300

241301
status
242302

@@ -246,12 +306,12 @@
246306

247307
</li>
248308

249-
<li class="chapter " data-level="2.1.8" data-path="clusters/versions.html">
309+
<li class="chapter " data-level="2.2.8" data-path="clusters/versions.html">
250310

251311
<a href="clusters/versions.html">
252312

253313

254-
<b>2.1.8.</b>
314+
<b>2.2.8.</b>
255315

256316
versions
257317

@@ -266,12 +326,12 @@
266326

267327
</li>
268328

269-
<li class="chapter " data-level="2.2" data-path="volumes/">
329+
<li class="chapter " data-level="2.3" data-path="volumes/">
270330

271331
<a href="volumes/">
272332

273333

274-
<b>2.2.</b>
334+
<b>2.3.</b>
275335

276336
Volumes
277337

@@ -451,7 +511,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
451511
<script>
452512
var gitbook = gitbook || [];
453513
gitbook.push(function() {
454-
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":"Volumes","level":"2.2","depth":1,"path":"volumes/README.md","ref":"volumes/README.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-02T20:25:35.215Z"},"basePath":".","book":{"language":""}});
514+
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":"Volumes","level":"2.3","depth":1,"path":"volumes/README.md","ref":"volumes/README.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-28T18:16:34.603Z","type":"markdown"},"gitbook":{"version":"3.2.3","time":"2018-04-09T04:06:42.930Z"},"basePath":".","book":{"language":""}});
455515
});
456516
</script>
457517
</div>

0 commit comments

Comments
 (0)