[dpdk-dev] [PATCH] doc: remove web references to internal guides

[dpdk-dev] [PATCH] doc: remove web references to internal guides

[Thomas Monjalon]

The guides should be referenced locally with RST syntax
:doc: (beginning of page) or :ref: (specific chapter).
The links to doc.dpdk.org/guides/ are removed.

The links to the doc.dpdk.org/api/ are acceptable,
but should not point to a specific version, so one is fixed.

Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
---
 doc/guides/nics/bnxt.rst                | 2 +-
 doc/guides/nics/i40e.rst                | 3 ++-
 doc/guides/nics/ice.rst                 | 3 ++-
 doc/guides/prog_guide/telemetry_lib.rst | 2 +-
 4 files changed, 6 insertions(+), 4 deletions(-)

diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst
index e75f4fa9e3..f2f5eff48d 100644
--- a/doc/guides/nics/bnxt.rst
+++ b/doc/guides/nics/bnxt.rst
@@ -77,7 +77,7 @@ It can direct some traffic, for example data plane traffic, to DPDK.
 Rest of the traffic, for example control plane traffic, would be redirected to
 the traditional Linux networking stack.
 
-Refer to https://doc.dpdk.org/guides/howto/flow_bifurcation.html
+Refer to :doc:`../howto/flow_bifurcation`
 
 Benefits of the flow bifurcation include:
 
diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
index 07841dca24..ef91b3a1ac 100644
--- a/doc/guides/nics/i40e.rst
+++ b/doc/guides/nics/i40e.rst
@@ -78,7 +78,8 @@ Linux Prerequisites
 Windows Prerequisites
 ---------------------
 
-- Follow the DPDK `Getting Started Guide for Windows <https://doc.dpdk.org/guides/windows_gsg/index.html>`_ to setup the basic DPDK environment.
+- Follow the :doc:`guide for Windows <../windows_gsg/run_apps>`
+  to setup the basic DPDK environment.
 
 - Identify the Intel® Ethernet adapter and get the latest NVM/FW version.
 
diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
index 8d43488353..f95fef8cf0 100644
--- a/doc/guides/nics/ice.rst
+++ b/doc/guides/nics/ice.rst
@@ -28,7 +28,8 @@ Linux Prerequisites
 Windows Prerequisites
 ---------------------
 
-- Follow the DPDK `Getting Started Guide for Windows <https://doc.dpdk.org/guides/windows_gsg/index.html>`_ to setup the basic DPDK environment.
+- Follow the :doc:`guide for Windows <../windows_gsg/run_apps>`
+  to setup the basic DPDK environment.
 
 - Identify the Intel® Ethernet adapter and get the latest NVM/FW version.
 
diff --git a/doc/guides/prog_guide/telemetry_lib.rst b/doc/guides/prog_guide/telemetry_lib.rst
index 6ea16e9491..32f525a67f 100644
--- a/doc/guides/prog_guide/telemetry_lib.rst
+++ b/doc/guides/prog_guide/telemetry_lib.rst
@@ -140,7 +140,7 @@ Giving the following response to the client::
     {"/example_lib/string_example": "This is an example string"}
 
 For more information on the range of data functions available in the API,
-please refer to the `API doc <https://doc.dpdk.org/api-20.05/rte__telemetry_8h.html>`_
+please refer to the `API doc <https://doc.dpdk.org/api/rte__telemetry_8h.html>`_
 
 
 Registering Commands
-- 
2.33.0

Re: [dpdk-dev] [PATCH] doc: remove web references to internal guides

[Ajit Khaparde]

[-- Attachment #1: Type: text/plain, Size: 3262 bytes --]

On Thu, Oct 7, 2021 at 5:22 AM Thomas Monjalon <thomas@monjalon.net> wrote:

> The guides should be referenced locally with RST syntax
> :doc: (beginning of page) or :ref: (specific chapter).
> The links to doc.dpdk.org/guides/ are removed.
>
> The links to the doc.dpdk.org/api/ are acceptable,
> but should not point to a specific version, so one is fixed.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
>
Acked-by: Ajit Khaparde <ajit.khaparde@broadcom.com>



> ---
>  doc/guides/nics/bnxt.rst                | 2 +-
>  doc/guides/nics/i40e.rst                | 3 ++-
>  doc/guides/nics/ice.rst                 | 3 ++-
>  doc/guides/prog_guide/telemetry_lib.rst | 2 +-
>  4 files changed, 6 insertions(+), 4 deletions(-)
>
> diff --git a/doc/guides/nics/bnxt.rst b/doc/guides/nics/bnxt.rst
> index e75f4fa9e3..f2f5eff48d 100644
> --- a/doc/guides/nics/bnxt.rst
> +++ b/doc/guides/nics/bnxt.rst
> @@ -77,7 +77,7 @@ It can direct some traffic, for example data plane
> traffic, to DPDK.
>  Rest of the traffic, for example control plane traffic, would be
> redirected to
>  the traditional Linux networking stack.
>
> -Refer to https://doc.dpdk.org/guides/howto/flow_bifurcation.html
> +Refer to :doc:`../howto/flow_bifurcation`
>
>  Benefits of the flow bifurcation include:
>
> diff --git a/doc/guides/nics/i40e.rst b/doc/guides/nics/i40e.rst
> index 07841dca24..ef91b3a1ac 100644
> --- a/doc/guides/nics/i40e.rst
> +++ b/doc/guides/nics/i40e.rst
> @@ -78,7 +78,8 @@ Linux Prerequisites
>  Windows Prerequisites
>  ---------------------
>
> -- Follow the DPDK `Getting Started Guide for Windows <
> https://doc.dpdk.org/guides/windows_gsg/index.html>`_ to setup the basic
> DPDK environment.
> +- Follow the :doc:`guide for Windows <../windows_gsg/run_apps>`
> +  to setup the basic DPDK environment.
>
>  - Identify the Intel® Ethernet adapter and get the latest NVM/FW version.
>
> diff --git a/doc/guides/nics/ice.rst b/doc/guides/nics/ice.rst
> index 8d43488353..f95fef8cf0 100644
> --- a/doc/guides/nics/ice.rst
> +++ b/doc/guides/nics/ice.rst
> @@ -28,7 +28,8 @@ Linux Prerequisites
>  Windows Prerequisites
>  ---------------------
>
> -- Follow the DPDK `Getting Started Guide for Windows <
> https://doc.dpdk.org/guides/windows_gsg/index.html>`_ to setup the basic
> DPDK environment.
> +- Follow the :doc:`guide for Windows <../windows_gsg/run_apps>`
> +  to setup the basic DPDK environment.
>
>  - Identify the Intel® Ethernet adapter and get the latest NVM/FW version.
>
> diff --git a/doc/guides/prog_guide/telemetry_lib.rst
> b/doc/guides/prog_guide/telemetry_lib.rst
> index 6ea16e9491..32f525a67f 100644
> --- a/doc/guides/prog_guide/telemetry_lib.rst
> +++ b/doc/guides/prog_guide/telemetry_lib.rst
> @@ -140,7 +140,7 @@ Giving the following response to the client::
>      {"/example_lib/string_example": "This is an example string"}
>
>  For more information on the range of data functions available in the API,
> -please refer to the `API doc <
> https://doc.dpdk.org/api-20.05/rte__telemetry_8h.html>`_
> +please refer to the `API doc <
> https://doc.dpdk.org/api/rte__telemetry_8h.html>`_
>
>
>  Registering Commands
> --
> 2.33.0
>
>

Re: [dpdk-dev] [PATCH] doc: remove web references to internal guides

[David Marchand]

On Thu, Oct 7, 2021 at 2:22 PM Thomas Monjalon <thomas@monjalon.net> wrote:
>
> The guides should be referenced locally with RST syntax
> :doc: (beginning of page) or :ref: (specific chapter).
> The links to doc.dpdk.org/guides/ are removed.
>
> The links to the doc.dpdk.org/api/ are acceptable,
> but should not point to a specific version, so one is fixed.
>
> Signed-off-by: Thomas Monjalon <thomas@monjalon.net>

Acked-by: David Marchand <david.marchand@redhat.com>


-- 
David Marchand

Re: [dpdk-dev] [PATCH] doc: remove web references to internal guides

[Thomas Monjalon]

08/10/2021 09:34, David Marchand:
> On Thu, Oct 7, 2021 at 2:22 PM Thomas Monjalon <thomas@monjalon.net> wrote:
> >
> > The guides should be referenced locally with RST syntax
> > :doc: (beginning of page) or :ref: (specific chapter).
> > The links to doc.dpdk.org/guides/ are removed.
> >
> > The links to the doc.dpdk.org/api/ are acceptable,
> > but should not point to a specific version, so one is fixed.
> >
> > Signed-off-by: Thomas Monjalon <thomas@monjalon.net>
> 
> Acked-by: David Marchand <david.marchand@redhat.com>

Applied