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

Update instructions in [Configuring a subdomain] help article #2184

Closed
peterjuma opened this issue Dec 17, 2020 · 6 comments · Fixed by #2961
Closed

Update instructions in [Configuring a subdomain] help article #2184

peterjuma opened this issue Dec 17, 2020 · 6 comments · Fixed by #2961
Labels
content This issue or pull request belongs to the Docs Content team good first issue Good for newcomers help wanted Anyone is welcome to open a pull request to fix this issue

Comments

@peterjuma
Copy link

What article on docs.github.com is affected?

https://docs.github.com/en/free-pro-team@latest/github/working-with-github-pages/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain

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

Current:

To set up a www or custom subdomain, such as www.example.com or blog.example.com, you must create a CNAME file in your site's repository and configure a CNAME record with your DNS provider.

It should probably be changed to something like:

To set up a www or custom subdomain, such as www.example.com or blog.example.com, you must add your domain in the repository settings, which will create a CNAME file in your site’s repository. After that, configure a CNAME record with your DNS provider.

Additional information

Users should NOT create the CNAME file themselves, this is done automatically once they update their custom domain settings with the domain name and hence the need for this change.

If we can get the wording that would explicitly convey to users that they should NOT create the CNAME file, that will be even better

CC for visibility
@github/support-technical
@github/business-support-all

@welcome
Copy link

welcome bot commented Dec 17, 2020

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 Dec 17, 2020
@janiceilene
Copy link
Contributor

@peterjuma Thanks for opening an issue! I'll get this triaged for the right team to take a look 👀

@janiceilene janiceilene added content This issue or pull request belongs to the Docs Content team core and removed triage Do not begin working on this issue until triaged by the team labels Dec 17, 2020
@Yuliadocs
Copy link

Hi, can I take this issue?

@katanakrypto

This comment has been minimized.

@janiceilene
Copy link
Contributor

You're welcome to open a PR @Yuliadocs 💖

@felicitymay
Copy link
Contributor

Hi @Yuliadocs - I'm just checking through issues and found the timeline on this one really confusing. None of the various pull requests listed in the issue history above are relevant.

This issue is still available to work on.

@janiceilene janiceilene added good first issue Good for newcomers help wanted Anyone is welcome to open a pull request to fix this issue labels Jan 15, 2021
ajs256 added a commit to ajs256/docs that referenced this issue Jan 18, 2021
Clarify that users should create a CNAME in repo settings, rather than creating it directly. This PR closes github#2184.
@janiceilene janiceilene linked a pull request Jan 19, 2021 that will close this issue
3 tasks
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 good first issue Good for newcomers help wanted Anyone is welcome to open a pull request to fix this issue
Projects
None yet
Development

Successfully merging a pull request may close this issue.

5 participants