From: John McNamara <john.mcnamara@intel.com>
To: dev@dpdk.org
Cc: John McNamara <john.mcnamara@intel.com>
Subject: [dpdk-dev] [PATCH v1] doc: rearrange the high level documentation index
Date: Fri, 11 Nov 2016 13:45:55 +0000 [thread overview]
Message-ID: <1478871955-6106-1-git-send-email-john.mcnamara@intel.com> (raw)
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
next reply other threads:[~2016-11-11 13:45 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-11 13:45 John McNamara [this message]
2016-11-11 13:53 ` Mcnamara, John
2016-11-11 16:48 ` Thomas Monjalon
2016-11-13 14:20 ` Thomas Monjalon
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=1478871955-6106-1-git-send-email-john.mcnamara@intel.com \
--to=john.mcnamara@intel.com \
--cc=dev@dpdk.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
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).