Highlight prerequisites line on amdgpu-install page #306
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
yhuiYH
reviewed
Sep 30, 2024
docs/install/amdgpu-install.rst
Outdated
| @@ -22,7 +22,9 @@ Installation | |||
|
|
|||
| Installation of ``amdgpu-install`` differs slightly depending on the OS and its package manager. | |||
|
|
|||
| Make sure that the :doc:`/install/prerequisites` are met before installing. | |||
| .. note:: | |||
There was a problem hiding this comment.
Suggested change
| .. note:: | |
| .. important:: |
Do you want to try changing from "note" to "important"? Do we want it to standout more?
There was a problem hiding this comment.
Yea, I agree. Wasn't aware of the important block
|
Also, to be complete, we should add a similar note on the "Ubuntu, SLES, and RHEL" install pages. Can you add that to your PR? |
|
Added the notes for Ubuntu, SLES, and RHEL. Also added some minor changes to unify the content:
|
yhuiYH
reviewed
Sep 30, 2024
| @@ -86,6 +86,10 @@ Add the ROCm repository. | |||
| Installing | |||
| ================================================ | |||
|
|
|||
| .. important:: | |||
There was a problem hiding this comment.
@dbieleck Do you like where @alexxu-amd added it in the "Installing" part? Or do you think it should be right at the top of the page?
I think I'd like it right up at line 8, as the first thing they see, even before they start "registering the repositories".
There was a problem hiding this comment.
I agree. It might be better up at line 8 so it's visible right away.
yhuiYH
approved these changes
Oct 1, 2024
yhuiYH
pushed a commit
that referenced
this pull request
Oct 3, 2024
* highlight prerequisites block * change note block to important block * unifying native-install variants * unify titles; add prereq important blocks for native install * remove install-rocm-template.rst * bring the note to the top
alexxu-amd
added a commit
that referenced
this pull request
Oct 3, 2024
* highlight prerequisites block * change note block to important block * unifying native-install variants * unify titles; add prereq important blocks for native install * remove install-rocm-template.rst * bring the note to the top
yhuiYH
pushed a commit
that referenced
this pull request
Oct 3, 2024
* highlight prerequisites block * change note block to important block * unifying native-install variants * unify titles; add prereq important blocks for native install * remove install-rocm-template.rst * bring the note to the top
alexxu-amd
added a commit
that referenced
this pull request
Oct 3, 2024
* Highlight prerequisites line on amdgpu-install page (#306) * highlight prerequisites block * change note block to important block * unifying native-install variants * unify titles; add prereq important blocks for native install * remove install-rocm-template.rst * bring the note to the top * Update Virtualization support versions (#307) * update Hypervisor versions * fix RHEL version, and add EXSi details * remove unnecessary template file (#312) * Add tensorflow wheel versioning note (#303) * build(deps): Bump rocm-docs-core from 1.7.1 to 1.8.2 in /docs/sphinx (#300) Bumps [rocm-docs-core](https://github.com/ROCm/rocm-docs-core) from 1.7.1 to 1.8.2. - [Release notes](https://github.com/ROCm/rocm-docs-core/releases) - [Changelog](https://github.com/ROCm/rocm-docs-core/blob/v1.8.2/CHANGELOG.md) - [Commits](ROCm/rocm-docs-core@v1.7.1...v1.8.2) --- updated-dependencies: - dependency-name: rocm-docs-core dependency-type: direct:production update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> --------- Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: Young Hui - AMD <[email protected]> Co-authored-by: harkgill-amd <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Multiple feedbacks from internal and external mention the "set user group permission" command is not directly available from amdgpu-install page, which in fact, is included in the prerequisites page but tends to get ignored. Highlight the prerequisites line for improved visibility.