Skip to content

Update www-and-apex-domain-recommendation.md#4956

Merged
lucascosti merged 3 commits intogithub:mainfrom
JOJ0:patch-3
Apr 1, 2021
Merged

Update www-and-apex-domain-recommendation.md#4956
lucascosti merged 3 commits intogithub:mainfrom
JOJ0:patch-3

Conversation

@JOJ0
Copy link
Copy Markdown
Contributor

@JOJ0 JOJ0 commented Mar 31, 2021

Why:

The current docs were misleading to me and I had to ask github support why it doesn't work as expected. Support agent Tammy Metz was very helpful and clarified that actually only the special subdomain www is redirected to the apex domain.

What's being changed:

Trying to clarify that the www subdomain is treated differently compared to subdomains with other names.

@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Mar 31, 2021
tmetz
tmetz previously requested changes Mar 31, 2021
Copy link
Copy Markdown
Contributor

@tmetz tmetz left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks again for taking the time to submit these PRs @JOJ0! Again, I'll defer to our docs team, but this looks good to me (just suggesting one tweak).

@@ -1 +1 @@
If you are using an apex domain as your custom domain, we recommend also setting up a `www` subdomain. If you configure the correct records for each domain type through your DNS provider, {% data variables.product.prodname_pages %} will automatically create redirects between the domains. For example, if you configure `www.example.com` as your custom domain for your site, and you have `ALIAS` and `CNAME` records set up for the apex and `www` domains, then `example.com` will redirect to `www.example.com`. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site/#configuring-a-subdomain)."
If you are using an apex domain as your custom domain, we recommend also setting up a `www` subdomain. If you configure the correct records for each domain type through your DNS provider, {% data variables.product.prodname_pages %} will automatically create redirects between the domains. For example, if you configure `www.example.com` as your custom domain for your site, and you have `ALIAS` (alternatively `ANAME` or `A` records) and `CNAME` records set up for the apex and `www` domains, then `example.com` will redirect to `www.example.com`. Note that this is only the case for the `www` subdomains. Automatic redirects are not created for subdomains like e.g `blog`. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site/#configuring-a-subdomain)."
Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you are using an apex domain as your custom domain, we recommend also setting up a `www` subdomain. If you configure the correct records for each domain type through your DNS provider, {% data variables.product.prodname_pages %} will automatically create redirects between the domains. For example, if you configure `www.example.com` as your custom domain for your site, and you have `ALIAS` (alternatively `ANAME` or `A` records) and `CNAME` records set up for the apex and `www` domains, then `example.com` will redirect to `www.example.com`. Note that this is only the case for the `www` subdomains. Automatic redirects are not created for subdomains like e.g `blog`. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site/#configuring-a-subdomain)."
If you are using an apex domain as your custom domain, we recommend also setting up a `www` subdomain. If you configure the correct records for each domain type through your DNS provider, {% data variables.product.prodname_pages %} will automatically create redirects between the domains. For example, if you configure `www.example.com` as your custom domain for your site, and you have `ALIAS` (alternatively `ANAME` or `A` records) and `CNAME` records set up for the apex and `www` domains, then `example.com` will redirect to `www.example.com`. Note that this is only the case for the `www` subdomains. Automatic redirects are not created for subdomains such as, e.g., `blog`. For more information, see "[Managing a custom domain for your {% data variables.product.prodname_pages %} site](/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site/#configuring-a-subdomain)."

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

alright, that's better yes!

@janiceilene
Copy link
Copy Markdown
Contributor

@JOJ0 Thanks so much for opening a PR! I'll get this triaged for review 💖

@janiceilene janiceilene added pages Content related to GitHub Pages waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Mar 31, 2021
Copy link
Copy Markdown
Contributor

@lucascosti lucascosti left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks heaps for this too, @JOJ0 and @tmetz! I've pushed an extra commit (53b1375) to reword it a little, and fix up the link in the resuable (it's shouldn't link within the same article with the article's name).

I merge it in! 🚂

@lucascosti lucascosti dismissed tmetz’s stale review April 1, 2021 01:49

Changes made :)

@lucascosti lucascosti enabled auto-merge (squash) April 1, 2021 01:51
@lucascosti
Copy link
Copy Markdown
Contributor

🤔 One test seems to be stuck, so I'm to close and reopen this PR to unstick it...

@lucascosti lucascosti closed this Apr 1, 2021
auto-merge was automatically disabled April 1, 2021 02:04

Pull request was closed

@lucascosti lucascosti reopened this Apr 1, 2021
@github-actions github-actions Bot added the triage Do not begin working on this issue until triaged by the team label Apr 1, 2021
@lucascosti lucascosti enabled auto-merge (squash) April 1, 2021 02:05
@lucascosti lucascosti merged commit 9249129 into github:main Apr 1, 2021
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 1, 2021

Thanks very much for contributing! Your pull request has been merged 🎉 You should see your changes appear on the site in approximately 24 hours. If you're looking for your next contribution, check out our help wanted issues

@JOJ0 JOJ0 deleted the patch-3 branch April 2, 2021 05:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

pages Content related to GitHub Pages triage Do not begin working on this issue until triaged by the team waiting for review Issue/PR is waiting for a writer's review

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants