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.

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

Updates to Individual Component README's to Fix Markdown Links #152

Merged
merged 2 commits into from
Feb 9, 2024

Conversation

Treece-Burgess
Copy link
Contributor

@Treece-Burgess Treece-Burgess commented Jan 21, 2024

Pull Request Description

Update the README markdown header links for each component listed within the following table. The original header links within each README, were dead links and therefore selecting one resulted in not jumping to the desired section. This was caused by using the following syntax (#markdown-header-name-of-section). Simply removing #markdown-header fixes this issue.

Tested on Guyot, by previewing and selecting updated markdown header links. Each updated README had the correct behavior of jumping to the correct section that was selected.

Author Checklist

  • Description
    Why this PR exists. Reference all relevant information, including background, issues, test failures, etc
  • Commits
    Commits are self contained and only do one thing
    Commits have a header of the form: module: short description
    Commits have a body (whenever relevant) containing a detailed description of the addressed problem and its solution
  • Tests
    The PR needs to pass all the tests

@Treece-Burgess Treece-Burgess added the update-docs PRs updating the PAPI documentation label Jan 21, 2024
@Treece-Burgess
Copy link
Contributor Author

Two updates we may want to add to this PR as well, are updating two total links.

One link is located in the README for the rocm component which is suppose to take you to a page that discusses the AMD isolation mechanism. However, upon clicking this link you will be taken to a page which will state the page is not found. The following page may be what needs to be used now.

The second link is located in the README for the net component which does successfully take you to a webpage. However, this link is repeated twice. Either we need to remove the second link or update the second link to reference part two.

@Treece-Burgess Treece-Burgess added the type-question Issues that pose a question label Jan 21, 2024
@Treece-Burgess
Copy link
Contributor Author

Updated net and rocm README's:

  • net: removed unwanted links from README, which took you to a webpage that did not have meaningful information for the component.
  • rocm: updated link for documentation on GPU isolation for AMD.

See original comment for details on now resolved issue.

@Treece-Burgess Treece-Burgess removed the type-question Issues that pose a question label Jan 24, 2024
@Treece-Burgess Treece-Burgess merged commit 60606f5 into icl-utk-edu:master Feb 9, 2024
26 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
update-docs PRs updating the PAPI documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants