Skip to content

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

Closed
@peterjuma

Description

@peterjuma

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    contentThis issue or pull request belongs to the Docs Content teamgood first issueGood for newcomershelp wantedAnyone is welcome to open a pull request to fix this issue

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions