Commit c94bb669 authored by Daniel Verkamp's avatar Daniel Verkamp Committed by Jim Harris
Browse files

doc: add a section for user guides 



Change-Id: I8982bf656adc4fec6990cdd95e5ece71fb0a953b
Signed-off-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Reviewed-on: https://review.gerrithub.io/379907


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarChangpeng Liu <changpeng.liu@intel.com>
Reviewed-by: default avatarJim Harris <james.r.harris@intel.com>
parent 130d278a

doc/index.md

+6 −0
Original line number Diff line number Diff line
@@ -6,6 +6,12 @@ 
- @ref changelog

- [Source Code (GitHub)](https://github.com/spdk/spdk/)



# User Guides {#user_guides}



- @ref iscsi_getting_started

- @ref nvmf_getting_started

- @ref blobfs_getting_started



# General Information {#general}



 - @ref directory_structure

doc/iscsi.md

+1 −1
Original line number Diff line number Diff line 
# iSCSI Target {#iscsi}



# Getting Started Guide {#iscsi_getting_started}

# iSCSI Target Getting Started Guide {#iscsi_getting_started}



The Intel(R) Storage Performance Development Kit iSCSI target application is named `iscsi_tgt`.

This following section describes how to run iscsi from your cloned package.

doc/nvmf.md

+1 −1
Original line number Diff line number Diff line
@@ -3,7 +3,7 @@ 
@sa @ref nvme_fabrics_host





# Getting Started Guide {#nvmf_getting_started}

# NVMe-oF Target Getting Started Guide {#nvmf_getting_started}



The NVMe over Fabrics target is a user space application that presents block devices over the

network using RDMA. It requires an RDMA-capable NIC with its corresponding OFED software package