History

Ben Walker 735f7a5cbc doc: Add a getting started guide

This closely mirrors what is in README.md, but
makes it part of the main doc/ pages. Ultimately,
I think README.md should link here to reduce duplicated
documentation.

Change-Id: I930bada7d7c79d202b8503675511cfb824ec86e2
Signed-off-by: Ben Walker <benjamin.walker@intel.com>
Reviewed-on: https://review.gerrithub.io/376225
Tested-by: SPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: Daniel Verkamp <daniel.verkamp@intel.com>

2017-08-31 17:15:52 -04:00

.gitignore

doc: include changelog in documentation

2017-08-28 13:44:13 -04:00

bdev.md

bdev/aio: allow user to override block size

2017-08-11 19:36:30 -04:00

blob.md

io_channel: Remove per-channel priority

2017-05-26 13:42:19 -04:00

blobfs.md

doc: Switch rocksdb to the branch spdk-v5.6.1

2017-08-16 20:24:36 -04:00

directory_structure.md

vhost: Getting Started for SPDK vhost

2017-03-29 13:09:57 -07:00

Doxyfile

doc: Add a getting started guide

2017-08-31 17:15:52 -04:00

event.md

doc: flatten Markdown docs into chapter-per-file

2017-04-30 07:58:26 -07:00

footer.html

doc: simplify HTML header and stylesheet

2017-04-28 13:13:48 -07:00

getting_started.md

doc: Add a getting started guide

2017-08-31 17:15:52 -04:00

header.html

doc: simplify HTML header and stylesheet

2017-04-28 13:13:48 -07:00

index.md

doc: Add a getting started guide

2017-08-31 17:15:52 -04:00

ioat.md

doc: flatten Markdown docs into chapter-per-file

2017-04-30 07:58:26 -07:00

iscsi.md

doc: Add notice about release share memory.

2017-08-02 18:14:03 -04:00

Makefile

doc: include changelog in documentation

2017-08-28 13:44:13 -04:00

memory.md

Add documentation explaining memory management

2017-06-15 14:11:58 -04:00

nvme-cli.md

doc: add the documentation for nvme-cli support

2017-07-19 13:52:14 -04:00

nvme.md

doc: Improve NVMe documentation entry page

2017-06-22 15:49:28 -04:00

nvmf.md

doc: Add notice about release share memory.

2017-08-02 18:14:03 -04:00

porting.md

doc: move porting guide into doc/ and add to index

2017-01-17 16:25:04 -07:00

README.md

Change doc link to new spdk.io/doc location

2016-12-19 15:57:12 -07:00

stylesheet.css

doc: simplify HTML header and stylesheet

2017-04-28 13:13:48 -07:00

vhost.md

doc: update vhost known bugs section

2017-08-10 13:35:18 -04:00

README.md

SPDK Documentation

The current version of the SPDK documentation can be found online at http://www.spdk.io/doc/

Building the Documentation

To convert the documentation into HTML, install Doxygen and mscgen and run make in the doc directory. The output will be located in doc/output/html.