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

docs: use server relative URL #10406

Conversation

HonkingGoose
Copy link
Collaborator

@HonkingGoose HonkingGoose commented Jun 12, 2021

Changes:

  • Change URL from a relative link to a server relative link

Context:

Steps to reproduce the current problem:

  1. Get bot message: "Hey you need to fill out the new package manager questionnaire".
  2. User copy/pastes questionnaire into new comment on their issue.
  3. Navigate to comment on issue.
  4. If you click on the link in "I've read the adding a package manager documentation." you get a "file not found" warning from GitHub.

I think it makes more sense to use a server relative link, as people will click on the link online more often than they will use the link locally on a cloned repository.

Documentation (please check one with an [x])

  • I have updated the documentation, or
  • No documentation update is required

How I've tested my work (please tick one)

I have verified these changes via:

  • Code inspection only, or
  • Newly added unit tests, or
  • No new tests but ran on a real repository, or
  • Both unit tests + ran on a real repository

@HonkingGoose
Copy link
Collaborator Author

Are you sure that will work properly once deployed? It seems broken from the GitHub PR file preview "rich diff"?

Current "server relative link" from GitHub "rich diff" preview:

https://github.com/renovatebot/renovate/blob/main/renovatebot/renovate/blob/HEAD/docs/development/adding-a-package-manager.md

Working link to file on HEAD:

https://github.com/renovatebot/renovate/blob/HEAD/docs/development/new-package-manager-template.md

@HonkingGoose HonkingGoose marked this pull request as draft June 12, 2021 08:03
@viceice
Copy link
Member

viceice commented Jun 12, 2021

Are you sure that will work properly once deployed? It seems broken from the GitHub PR file preview "rich diff"?

Current "server relative link" from GitHub "rich diff" preview:

https://github.com/renovatebot/renovate/blob/main/renovatebot/renovate/blob/HEAD/docs/development/adding-a-package-manager.md

Working link to file on HEAD:

https://github.com/renovatebot/renovate/blob/HEAD/docs/development/new-package-manager-template.md

🤔 Not 💯 sure, but it seems a GitHub UI bug. Those links work when used in issues.

@HonkingGoose HonkingGoose force-pushed the chore/fix-bad-link-to-adding-package-manager-docs branch 2 times, most recently from e0ab4c4 to ca847ff Compare June 12, 2021 09:35
@HonkingGoose HonkingGoose changed the title docs: use absolute URL docs: use server relative URL Jun 12, 2021
@HonkingGoose
Copy link
Collaborator Author

🤔 Not 💯 sure, but it seems a GitHub UI bug. Those links work when used in issues.

It works for me too when I tried it in a issue preview screen. 😉

@HonkingGoose HonkingGoose force-pushed the chore/fix-bad-link-to-adding-package-manager-docs branch from ca847ff to 096099a Compare June 12, 2021 10:26
@HonkingGoose HonkingGoose marked this pull request as ready for review June 12, 2021 10:26
@HonkingGoose
Copy link
Collaborator Author

This is ready for a final review now, sorry for the mess/noise I caused with my force pushing, I wanted to clean up the final commit message. 🙈

@viceice viceice enabled auto-merge (squash) June 12, 2021 11:54
@viceice viceice merged commit d824dc8 into renovatebot:main Jun 12, 2021
nielsbasjes pushed a commit to nielsbasjes/renovate that referenced this pull request Jun 12, 2021
Co-authored-by: Michael Kriese <michael.kriese@visualon.de>
@HonkingGoose HonkingGoose deleted the chore/fix-bad-link-to-adding-package-manager-docs branch June 12, 2021 13:51
@renovate-release
Copy link
Collaborator

🎉 This PR is included in version 25.41.1 🎉

The release is available on:

Your semantic-release bot 📦🚀

@github-actions github-actions bot locked as resolved and limited conversation to collaborators Jul 15, 2021
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants