[v2] doc: update documentation for Bluefield platform

Message ID 1606203152-4542-1-git-send-email-asafp@nvidia.com (mailing list archive)
State Accepted, archived
Delegated to: Thomas Monjalon
Headers
Series [v2] 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. 24, 2020, 7:32 a.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>
---
v2: styling updates and typo
---
 doc/guides/platform/bluefield.rst | 16 ++++++++--------
 1 file changed, 8 insertions(+), 8 deletions(-)
  

Comments

Thomas Monjalon Nov. 27, 2020, 12:35 a.m. UTC | #1
24/11/2020 08:32, Asaf Penso:
> 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>
> ---
> v2: styling updates and typo

Applied with formatting fixed, thanks.
  

Patch

diff --git a/doc/guides/platform/bluefield.rst b/doc/guides/platform/bluefield.rst
index 366f2b2..151e5e5 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
 ------------