diff --git a/doc/index.md b/doc/index.md index d3bf47abe..2e93afa96 100644 --- a/doc/index.md +++ b/doc/index.md @@ -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 diff --git a/doc/iscsi.md b/doc/iscsi.md index 21b5fbaff..6aa0e39f8 100644 --- a/doc/iscsi.md +++ b/doc/iscsi.md @@ -1,6 +1,6 @@ # 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. diff --git a/doc/nvmf.md b/doc/nvmf.md index 45961b16a..24ffcc373 100644 --- a/doc/nvmf.md +++ b/doc/nvmf.md @@ -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