From 9db00be1c1f52cd82ff7c6b64e96760b10bc2d1d Mon Sep 17 00:00:00 2001 From: "Galantsev, Dmitrii" Date: Wed, 24 Jan 2024 16:02:33 -0600 Subject: [PATCH] README - Fix URLs and add lychee config Use Lychee[1] to check dead links [1] - https://github.com/lycheeverse/lychee Change-Id: I0e8aade7879748dbcb4700a527bcae5a2c29ecb5 Signed-off-by: Galantsev, Dmitrii [ROCm/rdc commit: 2c27473d6f85045dced9eb0d71025932c6da87f6] --- projects/rdc/CHANGELOG.md | 2 +- projects/rdc/README.md | 18 +++++++++--------- projects/rdc/lychee.toml | 2 ++ 3 files changed, 12 insertions(+), 10 deletions(-) create mode 100644 projects/rdc/lychee.toml diff --git a/projects/rdc/CHANGELOG.md b/projects/rdc/CHANGELOG.md index 9a9ef3f1a0..df09d93442 100644 --- a/projects/rdc/CHANGELOG.md +++ b/projects/rdc/CHANGELOG.md @@ -1,5 +1,5 @@ # Change Log for RDC -Full documentation for RDC is available at [ROCm DataCenter Tool User Guide](https://docs.amd.com/bundle?name_filter.field=title&name_filter.value=ROCm%20DataCenter%20Tool%20User%20Guide&rpp=10&sort.field=title&sort.value=desc). +Full documentation for RDC is available at [ROCm DataCenter Tool User Guide](https://docs.amd.com/projects/rdc/en/latest/). ## RDC for ROCm 5.5.0 diff --git a/projects/rdc/README.md b/projects/rdc/README.md index 7fd2798ab8..719828bd16 100644 --- a/projects/rdc/README.md +++ b/projects/rdc/README.md @@ -7,11 +7,11 @@ The ROCm™ Data Center Tool simplifies the administration and addresses key inf - Integration with third-party tools - Open source -For up-to-date document and how to start using RDC from pre-built packages, please refer to the [**ROCm DataCenter Tool User Guide**](https://rocm.docs.amd.com/projects/rdc/en/latest/) +For up-to-date document and how to start using RDC from pre-built packages, please refer to the [**ROCm DataCenter Tool User Guide**](https://docs.amd.com/projects/rdc/en/latest/) ## Supported platforms -RDC can run on AMD ROCm supported platforms, please refer to the [List of Supported Operating Systems](https://rocm.docs.amd.com/en/latest/release/gpu_os_support.html) +RDC can run on AMD ROCm supported platforms, please refer to the [List of Supported Operating Systems](https://docs.amd.com/projects/install-on-linux/en/latest/reference/system-requirements.html#supported-operating-systems) ## Building RDC from source @@ -24,12 +24,12 @@ RDC can run on AMD ROCm supported platforms, please refer to the [List of Suppor gRPC and protoc ## required for communication libcap-dev ## required to manage the privileges. - AMD ROCm platform (https://github.com/RadeonOpenCompute/ROCm) + AMD ROCm platform (https://github.com/ROCm/ROCm) * It is recommended to install the complete AMD ROCm platform. - For installation instruction see https://rocm.docs.amd.com/en/latest/deploy/linux/quick_start.html + For installation instruction see https://docs.amd.com/projects/install-on-linux/en/latest/tutorial/quick-start.html * At the minimum, these two components are required - (i) AMD ROCm SMI Library (https://github.com/RadeonOpenCompute/rocm_smi_lib) - (ii) AMD ROCk Kernel driver (https://github.com/RadeonOpenCompute/ROCK-Kernel-Driver) + (i) AMD ROCm SMI Library (https://github.com/ROCm/rocm_smi_lib) + (ii) AMD ROCk Kernel driver (https://github.com/ROCm/ROCK-Kernel-Driver) ## Building gRPC and protoc @@ -65,7 +65,7 @@ Below example installs gRPC into /opt/grpc Clone the RDC source code from GitHub and use CMake to build and install - git clone https://github.com/RadeonOpenCompute/rdc + git clone https://github.com/ROCm/rdc cd rdc mkdir -p build # default installation location is /opt/rocm, specify with -DROCM_DIR or -DCMAKE_INSTALL_PREFIX @@ -96,7 +96,7 @@ The user can choose to not build RDC diagnostic ROCM Run time. This will elimina ## Running RDC RDC supports encrypted communications between clients and servers. The -communication can be configured to be *authenticated* or *not authenticated*. The [**user guide**](https://rocm.docs.amd.com/projects/rdc/en/latest/) has information on how to generate and install SSL keys and certificates for authentication. By default, authentication is enabled. +communication can be configured to be *authenticated* or *not authenticated*. The [**user guide**](https://docs.amd.com/projects/rdc/en/latest/) has information on how to generate and install SSL keys and certificates for authentication. By default, authentication is enabled. ## Starting ROCm™ Data Center Daemon (RDCD) @@ -131,7 +131,7 @@ When *rdcd* is started from a command-line the *capabilities* are determined by ## Invoke RDC using ROCm™ Data Center Interface (RDCI) -RDCI provides command-line interface to all RDC features. This CLI can be run locally or remotely. Refer to [**user guide**](https://rocm.docs.amd.com/projects/rdc/en/latest/user_guide/features.html) for the current list of features. +RDCI provides command-line interface to all RDC features. This CLI can be run locally or remotely. Refer to [**user guide**](https://docs.amd.com/projects/rdc/en/latest/user_guide/features.html) for the current list of features. ## sample rdci commands to test RDC functionality ## discover devices in a local or remote compute node diff --git a/projects/rdc/lychee.toml b/projects/rdc/lychee.toml new file mode 100644 index 0000000000..25193c0706 --- /dev/null +++ b/projects/rdc/lychee.toml @@ -0,0 +1,2 @@ +exclude = ['^file://.*', '.*localhost.*'] +exclude_path = ["./build"]