Skip to content

Commit

Permalink
pages: Update repo rename docs (#2460)
Browse files Browse the repository at this point in the history
* pages: Update repo rename docs

* Apply suggestions from code review

Co-authored-by: Sven Aas <[email protected]>

---------

Co-authored-by: Sven Aas <[email protected]>
  • Loading branch information
apburnes and svenaas authored Jan 24, 2024
1 parent 9891b98 commit 524b2c6
Showing 1 changed file with 11 additions and 8 deletions.
19 changes: 11 additions & 8 deletions _pages/pages/documentation/renaming-site-repository.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,17 @@ navigation: pages
sidenav: pages-documentation
---

## Updating your Pages site after renaming your repository
## Renaming your Pages site repository

Renaming your site repository will interrupt a site's ability to build. In order to resume site building, it will require you to add a new site to Pages with the new repository url. (Note: Please be aware that if your site is already live and its repository has been renamed, it will be frozen until a new site is added to Pages at the new repository and a security scan is successfully performed on your new site.)
Renaming your site's GitHub repository will interrupt its ability to build. In order to resume site building, it will require you to notify our support team <a href="mailto:[email protected]">[email protected]</a> about your change in repository organizations and/or name. (Note: Please be aware that if your site is already live and its repository has been renamed, it will be frozen until the Pages team can update your site's Github repository.)

## Next steps after renaming your repository
## Steps for renaming your repository

1. Add the new site repository as described [here]({{site.baseurl}}/pages/documentation/#adding-a-new-site)
2. Build your site and verify that the site is ready for launch using our preview URLs.
3. Contact the Pages team; we’ll scan your site within a few days as part of our compliance process and let you know of the results.
4. Let us know when you are ready to go live with the new site and we will update your CloudFront URL to point to your new site.
5. Optional: After the new site is live, you can delete the old site within Site Settings. (Note: Once deleted, the settings and build history for the site will be lost and is not transferable to a different site.)
1. Notify <a href="mailto:[email protected]">[email protected]</a> about the upcoming change to the GitHub repository. Provide Pages support the following:
- The Pages site the GitHub repository change will affect.
- The email of the Pages user that has admin access to the newly renamed GitHub repository
- The GitHub organization and/or repository name that will be changing in the rename.
- Schedule a time to rename the GitHub repository
2. Rename the GitHub repository with its updated organizations and/or name
3. Wait as the Pages support team to update your Pages site to the renamed repository
4. After the site update, create a test branch to verify the site is building as expected.

0 comments on commit 524b2c6

Please sign in to comment.