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

Dead link in the PR markdown form #4139

Closed
1 of 2 tasks
thiago-cs opened this issue Jul 28, 2021 · 3 comments · Fixed by #4069
Closed
1 of 2 tasks

Dead link in the PR markdown form #4139

thiago-cs opened this issue Jul 28, 2021 · 3 comments · Fixed by #4069

Comments

@thiago-cs
Copy link
Contributor

Describe the bug

The PR form in markdown that we have to fill contains a dead link. To be honest, I am not really sure whether this is the right channel to report this. Forgive if it is not.

  • Is this bug a regression in the toolkit? If so, what toolkit version did you last see it work:

Steps to Reproduce

  • Can this be reproduced in the Sample App? (Either in a sample as-is or with new XAML pasted in the editor.) If so, please provide custom XAML or steps to reproduce. If not, let us know why it can't be reproduced (e.g. more complex setup, environment, dependencies, etc...)

Steps to reproduce the behavior:

  1. You do not need the Sample App.
  2. The PR form contains a link to 'https://github.com/CommunityToolkit/WindowsCommunityToolkit/readme.md#supported'
  3. Click on the link to find out the supported SDKs.
  4. See error: "NOT FOUND"

Expected behavior

I list of supported SDKs.

Screenshots

Not applicable / not necessary.

Environment

NuGet Package(s):

Package Version(s):

Windows 10 Build Number:
- [ ] Fall Creators Update (16299)
- [ ] April 2018 Update (17134)
- [ ] October 2018 Update (17763)
- [ ] May 2019 Update (18362)
- [x] May 2020 Update (19041)
- [ ] Insider Build (build number: )

App min and target version:
- [ ] Fall Creators Update (16299)
- [ ] April 2018 Update (17134)
- [ ] October 2018 Update (17763)
- [ ] May 2019 Update (18362)
- [X] May 2020 Update (19041)
- [ ] Insider Build (xxxxx)

Device form factor:
- [X] Desktop
- [ ] Xbox
- [ ] Surface Hub
- [ ] IoT

Visual Studio
- [ ] 2017 (version: )
- [X] 2019 (version: )
- [ ] 2019 Preview (version: )

Additional context

The environment is actually the web browser.

@thiago-cs thiago-cs added the bug 🐛 An unexpected issue that highlights incorrect behavior label Jul 28, 2021
@ghost ghost added the needs triage 🔍 label Jul 28, 2021
@ghost
Copy link

ghost commented Jul 28, 2021

Hello thiago-cs, thank you for opening an issue with us!

I have automatically added a "needs triage" label to help get things started. Our team will analyze and investigate the issue, and escalate it to the relevant team if possible. Other community members may also look into the issue and provide feedback 🙌

@michael-hawker
Copy link
Member

Thanks @thiago-cs looks like the link should be https://github.com/CommunityToolkit/WindowsCommunityToolkit/blob/main/ReadMe.md#supported (not sure how the original link could have worked in the past though, so probably just an oversight). The PR template is here. Hmm, it uses relative links, so this may be a quirk of GitHub depending on where it's looking... We may need to put a full URL in there.

FYI @Nirmal4G this is also why renaming files can be problematic as they're case-sensitive for GitHub urls (readme.md != ReadMe.md). Not sure what other places we link to any of the files you've renamed. Can you revert your file name changes please before we diverge or find other cases where we may have issues? Thanks!

@michael-hawker michael-hawker added documentation 📃 and removed bug 🐛 An unexpected issue that highlights incorrect behavior needs triage 🔍 labels Jul 28, 2021
@michael-hawker michael-hawker added this to the 7.1 milestone Jul 28, 2021
@Nirmal4G
Copy link
Contributor

Original link was also broken. I've checked this too when creating my recent PRs. It was on my todo list. I wanted to check whether we have direct link references to readme.md in the wild, either to revert the rename or simply adjust our PR form link.

Seems, there are no direct references to our link outside our repo. Hence, it's safe to just update our links to reflect that. I have also updated my recent PR description to working link to confirm it.

See that the link https://github.com/CommunityToolkit/WindowsCommunityToolkit/ReadMe.md#supported also doesn't work.

But, the link https://github.com/CommunityToolkit/WindowsCommunityToolkit#supported works. If we want a relative link, then the link ../#supported also works.

I've updated my markdown PR with this patch.

@ghost ghost added the Completed 🔥 label Aug 12, 2021
@ghost ghost locked as resolved and limited conversation to collaborators Nov 3, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants