[dpdk-dev] [PATCH v1] doc: rearrange the high level documentation index
Mcnamara, John
john.mcnamara at intel.com
Fri Nov 11 14:53:38 CET 2016
> -----Original Message-----
> From: Mcnamara, John
> Sent: Friday, November 11, 2016 1:46 PM
> To: dev at dpdk.org
> Cc: Mcnamara, John <john.mcnamara at 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 at 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
* ...
More information about the dev
mailing list