doc: update documentation for Bluefield platform

Message ID 1606162185-3179-1-git-send-email-asafp@nvidia.com (mailing list archive)
State Superseded, archived
Delegated to: Thomas Monjalon
Headers
Series doc: update documentation for Bluefield platform |

Checks

Context Check Description
ci/checkpatch success coding style OK
ci/Intel-compilation success Compilation OK
ci/travis-robot success Travis build: passed

Commit Message

Asaf Penso Nov. 23, 2020, 8:09 p.m. UTC
  The documentation file contains some broken links to Mellanox's site.
Also now BlueField-2 platform is supported.

This patch provides new links and adds documentation for
BlueField-2 platform.

Signed-off-by: Asaf Penso <asafp@nvidia.com>
---
 doc/guides/platform/bluefield.rst | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)
  

Comments

Andrew Boyer Dec. 11, 2020, 6 p.m. UTC | #1
> On Nov 23, 2020, at 3:09 PM, Asaf Penso <asafp@nvidia.com> wrote:
> 
> The documentation file contains some broken links to Mellanox's site.
> Also now BlueField-2 platform is supported.
> 
> This patch provides new links and adds documentation for
> BlueField-2 platform.
> 
> Signed-off-by: Asaf Penso <asafp@nvidia.com>
> ---
> doc/guides/platform/bluefield.rst | 16 ++++++++--------
> 1 file changed, 8 insertions(+), 8 deletions(-)
> 
> diff --git a/doc/guides/platform/bluefield.rst b/doc/guides/platform/bluefield.rst
> index 366f2b2..30ad9ff 100644
> --- a/doc/guides/platform/bluefield.rst
> +++ b/doc/guides/platform/bluefield.rst
> @@ -11,15 +11,14 @@ and common offload HW drivers of **Mellanox BlueField** family SoC.
> Supported BlueField family SoCs
> -------------------------------
> 
> -- `BlueField <http://www.mellanox.com/page/products_dyn?product_family=256&mtag=soc_overview>`_
> +- `BlueField <https://docs.mellanox.com/category/bluefieldsnic>`_
> 
> 
> Supported BlueField Platforms
> -----------------------------
> 
> -- `BlueField SmartNIC <http://www.mellanox.com/page/products_dyn?product_family=275&mtag=bluefield_smart_nic>`_
> -- `BlueField Reference Platforms <http://www.mellanox.com/page/products_dyn?product_family=286&mtag=bluefield_platforms>`_
> -- `BlueField Controller Card <http://www.mellanox.com/page/products_dyn?product_family=288&mtag=bluefield_controller_card>`_
> +- `BlueField-1 <https://docs.mellanox.com/display/bluefieldsniceth/Introduction>`_
> +- `BlueField-2 <https://docs.mellanox.com/display/BlueField2DPUENUG/Introduction>`_
> 
> 
> Common Offload HW Drivers
> @@ -43,10 +42,11 @@ Steps To Setup Platform
> -----------------------
> 
> Toolchains, OS and drivers can be downloaded and installed individually from the
> -Web. But it is recommended to follow instructions at
> -`Mellanox BlueField Software Website
> -<http://www.mellanox.com/page/products_dyn?product_family=279&mtag=bluefield_software>`_.
> -
> +Web, But it is recommended to follow instructions at:

Web, but it is recommended to follow the instructions at:

(with the comma, ‘but' should not be capitalized, and ‘follow the instructions’ instead of ‘follow instructions’)

> +`Mellanox BlueField-1 Software Website
> +<https://docs.mellanox.com/display/BlueFieldSWv31011424/SmartNIC+Bring-Up+and+Driver+Installation>`_.
> +`Mellanox BlueField-2 Software Website
> +<https://docs.mellanox.com/display/NVIDIABlueField2DPUQSG#NVIDIABlueField2DPUSoftwareQuickStartGuide-Post-installationProcedurePost-installationProcedure>`_.
> 
> Compile DPDK
> ------------
> -- 
> 1.8.3.1
>
  

Patch

diff --git a/doc/guides/platform/bluefield.rst b/doc/guides/platform/bluefield.rst
index 366f2b2..30ad9ff 100644
--- a/doc/guides/platform/bluefield.rst
+++ b/doc/guides/platform/bluefield.rst
@@ -11,15 +11,14 @@  and common offload HW drivers of **Mellanox BlueField** family SoC.
 Supported BlueField family SoCs
 -------------------------------
 
-- `BlueField <http://www.mellanox.com/page/products_dyn?product_family=256&mtag=soc_overview>`_
+- `BlueField <https://docs.mellanox.com/category/bluefieldsnic>`_
 
 
 Supported BlueField Platforms
 -----------------------------
 
-- `BlueField SmartNIC <http://www.mellanox.com/page/products_dyn?product_family=275&mtag=bluefield_smart_nic>`_
-- `BlueField Reference Platforms <http://www.mellanox.com/page/products_dyn?product_family=286&mtag=bluefield_platforms>`_
-- `BlueField Controller Card <http://www.mellanox.com/page/products_dyn?product_family=288&mtag=bluefield_controller_card>`_
+- `BlueField-1 <https://docs.mellanox.com/display/bluefieldsniceth/Introduction>`_
+- `BlueField-2 <https://docs.mellanox.com/display/BlueField2DPUENUG/Introduction>`_
 
 
 Common Offload HW Drivers
@@ -43,10 +42,11 @@  Steps To Setup Platform
 -----------------------
 
 Toolchains, OS and drivers can be downloaded and installed individually from the
-Web. But it is recommended to follow instructions at
-`Mellanox BlueField Software Website
-<http://www.mellanox.com/page/products_dyn?product_family=279&mtag=bluefield_software>`_.
-
+Web, But it is recommended to follow instructions at:
+`Mellanox BlueField-1 Software Website
+<https://docs.mellanox.com/display/BlueFieldSWv31011424/SmartNIC+Bring-Up+and+Driver+Installation>`_.
+`Mellanox BlueField-2 Software Website
+<https://docs.mellanox.com/display/NVIDIABlueField2DPUQSG#NVIDIABlueField2DPUSoftwareQuickStartGuide-Post-installationProcedurePost-installationProcedure>`_.
 
 Compile DPDK
 ------------