Skip to contentSkip to conversation

Update doc lists in GSG intros

PATCH Applied Bruce Richardson 2 participants 6 messages Mar 15, 2022 – Mar 16, 2022

lore
Share & tools
lore
#0 lore raw

cover Update doc lists in GSG intros

This set updates the documentation roadmap section at the start of the Linux and FreeBSD GSG docs. Changes made:

* Change doc titles to hyperlinks to each doc
* Add the drivers reference guides to the lists

Bruce Richardson (4):
doc: add hyperlinks to other docs from FreeBSD GSG
doc: add driver guides to document list in FreeBSD GSG
doc: add hyperlinks to other docs from Linux GSG
doc: add driver guides to document list in Linux GSG

 doc/guides/freebsd_gsg/intro.rst | 35 +++++++++++++++++++++++++++-----
 doc/guides/linux_gsg/intro.rst   | 35 +++++++++++++++++++++++++++-----
 2 files changed, 60 insertions(+), 10 deletions(-)

--
2.32.0

#1 lore raw

PATCH 1/4 doc: add hyperlinks to other docs from FreeBSD GSG

The document roadmap section called out the titles of other documents, but these are better as hyperlinks.

---
 doc/guides/freebsd_gsg/intro.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
doc/guides/freebsd_gsg/intro.rst +5 -5
index b2e57909ee..5f677e1655 100644
@@ -25,15 +25,15 @@ Documentation Roadmap
 
 The following is a list of DPDK documents in the suggested reading order:
 
-*   **Release Notes** : Provides release-specific information, including supported
+*   :doc:`../rel_notes/index`: Provides release-specific information, including supported
     features, limitations, fixed issues, known issues and so on.  Also, provides the
     answers to frequently asked questions in FAQ format.
 
-*   **Getting Started Guide** (this document): Describes how to install and
+*   :doc:`../freebsd_gsg/index` (this document): Describes how to install and
     configure the DPDK; designed to get users up and running quickly with the
     software.
 
-*   **Programmer's Guide**: Describes:
+*   :doc:`../prog_guide/index`: Describes:
 
     *   The software architecture and how to use it (through examples),
         specifically in a Linux* application (linux) environment
@@ -47,9 +47,9 @@ The following is a list of DPDK documents in the suggested reading order:
 
     A glossary of terms is also provided.
 
-*   **API Reference**: Provides detailed information about DPDK functions,
+*   `API Reference <../../../api/html/index.html>`_: Provides detailed information about DPDK functions,
     data structures and other programming constructs.
 
-*   **Sample Applications User Guide**: Describes a set of sample applications.
+*   :doc:`../sample_app_ug/index`: Describes a set of sample applications.
     Each chapter describes a sample application that showcases specific functionality
     and provides instructions on how to compile, run and use the sample application.
Signature · 1 line
2.32.0
#2 lore raw

PATCH 2/4 doc: add driver guides to document list in FreeBSD GSG

In reply to Bruce Richardson

The document roadmap section was missing any mention of the individual drivers guides which are important for users. Add them to list.

---
 doc/guides/freebsd_gsg/intro.rst | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
doc/guides/freebsd_gsg/intro.rst +25 -0
index 5f677e1655..596d84c8f1 100644
@@ -53,3 +53,28 @@ The following is a list of DPDK documents in the suggested reading order:
 *   :doc:`../sample_app_ug/index`: Describes a set of sample applications.
     Each chapter describes a sample application that showcases specific functionality
     and provides instructions on how to compile, run and use the sample application.
+
+*   **Driver Reference Guides**: Provides details on each driver inside a particular category.
+    Separate guides exist for each of:
+
+    * :doc:`../bbdevs/index`
+
+    * :doc:`../compressdevs/index`
+
+    * :doc:`../cryptodevs/index`
+
+    * :doc:`../dmadevs/index`
+
+    * :doc:`../eventdevs/index`
+
+    * :doc:`../gpus/index`
+
+    * :doc:`../mempool/index`
+
+    * :doc:`../nics/index`
+
+    * :doc:`../rawdevs/index`
+
+    * :doc:`../regexdevs/index`
+
+    * :doc:`../vdpadevs/index`
Signature · 1 line
2.32.0
#3 lore raw

PATCH 3/4 doc: add hyperlinks to other docs from Linux GSG

In reply to Bruce Richardson

The document roadmap section called out the titles of other documents, but these are better as hyperlinks.

---
 doc/guides/linux_gsg/intro.rst | 10 +++++-----
 1 file changed, 5 insertions(+), 5 deletions(-)
doc/guides/linux_gsg/intro.rst +5 -5
index 890169e97f..20fe4de630 100644
@@ -14,12 +14,12 @@ Documentation Roadmap
 
 The following is a list of DPDK documents in the suggested reading order:
 
-*   Release Notes: Provides release-specific information, including supported features, limitations, fixed issues, known issues and so on.
+*   :doc:`../rel_notes/index`: Provides release-specific information, including supported features, limitations, fixed issues, known issues and so on.
     Also, provides the answers to frequently asked questions in FAQ format.
 
-*   Getting Started Guide (this document): Describes how to install and configure the DPDK; designed to get users up and running quickly with the software.
+*   :doc:`../linux_gsg/index` (this document): Describes how to install and configure the DPDK; designed to get users up and running quickly with the software.
 
-*   Programmer's Guide: Describes:
+*   :doc:`../prog_guide/index`: Describes:
 
     *   The software architecture and how to use it (through examples), specifically in a Linux application (linux) environment
 
@@ -30,7 +30,7 @@ The following is a list of DPDK documents in the suggested reading order:
 
     A glossary of terms is also provided.
 
-*   API Reference: Provides detailed information about DPDK functions, data structures and other programming constructs.
+*   `API Reference <../../../api/html/index.html>`_: Provides detailed information about DPDK functions, data structures and other programming constructs.
 
-*   Sample Applications User Guide: Describes a set of sample applications.
+*   :doc:`../sample_app_ug/index`: Describes a set of sample applications.
     Each chapter describes a sample application that showcases specific functionality and provides instructions on how to compile, run and use the sample application.
Signature · 1 line
2.32.0
#4 lore raw

PATCH 4/4 doc: add driver guides to document list in Linux GSG

In reply to Bruce Richardson

The document roadmap section was missing any mention of the individual drivers guides which are important for users. Add them to list.

---
 doc/guides/linux_gsg/intro.rst | 25 +++++++++++++++++++++++++
 1 file changed, 25 insertions(+)
doc/guides/linux_gsg/intro.rst +25 -0
index 20fe4de630..1b81df8a0f 100644
@@ -34,3 +34,28 @@ The following is a list of DPDK documents in the suggested reading order:
 
 *   :doc:`../sample_app_ug/index`: Describes a set of sample applications.
     Each chapter describes a sample application that showcases specific functionality and provides instructions on how to compile, run and use the sample application.
+
+*   **Driver Reference Guides**: Provides details on each driver inside a particular category.
+    Separate guides exist for each of:
+
+    * :doc:`../bbdevs/index`
+
+    * :doc:`../compressdevs/index`
+
+    * :doc:`../cryptodevs/index`
+
+    * :doc:`../dmadevs/index`
+
+    * :doc:`../eventdevs/index`
+
+    * :doc:`../gpus/index`
+
+    * :doc:`../mempool/index`
+
+    * :doc:`../nics/index`
+
+    * :doc:`../rawdevs/index`
+
+    * :doc:`../regexdevs/index`
+
+    * :doc:`../vdpadevs/index`
Signature · 1 line
2.32.0
#5 lore raw
In reply to Bruce Richardson

15/03/2022 23:05, Bruce Richardson:

Quoted 11 lines

This set updates the documentation roadmap section at the start of the Linux and FreeBSD GSG docs. Changes made:

* Change doc titles to hyperlinks to each doc
* Add the drivers reference guides to the lists

Bruce Richardson (4):
doc: add hyperlinks to other docs from FreeBSD GSG
doc: add driver guides to document list in FreeBSD GSG
doc: add hyperlinks to other docs from Linux GSG
doc: add driver guides to document list in Linux GSG

Applied, thanks.