-
Notifications
You must be signed in to change notification settings - Fork 60.8k
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
base: main
Are you sure you want to change the base?
Update about-github-pages.md #36175
Conversation
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. |
👓 Previews for changed contentThis 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.
Key: fpt: Free, Pro, Team; ghec: GitHub Enterprise Cloud; ghes: GitHub Enterprise Server |
Thanks for opening a pull request! We've triaged this issue for technical review by a subject matter expert 👀 |
There was a problem hiding this 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
|
||
**Note: Github pages works around 10 minutes after you renamed/created the repository.** | ||
|
There was a problem hiding this comment.
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
**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 %} |
There was a problem hiding this comment.
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?
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 %} |
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: