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

Update managing-a-custom-domain-for-your-github-pages-site.md #34767

Merged
merged 3 commits into from
Oct 7, 2024
Merged

Update managing-a-custom-domain-for-your-github-pages-site.md #34767

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
0e93fb1
Update managing-a-custom-domain-for-your-github-pages-site.md
BenjaminBrienen Sep 28, 2024
a20d8fe
Merge branch 'main' into patch-1
nguyenalex836 Sep 30, 2024
160dc8e
Merge branch 'main' into patch-1
nguyenalex836 Oct 7, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion ...r-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md
View file
Open in desktop
nguyenalex836 marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
Expand Up @@ -162,7 +162,7 @@
| 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` | `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` |
Copy link
Contributor

Choose a reason for hiding this comment

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

FYI this was recently removed in #31358 — so just a heads up for triage to hopefully settle on a style and avoid changing it back and forth…

(TBH: I'd personally like to see it added back like in this PR, though…)

Copy link
Contributor

Choose a reason for hiding this comment

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

@janbrasna Thank you for the reminder @janbrasna! 💛 Let me put this up for review so we can get a second opinion on this

CC @BenjaminBrienen just for visibility (thanks for your patience!)

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I'm sure a little extra review on this isn't blocking anyone 😁

Copy link
Contributor

Choose a reason for hiding this comment

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

For the record… one half of the above mentioned PR got reverted pretty soon (something I didn't like back then, too) so this would revert the remaining change — and I see it as a good thing — the consistency callout with that specific page/table is my exact point from few months ago, too;)

And as DNS management UIs differ between providers there's not exactly one "correct" format for it per se to be completely copy-paste-ready all the time, so it's not worth fiddling with it too much beyond some basic correctness and consistency across the pages (in the future).

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks for bearing with us (me) @janbrasna 💛 we'll hopefully have a concrete direction on this soon to be abide by for the foreseeable future (outside of basic correctness and consistency like you mentioned)

Copy link
Contributor

Choose a reason for hiding this comment

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

Thanks so much @janbrasna and apologies for the confusion here—I'm not honestly sure what's happened but good that we're sorting it now.

And as DNS management UIs differ between providers there's not exactly one "correct" format for it per se to be completely copy-paste-ready all the time, so it's not worth fiddling with it too much beyond some basic correctness and consistency across the pages (in the future).

Agree with you completely here, so I'm happy to go ahead and make this change after the freeze Alex mentioned. Thanks for picking this up, @BenjaminBrienen—we'll merge this next week 👍

cc @nguyenalex836


## Removing a custom domain

Expand All @@ -173,7 +173,7 @@
{% data reusables.pages.sidebar-pages %}
1. Under "Custom domain," click **Remove**.

![Screenshot of a settings box to save or remove a custom domain on {% data variables.product.prodname_pages %} . To the right of a text box reading "example.com" is a button labeled "Remove" in red type.](/assets/images/help/pages/remove-custom-domain.png)

Check warning on line 176 in content/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site.md

View workflow job for this annotation

GitHub Actions / lint-content

Images alternate text should be between 40-150 characters 

Image alternate text is 171 characters long.

## Securing your custom domain

Expand Down
Loading