[RFC] doc: restructure the introduction

[RFC] doc: restructure the introduction

[Stephen Hemminger]

Add an about DPDK section (taken from web site), and a glossary.
Split the Programmer's Guide and Devices section.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
Rough draft as starting point.
Need to also cleanup headers of the sub-sections

 doc/guides/glossary/index.rst | 26 ++++++++++++++++++++++++++
 doc/guides/index.rst          | 35 ++++++++++++++++++++++++++++++-----
 2 files changed, 56 insertions(+), 5 deletions(-)
 create mode 100644 doc/guides/glossary/index.rst

diff --git a/doc/guides/glossary/index.rst b/doc/guides/glossary/index.rst
new file mode 100644
index 0000000000..5da74758b0
--- /dev/null
+++ b/doc/guides/glossary/index.rst
@@ -0,0 +1,26 @@
+..  SPDX-License-Identifier: BSD-3-Clause
+    Copyright 2024 The DPDK contributors
+
+Glossary of Terms
+==================
+
+EAL
+  Environment Abstraction Layer. Originally used to isolate differences between running
+  on bare metal versus running as a userspace process. Bare metal is no longer supported.
+  Now used to provide abstraction across operating system envrionments.
+
+Process
+  An operating system process consisting of one or more threads.
+
+Thread
+  The unit of execution in the operating system. A thread maybe bound to a specific physical
+  core on the CPU or migrate among core's via the operating system scheduler.
+
+Lcore
+  A logical core. In DPDK lcore's are usually bound to a isolated physical CPU core.
+
+Isolated core
+  A core is isolated if it is reserved by the operating system and not used for normal
+  (muggle) processes. The operating system scheduler will not migrate a thread onto an
+  isolated core; the only way a thread will run on an isolated core is by requesting
+  affinity to that core.
diff --git a/doc/guides/index.rst b/doc/guides/index.rst
index 244b99624c..ed3557f070 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,6 +56,3 @@ DPDK documentation
    rawdevs/index
    mempool/index
    platform/index
-   contributing/index
-   rel_notes/index
-   faq/index
-- 
2.45.2

[RFC v2 1/2] doc: move glossary to intro

[Stephen Hemminger]

Move the glossary from the programmers guide into the introduction.

Signed-off-by: Stephen Hemminger <stephen@networkplumber.org>
---
 doc/guides/{prog_guide/glossary.rst => glossary/index.rst} | 0
 doc/guides/index.rst                                       | 1 +
 doc/guides/prog_guide/index.rst                            | 1 -
 3 files changed, 1 insertion(+), 1 deletion(-)
 rename doc/guides/{prog_guide/glossary.rst => glossary/index.rst} (100%)

diff --git a/doc/guides/prog_guide/glossary.rst b/doc/guides/glossary/index.rst
similarity index 100%
rename from doc/guides/prog_guide/glossary.rst
rename to doc/guides/glossary/index.rst
diff --git a/doc/guides/index.rst b/doc/guides/index.rst
index 244b99624c..5cec8a8287 100644
--- a/doc/guides/index.rst
+++ b/doc/guides/index.rst
@@ -29,5 +29,6 @@ DPDK documentation
    mempool/index
    platform/index
    contributing/index
+   glossary/index
    rel_notes/index
    faq/index
diff --git a/doc/guides/prog_guide/index.rst b/doc/guides/prog_guide/index.rst
index 7eb1a98d88..70e0a6af05 100644
--- a/doc/guides/prog_guide/index.rst
+++ b/doc/guides/prog_guide/index.rst
@@ -14,7 +14,6 @@ Foundation Principles
     intro
     overview
     source_org
-    glossary
 
 
 Memory Management
-- 
2.45.2

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

[Stephen Hemminger]

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