Skip to content

Commit

Permalink
chore: Update custom domain docs and images with updated UI functions (
Browse files Browse the repository at this point in the history
…#2456)

* chore: Update custom domain docs and images with updated UI functions

* Update _pages/pages/documentation/before-you-launch.md

Co-authored-by: Drew Bollinger <[email protected]>

* Update _pages/pages/documentation/custom-domains.md

Co-authored-by: Drew Bollinger <[email protected]>

---------

Co-authored-by: Drew Bollinger <[email protected]>
  • Loading branch information
apburnes and drewbo authored Dec 19, 2023
1 parent 21b8a42 commit afec936
Show file tree
Hide file tree
Showing 6 changed files with 13 additions and 9 deletions.
Binary file added _assets/images/pages/custom-domain-create.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed _assets/images/pages/federalist-settings.png
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
2 changes: 1 addition & 1 deletion _pages/pages/documentation/before-you-launch.md
Original file line number Diff line number Diff line change
Expand Up @@ -39,4 +39,4 @@ We've worked to make publishing a government site on Pages as simple as possible
1. Notify Pages support that you are ready to launch your site
2. [Configure your DNS]({{ site.baseurl }}{% link _pages/pages/documentation/custom-domains.md %}#configure-your-dns)
3. Notify Pages support
4. [Update your site settings]({{ site.baseurl }}{% link _pages/pages/documentation/custom-domains.md %}#update-your-site-settings)
4. [Configure your custom domain]({{ site.baseurl }}{% link _pages/pages/documentation/custom-domains.md %}#configure-your-custom-domain))
18 changes: 11 additions & 7 deletions _pages/pages/documentation/custom-domains.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ It is possible to add up to 2 custom domains for your site, each one requires th
- [Minimizing downtime](#minimizing-downtime)
* [CAA records](#caa-records)
2. [Notify Pages](#notify-pages)
3. [Update your Site Settings](#update-your-site-settings)
3. [Configure your custom domain](#configure-your-custom-domain)

---

Expand Down Expand Up @@ -122,13 +122,17 @@ Someone from the Pages support team will assist you and make the updates to the

---

## Update your site settings
Once the Pages team has notified you that the platform changes are complete, update your Site Settings to reflect the new custom domain.
## Configure your custom domain
Before the platform can launch a custom domain for your site, you will need to configure the domain name and the branch name to prepare the site for the custom domain.

1. In the Pages web application, navigate to the Site Settings page for your site by clicking on the `Site Settings` link on the lefthand navigation:
1. In the Pages web application, navigate to the **Custom Domains** page for your site by clicking on the `Custom Domains` link on the lefthand navigation:

2. Under "Live Site" enter the branch name you want to associate to the custom domain and full url of the domain you just configured. When you are done, (scroll down if necessary and) click "save basic settings"
2. Click the `Add new domain` button and enter the name of the custom domain into the `Domain Name` input and select the branch name you want to associate in the `Branch Context` input.

![Site Settings 2]({{ site.baseurl }}/assets/images/pages/federalist-settings.png)
![Site Custom Domain]({{ site.baseurl }}/assets/images/pages/custom-domain-create.png)

3. Pages will rebuild your site and then it will be available at the custom domain. If you notice that your site does not look correct and/or any site assets (css, js, images) appear to be missing, make sure that the urls to those assets are correct, we provide the environment variable `BASEURL` for this purpose. If using Jekyll, please make sure you use `site.baseurl` when constructing asset urls manually or use the `asset` helper tag if using the `jekyll-assets` gem.
*If you do not see the branch name in the `Branch Context` select, go to the **Site Settings** page and enter the branch name in the `Live site` or `Demo site` inputs under `Branch Configurations`.*

![Site Settings Branch Configurations]({{ site.baseurl }}/assets/images/pages/pages-site-settings-branch-config.png)

3. The Pages platform will be ready to launch your new custom domain, so email the Pages team to complete launch of the custom domain.
2 changes: 1 addition & 1 deletion _pages/pages/documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ The [18F method cards](https://methods.18f.gov/) are an overview of several diff
The Pages team also provides a [content guide specifically for Pages websites]({{site.baseurl}}/pages/documentation/content-guide/). This guide will help you "convey what your team does, using language and tone that a general audience will understand, or how to think about what to write in each section of your new website."

## Managing site settings
![Pages Settings Screenshot]({{site.baseurl}}/assets/images/pages/federalist-settings.png)
![Pages Settings Screenshot]({{site.baseurl}}/assets/images/pages/pages-site-settings-branch-config.png)

The settings option for a site lets you adjust how Pages handles the site. These settings are for advanced functionality and most people will not need to change them.

Expand Down

0 comments on commit afec936

Please sign in to comment.