search

xapi-project / xapi-storage

Experimental new storage interface for xapi
https://xapi-project.github.io/xapi-storage/
9 stars 19 forks source link

CP-27826: Automatically update Slate docs from generated markdown files #83

Closed gaborigloi closed 6 years ago

gaborigloi commented 6 years ago

And remove the old HTML docs. The new docs are in the slate branch, we push there the new generated markdown files. The Travis build of that branch updates the gh-pages branch containing the actual website.

Signed-off-by: Gabor Igloi gabor.igloi@citrix.com

gaborigloi commented 6 years ago

It's already online: https://xapi-project.github.io/xapi-storage :)

mseri commented 6 years ago

+14 −35,497

olivierlambert commented 6 years ago

Thanks for the doc guys! Is there a way to add a very simple example? I don't know, NFS or local ext?

gaborigloi commented 6 years ago

I don't know of any up to date one, and the SMAPIv3 interface has not been finalized yet, but there is an outdated example here: https://github.com/xapi-project/ffs . The code examples at the right hand side of https://xapi-project.github.io/xapi-storage document the expected return value.

olivierlambert commented 6 years ago

okay, I'll take a look. When you'll finalize the smapiv3 interface, please make a simple example, I'm eager to write "plugins"!