From: "Mcnamara, John" <john.mcnamara@intel.com>
To: "dev@dpdk.org" <dev@dpdk.org>
Subject: Re: [dpdk-dev] [PATCH v1] doc: rearrange the high level documentation index
Date: Fri, 11 Nov 2016 13:53:38 +0000 [thread overview]
Message-ID: <B27915DBBA3421428155699D51E4CFE20264D84C@IRSMSX103.ger.corp.intel.com> (raw)
In-Reply-To: <1478871955-6106-1-git-send-email-john.mcnamara@intel.com>
> -----Original Message-----
> From: Mcnamara, John
> Sent: Friday, November 11, 2016 1:46 PM
> To: dev@dpdk.org
> Cc: Mcnamara, John <john.mcnamara@intel.com>
> Subject: [PATCH v1] doc: rearrange the high level documentation index
>
> 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
P.S.,
I would prefer not to have some of these are highest level items such as
"Xen Guide", and possibly "Crypto Device Drivers". Perhaps we could push
them down a level with "Network Interface Controller Drivers" under a
"Devices and Drivers" (or similar) section like:
* ...
* Programmer's Guide
* HowTo Guides
* DPDK Tools User Guides
* Devices and Drivers
* Network Interface Controller Drivers
* Crypto Device Drivers
* Xen Guide
* ...
next prev parent reply other threads:[~2016-11-11 13:53 UTC|newest]
Thread overview: 4+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-11-11 13:45 John McNamara
2016-11-11 13:53 ` Mcnamara, John [this message]
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=B27915DBBA3421428155699D51E4CFE20264D84C@IRSMSX103.ger.corp.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).