Skip to content

Iterate on "installing from tarballs" documentation. #813

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jun 11, 2025

Conversation

ScottTodd
Copy link
Member

@ScottTodd ScottTodd commented Jun 11, 2025

  • Explain what a "release tarball" is
  • Rework install instructions
  • Show how to test an installation in a bit more detail
  • Adjust section headings, pulling "Using Dockerfiles" out into its own section instead of burying it

I'm not touching the install_rocm_from_artifacts.py section yet... that's probably going to be most flexible and convenient but it needs some quality of life changes to the script that I'll want us to make together with docs changes.

@ScottTodd ScottTodd marked this pull request as ready for review June 11, 2025 21:48
@ScottTodd ScottTodd requested review from marbre and geomin12 June 11, 2025 21:49

### Installing tarballs using `install_rocm_from_artifacts.py`

<!-- TODO: move this above the manual `tar -xf` commands? -->
Copy link
Contributor

@geomin12 geomin12 Jun 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i agree with this, i feel like installing via CI tarballs will be least common way to install? while the python script and wget release will be more common

So best to have:

  1. Install from release tarballs
  2. Install tarbals with install_rocm_from_artifacts
  3. manual CI tarball install

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yep. I'm hesitant to move it up right now though. One thing I noticed on Windows while refactoring in #772 is that the install script has some baked in concept of "base artifacts" that it always fetches, and that list is maintained manually and may not match what is actually needed. For a full install of the ROCm SDK that supports all uses, the manual install is a safer bet right now.

Copy link
Contributor

@geomin12 geomin12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

just some opinions and nits, but looks good!

@ScottTodd ScottTodd requested a review from geomin12 June 11, 2025 22:59
Copy link
Contributor

@geomin12 geomin12 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

L G T M !

@ScottTodd ScottTodd merged commit d42e2aa into main Jun 11, 2025
4 checks passed
@ScottTodd ScottTodd deleted the users/scotttodd/docs-releases-5 branch June 11, 2025 23:03
@github-project-automation github-project-automation bot moved this from TODO to Done in TheRock Triage Jun 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Done
Development

Successfully merging this pull request may close these issues.

2 participants