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

Document how to avoid backlinks for references #35987

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

mschoettle
Copy link

@mschoettle mschoettle commented Jan 18, 2025

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:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require a SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the preview environment.

Copy link

welcome bot commented Jan 18, 2025

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.

@github-actions github-actions bot added the triage Do not begin working on this issue until triaged by the team label Jan 18, 2025
Copy link
Contributor

Automatically generated comment ℹ️

This 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 that have been changed in this pull request. It's provided to make it easy to review your changes on the staging site. Please note that changes to the data directory will not show up in this table.


Content directory changes

You 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.

Source Preview Production What Changed
get-started/writing-on-github/working-with-advanced-formatting/autolinked-references-and-urls.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10

fpt: Free, Pro, Team
ghec: GitHub Enterprise Cloud
ghes: GitHub Enterprise Server

@mschoettle mschoettle marked this pull request as ready for review January 18, 2025 22:19
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
triage Do not begin working on this issue until triaged by the team
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant