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

Clarify process for custom domains on GitHub Pages #1588

Merged
merged 3 commits into from
Mar 21, 2025
Merged

Conversation

cwickham
Copy link
Collaborator

@cwickham cwickham commented Mar 18, 2025

Update Custom Domain section: Preview

Copy link
Contributor

🚀 Deployed on https://deploy-preview-1588.quarto.org

@github-actions github-actions bot temporarily deployed to pull request March 18, 2025 19:47 Inactive
Copy link
Contributor

@mcanouil mcanouil left a comment

Choose a reason for hiding this comment

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

Minor edits.

I think this is clearer in the sense that it better points towards GitHub Pages documentation for the domain configuration.


For the first step, the [GitHub Pages documentation](https://docs.github.com/en/pages/configuring-a-custom-domain-for-your-github-pages-site/managing-a-custom-domain-for-your-github-pages-site) describes adding your domain to your repository in the **Settings** pane.
However, this creates a `CNAME` file in the location of your rendered site,
which will be overwritten whenever you render your site.
Copy link
Contributor

Choose a reason for hiding this comment

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

I thought that it was helpful to explain that the file might be overwritten. Maybe leave that in?

@cwickham cwickham marked this pull request as ready for review March 21, 2025 17:22
@cwickham cwickham merged commit 5b40928 into main Mar 21, 2025
3 checks passed
@cwickham cwickham deleted the fix/custom-domains branch March 21, 2025 17:23
github-actions bot pushed a commit that referenced this pull request Mar 21, 2025
* Clarify

* Apply suggestions from code review

Co-authored-by: Mickaël Canouil <[email protected]>

* Callout values to pay attention to

---------

Co-authored-by: Mickaël Canouil <[email protected]>
(cherry picked from commit 5b40928)
Copy link
Contributor

Successfully created backport PR for prerelease:

Copy link
Contributor

🚀 Deployed on https://deploy-preview-1588.quarto.org

@github-actions github-actions bot temporarily deployed to pull request March 21, 2025 17:27 Inactive
cwickham added a commit that referenced this pull request Mar 21, 2025
* Clarify

* Apply suggestions from code review

Co-authored-by: Mickaël Canouil <[email protected]>

* Callout values to pay attention to

---------

Co-authored-by: Mickaël Canouil <[email protected]>
(cherry picked from commit 5b40928)

Co-authored-by: Charlotte Wickham <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants