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.

Sign up for GitHub

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

pages: Update repo rename docs #2460

Merged
merged 2 commits into from
Jan 24, 2024
Merged

pages: Update repo rename docs #2460

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
c83ee5f
pages: Update repo rename docs
apburnes Jan 24, 2024
6694359
Apply suggestions from code review
apburnes Jan 24, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 11 additions & 8 deletions _pages/pages/documentation/renaming-site-repository.md
View file
Open in desktop
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.
Loading