-
Notifications
You must be signed in to change notification settings - Fork 63.1k
Add content - configure subdomain for github pages site that was built using actions workflow #26016
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
Conversation
Addition to current docs to assist users who build and publish directly using custom GitHub Actions workflow.
Adding instruction for users who publish using custom GitHub Actions workflow as it does not add a CNAME file to the gh-pages environment
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. |
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 changesYou 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.
fpt: Free, Pro, Team |
…main.md Missed .md at end of file
@brianwaithaka Thanks so much for opening a PR! We appreciate the extra context and screenshot! ✨ I'll get this triaged for review ⚡ In the meantime, if you're looking for other contributions, check out our help wanted section to find open issues you can work on. 👍 |
Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀 |
@brianwaithaka Checked in with the team on this one, this is a good point but the PR is somewhat incorrect. Point 8 in the doc page linked above does not apply to sites built with a custom workflow. Instead of storing the domain in a CNAME file, it needs to be done in the Pages settings. Linking to the domain verification doc is a good general call out but it does not describe how to associate a custom domain with a site, only how to verify a domain. Can you update the PR to reflect the team feedback? |
👋 Forgot to mention, ping me here in the issue when the updates have been made and I'll get the review process started on it again ✨ |
Well noted, I will update accordingly |
Hi @cmwilson21 , sorry for the delay. Just some clarification needed please. So issue was that when building the site and publishing directly to gh-pages env + setting up the subdomain in pages settings, i still could not get it to work. Therefore, by verifying the subdomain under account settings, after setting it up in pages settings for the repo, it worked. Do you suggest this info be provided as a note or additional point under 8 in the #configuring-a-subdomain section ? on this site Please guide since team feedback suggests scraping the point from here altogether and/or perhaps placing it under the troubleshooting page |
@brianwaithaka Thanks for following up with this! I think making it a note will do. The reviewer may have other thoughts but by committing that update, we can get it on the review board again 👀 |
Hello, @cmwilson21 , updates made. Please review |
@brianwaithaka Sorry for the delay! Some folks from the team have been out so I've had to ask in other places about this one. Unfortunately, I'm super unfamiliar with this subject, but the last SME I checked in with left this feedback - |
This PR has been automatically closed because there has been no response to to our request for more information from the original author. Please reach out if you have the information we requested, or open a new issue to describing your changes. Then we can begin the review process. |
Why:
Current docs do not cover use case where using a static generator and a custom GitHub Actions workflow builds and publishes directly to github-pages environment
Since workflow builds and deploys directly, adding a cname file only covers use case of deploying GitHub Pages from a branch
https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain
Closes: #26014
What's being changed (if available, include any code snippets, screenshots, or gifs):
https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site#configuring-a-subdomain
Check off the following:
I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.
data
directory.For content changes, I have completed the self-review checklist.