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 about-github-pages.md #36175

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update about-github-pages.md #36175

wants to merge 1 commit into from

Conversation

superjolt
Copy link

Why:

Closes: #36174 (comment)

What's being changed (if available, include any code snippets, screenshots, or gifs):

Made the text and did the according changes as in the issue.
Added a note in bold to say that it works after 10 minutes or so.
Made every "create a repository" to "create/rename a repository"

Check off the following:

  • A subject matter expert (SME) has reviewed the technical accuracy of the content in this PR. In most cases, the author can be the SME. Open source contributions may require an SME review from GitHub staff.
  • The changes in this PR meet the docs fundamentals that are required for all content.
  • All CI checks are passing and the changes look good in the preview environment.

Copy link

welcome bot commented Feb 5, 2025

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 Feb 5, 2025
Copy link
Contributor

github-actions bot commented Feb 5, 2025

👓 Previews for changed content

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 review server. 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/getting-started-with-github-pages/about-github-pages.md fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10
fpt
ghec
ghes@ 3.15 3.14 3.13 3.12 3.11 3.10

Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server
This table is posted from the Content Changes Table Comment workflow.

@isaacmbrown isaacmbrown added the needs SME This proposal needs review from a subject matter expert label Feb 5, 2025
Copy link
Contributor

github-actions bot commented Feb 5, 2025

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

@isaacmbrown isaacmbrown added waiting for review Issue/PR is waiting for a writer's review and removed triage Do not begin working on this issue until triaged by the team labels Feb 5, 2025
Copy link
Contributor

@isaacmbrown isaacmbrown left a comment

Choose a reason for hiding this comment

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

Hi @superjolt, thanks for the contribution! Your reasoning makes sense to me. I checked in with someone from the Pages team and left a couple of suggestions - let me know what you think

Comment on lines +45 to +47

**Note: Github pages works around 10 minutes after you renamed/created the repository.**

Copy link
Contributor

Choose a reason for hiding this comment

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

I checked and we actually have a piece of reusable content that should cover this 🙂 It would be good to use that here to help maintainability

Suggested change
**Note: Github pages works around 10 minutes after you renamed/created the repository.**
{% data reusables.pages.twenty-minutes-to-publish %}

Despite the misleading name, it says:

It can take up to 10 minutes for changes to your site to publish after you push the changes to {% data variables.product.github %}. If you don't see your {% data variables.product.prodname_pages %} site changes reflected in your browser after an hour, see AUTOTITLE.

@@ -40,7 +40,11 @@ Organization owners can disable the publication of {% data variables.product.pro

There are three types of {% data variables.product.prodname_pages %} sites: project, user, and organization. Project sites are connected to a specific project hosted on {% data variables.product.github %}, such as a JavaScript library or a recipe collection. User and organization sites are connected to a specific account on {% data variables.location.product_location %}.

To publish a user site, you must create a repository owned by your personal account that's named {% ifversion fpt or ghec %}`<username>.github.io`{% else %}`<username>.<hostname>`{% endif %}. To publish an organization site, you must create a repository owned by an organization that's named {% ifversion fpt or ghec %}`<organization>.github.io`{% else %}`<organization>.<hostname>`{% endif %}. {% ifversion fpt or ghec %}Unless you're using a custom domain, user and organization sites are available at `http(s)://<username>.github.io` or `http(s)://<organization>.github.io`.{% endif %}
To publish a user site, you must create OR rename a repository owned by your personal account that's named {% ifversion fpt or ghec %}`<username>.github.io`{% else %}`<username>.<hostname>`{% endif %}. To publish an organization site, you must create OR rename a repository owned by an organization that's named {% ifversion fpt or ghec %}`<organization>.github.io`{% else %}`<organization>.<hostname>`{% endif %}. {% ifversion fpt or ghec %}Unless you're using a custom domain, user and organization sites are available at `http(s)://<username>.github.io` or `http(s)://<organization>.github.io`.{% endif %}
Copy link
Contributor

Choose a reason for hiding this comment

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

To best present this info at the point of need, I actually suggest simplifying this section to avoid mentioning creating or renaming at all. If you want, you could then edit Creating a repository for your site to explicitly mention the option of renaming a repo. How does that sound to you?

Suggested change
To publish a user site, you must create OR rename a repository owned by your personal account that's named {% ifversion fpt or ghec %}`<username>.github.io`{% else %}`<username>.<hostname>`{% endif %}. To publish an organization site, you must create OR rename a repository owned by an organization that's named {% ifversion fpt or ghec %}`<organization>.github.io`{% else %}`<organization>.<hostname>`{% endif %}. {% ifversion fpt or ghec %}Unless you're using a custom domain, user and organization sites are available at `http(s)://<username>.github.io` or `http(s)://<organization>.github.io`.{% endif %}
* User sites are hosted in a repository owned your personal account, named {% ifversion fpt or ghec %}`<username>.github.io`{% else %}`<username>.<hostname>`{% endif %}.
* Organization sites are hosted in a repository owned by an organization, named {% ifversion fpt or ghec %}`<organization>.github.io`{% else %}`<organization>.<hostname>`{% endif %}.
{% ifversion fpt or ghec %}Unless you're using a custom domain, user and organization sites are available at `http(s)://<username>.github.io` or `http(s)://<organization>.github.io`.{% endif %}

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs SME This proposal needs review from a subject matter expert 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.

Github Pages edit on renaming repository
2 participants