Fix links in docs (#532)

* fix links in amdsmi_cli/README.md
* fix xrefs to install docs
* rm rocm-smi examples and add cli tutorial
* rm disclaimer and add amd smi contributing guidelines to index

Signed-off-by: Peter Park <Peter.Park@amd.com>
This commit is contained in:
Park, Peter
2025-07-07 12:18:40 -04:00
committed by GitHub
szülő 2cf6272b53
commit 8039ab9449
5 fájl változott, egészen pontosan 14 új sor hozzáadva és 34 régi sor törölve
+2 -2
Fájl megtekintése
@@ -22,7 +22,7 @@ Find the documentation in the `docs/` directory.
Explore the latest documentation on the [ROCm documentation
portal](https://rocm.docs.amd.com/projects/en/latest/index.html).
- [Install AMD SMI](https://rocm.docs.amd.com/projects/en/latest/install/install.html)
- [Install AMD SMI](https://rocm.docs.amd.com/projects/amdsmi/en/latest/install/install.html)
- [CLI tool usage](https://rocm.docs.amd.com/projects/en/latest/how-to/amdsmi-cli-tool.html).
- [CLI tool usage](https://rocm.docs.amd.com/projects/amdsmi/en/latest/how-to/amdsmi-cli-tool.html).
+5 -1
Fájl megtekintése
@@ -32,7 +32,11 @@ See the [requirements](#install_reqs) section for more information.
3. Install Go 1.20+.
For example, to install from [https://golang.org/dl/go1.20.12.linux-amd64.tar.gz]():
Download Go from [https://go.dev/dl/](https://go.dev/dl/) and follow the
official installation documentation at [Download and
install](https://go.dev/doc/install).
Alternatively, use a third-party utility like update-golang.
```bash
git clone https://github.com/udhos/update-golang
+4 -28
Fájl megtekintése
@@ -52,34 +52,10 @@ AMD SMI is the successor to <https://github.com/ROCm/rocm_smi_lib>.
:::
::::
To contribute to the documentation, refer to
{doc}`Contributing to ROCm <rocm:contribute/contributing>`.
To learn about contributing to AMD SMI, see [Contibuting to AMD
SMI](https://github.com/ROCm/amdsmi/blob/amd-mainline/.github/CONTRIBUTING.md).
To contribute to the documentation, see
{doc}`Contributing to ROCm documentation <rocm:contribute/contributing>`.
Find ROCm licensing information on the
{doc}`Licensing <rocm:about/license>` page.
<style>
#disclaimer {
font-size: 0.8rem;
}
</style>
<div id="disclaimer">
The information contained herein is for informational purposes only, and is
subject to change without notice. While every precaution has been taken in the
preparation of this document, it may contain technical inaccuracies, omissions
and typographical errors, and AMD is under no obligation to update or otherwise
correct this information. Advanced Micro Devices, Inc. makes no representations
or warranties with respect to the accuracy or completeness of the contents of
this document, and assumes no liability of any kind, including the implied
warranties of noninfringement, merchantability or fitness for particular
purposes, with respect to the operation or use of AMD hardware, software or
other products described herein.
AMD, the AMD Arrow logo, and combinations thereof are trademarks of Advanced
Micro Devices, Inc. Other product names used in this publication are for
identification purposes only and may be trademarks of their respective
companies.
Copyright (c) 2014-2024 Advanced Micro Devices, Inc. All rights reserved.
</div>
+1 -1
Fájl megtekintése
@@ -125,7 +125,7 @@ activate-global-python-argcomplete --user
## Install the Python library for multiple ROCm instances
If {doc}`multiple ROCm versions are installed
<rocm-install-on-linux:install/install-methods/multi-version-install>` and you
<rocm-install-on-linux:install/install-methods/multi-version-install-index>` and you
are not using `pyenv`, uninstall previous versions of AMD SMI before installing
the desired version from your ROCm instance.
+2 -2
Fájl megtekintése
@@ -48,8 +48,8 @@ subtrees:
entries:
- url: https://github.com/ROCm/amdsmi/tree/amd-staging/example
title: AMD SMI examples (GitHub)
- url: https://github.com/ROCm/rocm_smi_lib/tree/amd-staging/example
title: ROCm SMI lib examples (GitHub)
- url: https://rocm.blogs.amd.com/software-tools-optimization/amd-smi-overview/README.html
title: AMD SMI CLI walkthrough
- caption: About
entries: