From mboxrd@z Thu Jan  1 00:00:00 1970
From: John McNamara <john.mcnamara@intel.com>
Subject: [PATCH v1] doc: rearrange the high level documentation
	index
Date: Fri, 11 Nov 2016 13:45:55 +0000
Message-ID: <1478871955-6106-1-git-send-email-john.mcnamara@intel.com>
Cc: John McNamara <john.mcnamara@intel.com>
To: dev@dpdk.org
Return-path: <dev-bounces@dpdk.org>
Received: from mga07.intel.com (mga07.intel.com [134.134.136.100])
 by dpdk.org (Postfix) with ESMTP id 6FE4ED57A
 for <dev@dpdk.org>; Fri, 11 Nov 2016 14:45:58 +0100 (CET)
List-Id: patches and discussions about DPDK <dev.dpdk.org>
List-Unsubscribe: <http://dpdk.org/ml/options/dev>,
 <mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://dpdk.org/ml/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <http://dpdk.org/ml/listinfo/dev>,
 <mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
Sender: "dev" <dev-bounces@dpdk.org>

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 <john.mcnamara@intel.com>
---

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
-- 
2.7.4