-
Notifications
You must be signed in to change notification settings - Fork 60.9k
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
Document how to avoid backlinks for references #35987
base: main
Are you sure you want to change the base?
Conversation
Thanks for opening this pull request! A GitHub docs team member should be by to give feedback soon. In the meantime, please check out the contributing guidelines. |
👓 Previews for changed contentThis comment is 🤖 automatically generated and will be overwritten every time changes are committed to this branch. The table contains an overview of files in the Content directory changesYou may find it useful to copy this table into the pull request summary. There you can edit it to share links to important articles or changes and to give a high-level overview of how the changes in your pull request support the overall goals of the pull request.
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server |
@mschoettle Thanks so much for opening a PR! I'll get this triaged for review ✨ |
The comment https://www.github.com/orgs/community/discussions/23123#discussioncomment-3239240 (posted 2.5 years ago) is relevant here because it established:
You may want to consider establishing whether a reasonably quick resolution, or at least clarification, about one or both of these sub-problems, is a reasonable goal before completing and merging a PR updating the doc. |
Thank you for that additional insight, @raiph! Our writers will be sure to consider this when they review this PR 💛 |
Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀 |
@nguyenalex836 @hectorsector Any update on this PR? |
- Thank you for the heads up, I'll check on the status and get back to
you.
- Friendly ping! Any updates on this?
- This is still on my radar, I'll provide an update soon.
…On Sat, Feb 15, 2025, 7:24 PM Matthias Schoettle ***@***.***> wrote:
@nguyenalex836 <https://github.com/nguyenalex836> @hectorsector
<https://github.com/hectorsector> Any update on this PR?
—
Reply to this email directly, view it on GitHub
<#35987 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AU76UJDWLEHD22YPO4HEIGT2P4PXRAVCNFSM6AAAAABVOAHK4CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNRQHA3TOMBWGY>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
[image: mschoettle]*mschoettle* left a comment (github/docs#35987)
<#35987 (comment)>
@nguyenalex836 <https://github.com/nguyenalex836> @hectorsector
<https://github.com/hectorsector> Any update on this PR?
—
Reply to this email directly, view it on GitHub
<#35987 (comment)>, or
unsubscribe
<https://github.com/notifications/unsubscribe-auth/AU76UJDWLEHD22YPO4HEIGT2P4PXRAVCNFSM6AAAAABVOAHK4CVHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDMNRQHA3TOMBWGY>
.
You are receiving this because you are subscribed to this thread.Message
ID: ***@***.***>
|
Avoiding backlinks to linked referencesReferences to issues, pull requests, etc. cause the referenced item to have a backlink to the referencing item. |
Why:
The existence of
redirect.github.com
does not seem to be documented.Yet, several projects, such as dependabot and Renovate Bot, make use of it to avoid backlink spam.
It would be good to have an official documentation for this.
What's being changed (if available, include any code snippets, screenshots, or gifs):
Adds a small section to "Auto-linked references and URLs" explaining that
redirect.github.com
can be used to avoid backlinks.See for example the discussion in: renovatebot/renovate#10796 (comment) and renovatebot/renovate#30980
Check off the following: