From: Stephen Hemminger <stephen@networkplumber.org>
To: dev@dpdk.org
Cc: Stephen Hemminger <stephen@networkplumber.org>
Subject: [RFC v2 2/2] doc: restructure the introduction
Date: Mon, 30 Sep 2024 09:19:36 -0700 [thread overview]
Message-ID: <20240930161942.8097-2-stephen@networkplumber.org> (raw)
In-Reply-To: <20240930161942.8097-1-stephen@networkplumber.org>
Add some basic description about the project.
Rearrange the guide to put glossary and project information first.
Break the main page into sections.
Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
doc/guides/index.rst | 35 ++++++++++++++++++++++++++++++-----
1 file changed, 30 insertions(+), 5 deletions(-)
diff --git a/doc/guides/index.rst b/doc/guides/index.rst
index 5cec8a8287..1824f26bf1 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/index.rst
@@ -1,20 +1,48 @@
.. SPDX-License-Identifier: BSD-3-Clause
Copyright(c) 2010-2019 Intel Corporation.
-DPDK documentation
-==================
+############################################
+What is the Dataplane Development Kit (DPDK)
+############################################
+
+The Dataplane Development Kit (DPDK) is a set of libraries to accelerate packet processing
+workloads running on a wide variety of CPU architectures.
+
+Network performance, throughput, and latency are crucial for diverse applications, including wireless and wireline infrastructure, routers, load balancers, firewalls, video streaming, and VoIP. DPDK (Data Plane Development Kit), an open source project hosted by the Linux Foundation, provides a robust framework that boosts packet processing speeds on various CPU architectures like Intel x86, ARM, and PowerPC. This framework is key to rapidly developing high-speed data packet networking applications.
+
+By running DPDK, new users can significantly accelerate their network applications’ performance due to its efficient run-to-completion model and optimized libraries that ensure all necessary resources are allocated upfront.
+
+.. toctree::
+ :caption: About DPDK
+ :maxdepth: 1
+
+ glossary/index
+ contributing/index
+ rel_notes/index
+ faq/index
.. toctree::
+ :caption: Getting Started
:maxdepth: 1
linux_gsg/index
freebsd_gsg/index
windows_gsg/index
sample_app_ug/index
+
+.. toctree::
+ :caption: Programmers Guide
+ :maxdepth: 1
+
prog_guide/index
howto/index
tools/index
testpmd_app_ug/index
+
+.. toctree::
+ :caption: Device Drivers
+ :maxdepth: 1
+
nics/index
bbdevs/index
cryptodevs/index
@@ -28,7 +56,4 @@ DPDK documentation
rawdevs/index
mempool/index
platform/index
- contributing/index
glossary/index
- rel_notes/index
- faq/index
--
2.45.2
prev parent reply other threads:[~2024-09-30 16:19 UTC|newest]
Thread overview: 3+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-09-11 4:27 [RFC] " Stephen Hemminger
2024-09-30 16:19 ` [RFC v2 1/2] doc: move glossary to intro Stephen Hemminger
2024-09-30 16:19 ` Stephen Hemminger [this message]
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=20240930161942.8097-2-stephen@networkplumber.org \
--to=stephen@networkplumber.org \
--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).