From patchwork Fri Nov 11 13:45:55 2016 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: John McNamara X-Patchwork-Id: 17005 Return-Path: X-Original-To: patchwork@dpdk.org Delivered-To: patchwork@dpdk.org Received: from [92.243.14.124] (localhost [IPv6:::1]) by dpdk.org (Postfix) with ESMTP id 9B147D57C; Fri, 11 Nov 2016 14:46:00 +0100 (CET) Received: from mga07.intel.com (mga07.intel.com [134.134.136.100]) by dpdk.org (Postfix) with ESMTP id 6FE4ED57A for ; Fri, 11 Nov 2016 14:45:58 +0100 (CET) Received: from orsmga003.jf.intel.com ([10.7.209.27]) by orsmga105.jf.intel.com with ESMTP; 11 Nov 2016 05:45:57 -0800 X-ExtLoop1: 1 X-IronPort-AV: E=Sophos;i="5.31,621,1473145200"; d="scan'208";a="900369639" Received: from sivswdev02.ir.intel.com (HELO localhost.localdomain) ([10.237.217.46]) by orsmga003.jf.intel.com with ESMTP; 11 Nov 2016 05:45:56 -0800 From: John McNamara To: dev@dpdk.org Cc: John McNamara Date: Fri, 11 Nov 2016 13:45:55 +0000 Message-Id: <1478871955-6106-1-git-send-email-john.mcnamara@intel.com> X-Mailer: git-send-email 1.7.0.7 Subject: [dpdk-dev] [PATCH v1] doc: rearrange the high level documentation index X-BeenThere: dev@dpdk.org X-Mailman-Version: 2.1.15 Precedence: list List-Id: patches and discussions about DPDK List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: dev-bounces@dpdk.org Sender: "dev" Rearrange the order of the high level documenation index into a more logical sequence for a new user. Also, improve some of the high-level document names. Signed-off-by: John McNamara --- After this patch the high-level index will look like this: DPDK documentation * Getting Started Guide for Linux * Getting Started Guide for FreeBSD * Sample Applications User Guides * Programmer's Guide * HowTo Guides * DPDK Tools User Guides * Testpmd Application User Guide * Network Interface Controller Drivers * Crypto Device Drivers * Xen Guide * Contributor's Guidelines * Release Notes * FAQ doc/guides/howto/index.rst | 4 ++-- doc/guides/index.rst | 14 +++++++------- doc/guides/sample_app_ug/index.rst | 4 ++-- doc/guides/tools/index.rst | 4 ++-- 4 files changed, 13 insertions(+), 13 deletions(-) diff --git a/doc/guides/howto/index.rst b/doc/guides/howto/index.rst index aa6d3e2..5575b27 100644 --- a/doc/guides/howto/index.rst +++ b/doc/guides/howto/index.rst @@ -28,8 +28,8 @@ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -How To User Guides -================== +HowTo Guides +============ .. toctree:: :maxdepth: 2 diff --git a/doc/guides/index.rst b/doc/guides/index.rst index 57570f6..82b00e9 100644 --- a/doc/guides/index.rst +++ b/doc/guides/index.rst @@ -36,14 +36,14 @@ DPDK documentation linux_gsg/index freebsd_gsg/index - xen/index - prog_guide/index - nics/index - cryptodevs/index sample_app_ug/index + prog_guide/index + howto/index tools/index testpmd_app_ug/index - faq/index - howto/index - rel_notes/index + nics/index + cryptodevs/index + xen/index contributing/index + rel_notes/index + faq/index diff --git a/doc/guides/sample_app_ug/index.rst b/doc/guides/sample_app_ug/index.rst index cce0a9b..775e2f7 100644 --- a/doc/guides/sample_app_ug/index.rst +++ b/doc/guides/sample_app_ug/index.rst @@ -28,8 +28,8 @@ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -Sample Applications User Guide -============================== +Sample Applications User Guides +=============================== .. toctree:: :maxdepth: 2 diff --git a/doc/guides/tools/index.rst b/doc/guides/tools/index.rst index cbe98b2..513221c 100644 --- a/doc/guides/tools/index.rst +++ b/doc/guides/tools/index.rst @@ -28,8 +28,8 @@ (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -Tool User Guides -================ +DPDK Tools User Guides +====================== .. toctree:: :maxdepth: 2