diff mbox series

[RFC,v2,2/2] doc: restructure the introduction

Message ID 20240930161942.8097-2-stephen@networkplumber.org (mailing list archive)
State New
Delegated to: Thomas Monjalon
Headers
Series [RFC,v2,1/2] doc: move glossary to intro |

Checks

Context Check Description
ci/loongarch-compilation success Compilation OK
ci/checkpatch success coding style OK
ci/loongarch-unit-testing success Unit Testing PASS
ci/Intel-compilation success Compilation OK
ci/intel-Testing success Testing PASS
ci/iol-intel-Performance success Performance Testing PASS
ci/iol-mellanox-Performance success Performance Testing PASS
ci/intel-Functional success Functional PASS
ci/iol-intel-Functional success Functional Testing PASS
ci/iol-marvell-Functional success Functional Testing PASS
ci/github-robot: build success github build: passed
ci/iol-broadcom-Performance success Performance Testing PASS
ci/iol-unit-arm64-testing success Testing PASS
ci/iol-compile-arm64-testing success Testing PASS
ci/iol-sample-apps-testing success Testing PASS

Commit Message

Stephen Hemminger Sept. 30, 2024, 4:19 p.m. UTC 
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 mbox series

Patch

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