DPDK patches and discussions
 help / color / mirror / Atom feed
* [dpdk-dev] [PATCH v1] doc: rearrange the high level documentation index
@ 2016-11-11 13:45 John McNamara
  2016-11-11 13:53 ` Mcnamara, John
  2016-11-13 14:20 ` Thomas Monjalon
  0 siblings, 2 replies; 4+ messages in thread
From: John McNamara @ 2016-11-11 13:45 UTC (permalink / raw)
  To: dev; +Cc: John McNamara

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

^ permalink raw reply	[flat|nested] 4+ messages in thread

end of thread, other threads:[~2016-11-13 14:20 UTC | newest]

Thread overview: 4+ messages (download: mbox.gz / follow: Atom feed)
-- links below jump to the message on this page --
2016-11-11 13:45 [dpdk-dev] [PATCH v1] doc: rearrange the high level documentation index John McNamara
2016-11-11 13:53 ` Mcnamara, John
2016-11-11 16:48   ` Thomas Monjalon
2016-11-13 14:20 ` Thomas Monjalon

This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).