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

[CUDA][HIP] Fix bug report template descriptions #12928

Merged
merged 7 commits into from
Mar 8, 2024

Conversation

steffenlarsen
Copy link
Contributor

The format from #12910 was invalid.
This PR attempts to fix it.

Note: Descriptions have a 200 character limit.

The format from intel#12910 was invalid.
This PR attempts to fix it.

Signed-off-by: Larsen, Steffen <steffen.larsen@intel.com>
Signed-off-by: Larsen, Steffen <steffen.larsen@intel.com>
@steffenlarsen steffenlarsen requested a review from a team as a code owner March 6, 2024 16:22
@KornevNikita
Copy link
Contributor

KornevNikita commented Mar 6, 2024

For some reason this hyperlink in description doesn't work

Copy link
Contributor

@JackAKirk JackAKirk left a comment

Choose a reason for hiding this comment

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

LGTM, thanks for fixing!

[troubleshooting guide](https://developer.codeplay.com/products/oneapi/nvidia/latest/guides/troubleshooting)
description: >
Please use this template in case of CUDA-specific issue.
Check the [troubleshooting guide](https://developer.codeplay.com/products/oneapi/nvidia/latest/guides/troubleshooting)
Copy link
Contributor

@KornevNikita KornevNikita Mar 6, 2024

Choose a reason for hiding this comment

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

So I'd suggest to use something like this. Not sure if hyperlink even work here. Same for hip.

Suggested change
Check the [troubleshooting guide](https://developer.codeplay.com/products/oneapi/nvidia/latest/guides/troubleshooting)
Check the https://developer.codeplay.com/products/oneapi/nvidia/latest/guides/troubleshooting page.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've changed it to not be a hyperlink. 👍

Copy link
Contributor

@JackAKirk JackAKirk Mar 6, 2024

Choose a reason for hiding this comment

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

I've just read that html is meant to work: e.g.

<a href="https://developer.codeplay.com/products/oneapi/nvidia/latest/guides/troubleshooting">troubleshooting guide</a>

jekyll/minima#68 (comment)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I've updated it to use the HTML style, but the preview still looks weird. Maybe it's just preview being weird.

Copy link
Contributor

Choose a reason for hiding this comment

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

So I'd suggest to use something like this. Not sure if hyperlink even work here. Same for hip.

Maybe this is the best option then, unless it doesn't render properly till it is merged etc. I had read somewhere that markdown was also meant to work. I guess it isn't a big deal so long as users can see the link.

Copy link
Contributor

Choose a reason for hiding this comment

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

I've updated it to use the HTML style, but the preview still looks weird. Maybe it's just preview being weird.

You can try merge these changes into your own sycl branch and then check it.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

You can try merge these changes into your own sycl branch and then check it.

Good idea. I tried this and the hyperlinks did not work, so I've moved back to simple links.

Signed-off-by: Larsen, Steffen <steffen.larsen@intel.com>
Signed-off-by: Larsen, Steffen <steffen.larsen@intel.com>
Signed-off-by: Larsen, Steffen <steffen.larsen@intel.com>
This reverts commit 9fff0c8.
@againull againull merged commit ce70f0d into intel:sycl Mar 8, 2024
1 check passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants