Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Docs: Use Omnitrace's version number in installer download command #388

Open
wants to merge 11 commits into
base: main
Choose a base branch
from
Open

Docs: Use Omnitrace's version number in installer download command #388

wants to merge 11 commits into from
+95 −78

Conversation

peterjunpark
Copy link
Contributor

@peterjunpark peterjunpark commented Sep 23, 2024 •
edited by dgaliffiAMD
Loading

This PR:

  • Updates conf.py to non-legacy rocm-docs-core setup
  • Injects Omnitrace's version number into the download command for omnitrace-installer.py (quick-start.rst)
    • Fixes an issue causing the download url (https://github.com/ROCm/omnitrace/releases/latest/download/omnitrace-install.py) to not work if the latest release is a rocm tag

@peterjunpark peterjunpark changed the title Docs/template version installer download Docs: Use Omniperf's version number in installer download command Sep 23, 2024
@peterjunpark peterjunpark added the documentation Improvements or additions to documentation label Sep 23, 2024
@peterjunpark peterjunpark force-pushed the docs/template-version-installer-download branch from aecb975 to 1fcd7fa Compare September 23, 2024 22:22
@peterjunpark
fix url template
ec92a25 
remove no intersphinx

fix typo
@peterjunpark peterjunpark force-pushed the docs/template-version-installer-download branch from 1fcd7fa to ec92a25 Compare September 23, 2024 22:24
@peterjunpark peterjunpark marked this pull request as ready for review September 23, 2024 22:44
@peterjunpark peterjunpark changed the title Docs: Use Omniperf's version number in installer download command Docs: Use Omnitrace's version number in installer download command Sep 23, 2024
@dgaliffiAMD
Copy link
Collaborator

Updated reference to "omniperf" to "omnitrace" in description.

dgaliffiAMD
dgaliffiAMD previously approved these changes Sep 24, 2024
View reviewed changes
@peterjunpark
Copy link
Contributor Author

@dgaliffiAMD

FYI, with this change, users will only see the latest Omnitrace version number (i.e., 1.12.0) in main which is effectively staging documentation.

The latest and other versions of the docs will show the Omnitrace version associated with that ROCm release (i.e., 1.11.2). This means the "default" version of the docs will not show the latest Omnitrace version (1.12.0). So, this actually changes the installation instructions.

This might not be what you expected?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@dgaliffiAMD dgaliffiAMD dgaliffiAMD left review comments

@jrmadsen jrmadsen Awaiting requested review from jrmadsen jrmadsen is a code owner

At least 1 approving review is required to merge this pull request.

Assignees
No one assigned
Labels
documentation Improvements or additions to documentation
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@peterjunpark @dgaliffiAMD