From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <dev-bounces@dpdk.org>
Received: from mails.dpdk.org (mails.dpdk.org [217.70.189.124])
by inbox.dpdk.org (Postfix) with ESMTP id 14277A0032;
Tue, 15 Mar 2022 23:05:17 +0100 (CET)
Received: from [217.70.189.124] (localhost [127.0.0.1])
by mails.dpdk.org (Postfix) with ESMTP id EF478410FC;
Tue, 15 Mar 2022 23:05:14 +0100 (CET)
Received: from mga14.intel.com (mga14.intel.com [192.55.52.115])
by mails.dpdk.org (Postfix) with ESMTP id 0DDEA410EF
for <dev@dpdk.org>; Tue, 15 Mar 2022 23:05:12 +0100 (CET)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/simple;
d=intel.com; i=@intel.com; q=dns/txt; s=Intel;
t=1647381913; x=1678917913;
h=from:to:cc:subject:date:message-id:in-reply-to:
references:mime-version:content-transfer-encoding;
bh=MTUuUlkyL2li90tctqvEqltgs2gdCBGNLIZcaD+7D9U=;
b=URqmk4gsvUe/BhWsBHMQ4OhfyCRabBX5vjLL/eGRMr5GecOz9llJOA4p
T9eglZSU3ZE2F5W4QWGDaL57/cc0NwZpPaLHw6bApwE9orzRNHMsSTXEO
tERg9A9tINEdL+41wFW6SUv+ODMoPtp4qmcR0sojYcCQRy4fD6oLjBmiR
kXuycy9X7eH5mNDm5FRlVD67IgfL+I2s6QHgfTmxDJHbhTh9e+rjtLKvu
k91oA9FLbHFA1nxZkfxnV3YQJqgrLtGUkceMe7gGMq8dHqd/4V22lqfB8
QDLOLxmwPBQlq2Q1VWwjbISnnUS9SO+UUXzuJjA47pzcDpxJn+oTOhMFD g==;
X-IronPort-AV: E=McAfee;i="6200,9189,10286"; a="256623308"
X-IronPort-AV: E=Sophos;i="5.90,184,1643702400"; d="scan'208";a="256623308"
Received: from orsmga002.jf.intel.com ([10.7.209.21])
by fmsmga103.fm.intel.com with ESMTP/TLS/ECDHE-RSA-AES256-GCM-SHA384;
15 Mar 2022 15:05:12 -0700
X-ExtLoop1: 1
X-IronPort-AV: E=Sophos;i="5.90,184,1643702400"; d="scan'208";a="512776027"
Received: from silpixa00399126.ir.intel.com ([10.237.223.34])
by orsmga002.jf.intel.com with ESMTP; 15 Mar 2022 15:05:11 -0700
From: Bruce Richardson <bruce.richardson@intel.com>
To: dev@dpdk.org
Cc: Bruce Richardson <bruce.richardson@intel.com>
Subject: [PATCH 1/4] doc: add hyperlinks to other docs from FreeBSD GSG
Date: Tue, 15 Mar 2022 22:05:01 +0000
Message-Id: <20220315220504.1092437-2-bruce.richardson@intel.com>
X-Mailer: git-send-email 2.32.0
In-Reply-To: <20220315220504.1092437-1-bruce.richardson@intel.com>
References: <20220315220504.1092437-1-bruce.richardson@intel.com>
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
X-BeenThere: dev@dpdk.org
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: DPDK patches and discussions <dev.dpdk.org>
List-Unsubscribe: <https://mails.dpdk.org/options/dev>,
<mailto:dev-request@dpdk.org?subject=unsubscribe>
List-Archive: <http://mails.dpdk.org/archives/dev/>
List-Post: <mailto:dev@dpdk.org>
List-Help: <mailto:dev-request@dpdk.org?subject=help>
List-Subscribe: <https://mails.dpdk.org/listinfo/dev>,
<mailto:dev-request@dpdk.org?subject=subscribe>
Errors-To: dev-bounces@dpdk.org
The document roadmap section called out the titles of other documents,
but these are better as hyperlinks.
Signed-off-by: Bruce Richardson <bruce.richardson@intel.com>
---
doc/guides/freebsd_gsg/intro.rst | 10 +++++-----
1 file changed, 5 insertions(+), 5 deletions(-)
diff --git a/doc/guides/freebsd_gsg/intro.rst b/doc/guides/freebsd_gsg/intro.rst
index b2e57909ee..5f677e1655 100644
--- a/doc/guides/freebsd_gsg/intro.rst
+++ b/doc/guides/freebsd_gsg/intro.rst
@@ -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.
--
2.32.0