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.

Sign up for GitHub

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

Jump to bottom

Correcting how to configure CNAME for a subdomain #31358

Merged
merged 2 commits into from
Mar 22, 2024
Merged

Correcting how to configure CNAME for a subdomain #31358

merged 2 commits into from
Mar 22, 2024

Conversation

theandyyeh
Copy link
Contributor

@theandyyeh theandyyeh commented Jan 30, 2024 •
edited
Loading

Why:

Usually, to configure a subdomain, you only need to put subdomain itself to the host (e.g., "blog" as in blog.example.com).

Besides, the value of CNAME usually ends with a dot.

Closes:

What's being changed (if available, include any code snippets, screenshots, or gifs):

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline (this link will be available after opening the PR).

    • For content changes, you will also see an automatically generated comment with links directly to pages you've modified. The comment won't appear if your PR only edits files in the data directory.

  • For content changes, I have completed the self-review checklist.

@theandyyeh
Correcting how to configure CNAME for a subdomain
c005c99 
Usually, to configure a subdomain, you only need to put subdomain itself to the host (e.g., "blog" as in blog.example.com).

Besides, the value of CNAME usually ends with a dot.
@welcome Welcome
Copy link

welcome bot commented Jan 30, 2024

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 30, 2024
@github-actions GitHub Actions
Copy link
Contributor

github-actions bot commented Jan 30, 2024 •
edited
Loading

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
pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md fpt
ghec
 fpt
ghec

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

@nguyenalex836 nguyenalex836 added content This issue or pull request belongs to the Docs Content team 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 Jan 31, 2024
@nguyenalex836
Copy link
Contributor

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

janbrasna
janbrasna reviewed Feb 22, 2024
View reviewed changes
Copy link
Contributor

@janbrasna janbrasna left a comment

Choose a reason for hiding this comment

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

In that case the terminal dot should be in the org example too for consistency:

...tom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md
@@ -163,7 +163,7 @@ To configure an apex domain, you only need to pick a single DNS record type from
| Apex domain<br />(`example.com`) | `A` | `@` | `185.199.108.153`<br />`185.199.109.153`<br />`185.199.110.153`<br />`185.199.111.153` |
| Apex domain<br />(`example.com`) | `AAAA` | `@` | `2606:50c0:8000::153`<br />`2606:50c0:8001::153`<br />`2606:50c0:8002::153`<br />`2606:50c0:8003::153` |
| Apex domain<br />(`example.com`) | `ALIAS` or `ANAME` | `@` | `USERNAME.github.io` or<br /> `ORGANIZATION.github.io` |
| Subdomain<br />(`ww​w.example.com`,<br />`blog.example.com`) | `CNAME` | `SUBDOMAIN.example.com.` | `USERNAME.github.io` or<br /> `ORGANIZATION.github.io` |
| Subdomain<br />(`ww​w.example.com`,<br />`blog.example.com`) | `CNAME` | `SUBDOMAIN` | `USERNAME.github.io.` or<br /> `ORGANIZATION.github.io` |
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
| Subdomain<br />(`ww​w.example.com`,<br />`blog.example.com`) | `CNAME` | `SUBDOMAIN` | `USERNAME.github.io.` or<br /> `ORGANIZATION.github.io` |
| Subdomain<br />(`ww​w.example.com`,<br />`blog.example.com`) | `CNAME` | `SUBDOMAIN` | `USERNAME.github.io.` or<br /> `ORGANIZATION.github.io.` |

...tom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md
@@ -163,7 +163,7 @@ To configure an apex domain, you only need to pick a single DNS record type from
| Apex domain<br />(`example.com`) | `A` | `@` | `185.199.108.153`<br />`185.199.109.153`<br />`185.199.110.153`<br />`185.199.111.153` |
| Apex domain<br />(`example.com`) | `AAAA` | `@` | `2606:50c0:8000::153`<br />`2606:50c0:8001::153`<br />`2606:50c0:8002::153`<br />`2606:50c0:8003::153` |
| Apex domain<br />(`example.com`) | `ALIAS` or `ANAME` | `@` | `USERNAME.github.io` or<br /> `ORGANIZATION.github.io` |
Copy link
Contributor

Choose a reason for hiding this comment

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

And in the row above too:

Suggested change
| Apex domain<br />(`example.com`) | `ALIAS` or `ANAME` | `@` | `USERNAME.github.io` or<br /> `ORGANIZATION.github.io` |
| Apex domain<br />(`example.com`) | `ALIAS` or `ANAME` | `@` | `USERNAME.github.io.` or<br /> `ORGANIZATION.github.io.` |

Copy link
Contributor

Choose a reason for hiding this comment

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

Similar table is used in https://github.com/github/docs/blob/main/content/pages/getting-started-with-github-pages/securing-your-github-pages-site-with-https.md#verifying-the-dns-configuration

@nguyenalex836
Copy link
Contributor

@theandyyeh Thanks so much for opening a PR with this fix! I'll update the branch and get this merged once tests are passing 🍏

@nguyenalex836 nguyenalex836 removed the waiting for review Issue/PR is waiting for a writer's review label Mar 22, 2024
@nguyenalex836 nguyenalex836 enabled auto-merge March 22, 2024 16:11
@nguyenalex836 nguyenalex836 added this pull request to the merge queue Mar 22, 2024
Merged via the queue into github:main with commit 6bf54a0 Mar 22, 2024
39 checks passed
@github-actions GitHub Actions
Copy link
Contributor

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 ⚡

@janbrasna janbrasna mentioned this pull request Sep 30, 2024
Merged
2 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@janbrasna janbrasna janbrasna left review comments

@nguyenalex836 nguyenalex836 nguyenalex836 approved these changes

Assignees
No one assigned
Labels
content This issue or pull request belongs to the Docs Content team pages Content related to GitHub Pages
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@theandyyeh @nguyenalex836 @janbrasna