[PATCH 3/4] doc: add hyperlinks to other docs from Linux GSG
Bruce Richardson
bruce.richardson at intel.com
Tue Mar 15 23:05:03 CET 2022
The document roadmap section called out the titles of other documents,
but these are better as hyperlinks.
Signed-off-by: Bruce Richardson <bruce.richardson at intel.com>
---
doc/guides/linux_gsg/intro.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/doc/guides/linux_gsg/intro.rst b/doc/guides/linux_gsg/intro.rst
index 890169e97f..20fe4de630 100644
--- a/doc/guides/linux_gsg/intro.rst
+++ b/doc/guides/linux_gsg/intro.rst
@@ -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.
--
2.32.0
More information about the dev
mailing list