Skip to content

Wildcard warning links to itself with no clarifying information #38152

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

Open
1 task done
chohlasa opened this issue May 9, 2025 · 2 comments
Open
1 task done

Wildcard warning links to itself with no clarifying information #38152

chohlasa opened this issue May 9, 2025 · 2 comments
Labels
content This issue or pull request belongs to the Docs Content team pages Content related to GitHub Pages

Comments

@chohlasa
Copy link

chohlasa commented May 9, 2025

Code of Conduct

What article on docs.github.com is affected?

Verifying your custom domain for GitHub Pages

What part(s) of the article would you like to see updated?

There is an embedded warning in the Verifying your custom domain for GitHub Pages section that says:

Warning

We strongly recommend that you do not use wildcard DNS records, such as *.example.com. These records put you at an immediate risk of domain takeovers, even if you verify the domain. For example, if you verify example.com this prevents someone from using a.example.com but they could still take over b.a.example.com (which is covered by the wildcard DNS record). For more information, see Verifying your custom domain for GitHub Pages.

(The embedded warning appears to come from here.)

But the link in this embedded warning points back to itself (the page it is contained on). And this help page does not include any additional information about wildcard domains, even though the embedded warning says "For more information, see ..."

I might suggest either:

  1. Adding more information to this page about how to avoid using a wildcard in DNS records, and what the preferred setup looks like
  2. Remove the promise for more information on this page in the embedded warning

Additional information

No response

@chohlasa chohlasa added the content This issue or pull request belongs to the Docs Content team label May 9, 2025
Copy link

welcome bot commented May 9, 2025

Thanks for opening this issue. 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 May 9, 2025
@Sharra-writes
Copy link
Contributor

@chohlasa Thanks for pointing this out! That's really not a very useful link. Let me see if I can track down what it was supposed to link to.

@Sharra-writes Sharra-writes added pages Content related to GitHub Pages and removed triage Do not begin working on this issue until triaged by the team labels May 9, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
content This issue or pull request belongs to the Docs Content team pages Content related to GitHub Pages
Projects
None yet
Development

No branches or pull requests

2 participants