Skip to content

Conversation

brianwaithaka
Copy link
Contributor

@brianwaithaka brianwaithaka commented Jun 15, 2023

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

  • Changing this doc by adding a new entry under point 8
  • Adding a reusables.pages.build-remotely-verify-subdomain file with the actual text
Screenshot 2023-06-15 at 10 19 52

Check off the following:

  • I have reviewed my changes in staging, available via the View deployment link in this PR's timeline.

    • 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.

brianwaithaka and others added 3 commits June 14, 2023 20:35
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
@welcome
Copy link

welcome bot commented Jun 15, 2023

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 Jun 15, 2023
@github-actions
Copy link
Contributor

github-actions bot commented Jun 15, 2023

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
ghae: GitHub AE

@cmwilson21
Copy link
Contributor

@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. 👍

@cmwilson21 cmwilson21 added content This issue or pull request belongs to the Docs Content team waiting for review Issue/PR is waiting for a writer's review pages Content related to GitHub Pages and removed triage Do not begin working on this issue until triaged by the team labels Jun 16, 2023
@sophietheking sophietheking added the needs SME This proposal needs review from a subject matter expert label Jun 26, 2023
@github-actions
Copy link
Contributor

Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀

@cmwilson21 cmwilson21 added SME reviewed An SME has reviewed this issue/PR and removed needs SME This proposal needs review from a subject matter expert labels Jul 19, 2023
@cmwilson21
Copy link
Contributor

@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?

@cmwilson21
Copy link
Contributor

👋 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 ✨

@brianwaithaka
Copy link
Contributor Author

Well noted, I will update accordingly

@brianwaithaka
Copy link
Contributor Author

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.
Docs only suggest cname file method which applies to deploying from a branch

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

@cmwilson21
Copy link
Contributor

@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 👀

@brianwaithaka
Copy link
Contributor Author

Hello, @cmwilson21 , updates made. Please review

@cmwilson21
Copy link
Contributor

@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 -
"I would refactor step 8 into the verification they mentioned, since it applies to both cases, and pull out step 8 and 9 into options, since neither are steps you need to always take"

@cmwilson21 cmwilson21 added the more-information-needed More information is needed to complete review label Oct 18, 2023
@github-actions github-actions bot added the stale There is no recent activity on this issue or pull request label Oct 25, 2023
@github-actions
Copy link
Contributor

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.

@github-actions github-actions bot closed this Oct 25, 2023
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 more-information-needed More information is needed to complete review pages Content related to GitHub Pages SME reviewed An SME has reviewed this issue/PR stale There is no recent activity on this issue or pull request waiting for review Issue/PR is waiting for a writer's review
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Configuring custom domain for github pages site that was built remotely
3 participants