From c6201617ce357d3742f54877b5cfd5e9cee36c0c Mon Sep 17 00:00:00 2001 From: David Corwin Date: Thu, 14 Apr 2022 14:22:49 -0700 Subject: [PATCH 1/3] Update launch checklist, custom domains and jekyll guides --- pages/documentation/before-you-launch.md | 19 ++++--- pages/documentation/custom-domains.md | 50 ++++++++----------- .../getting-started-with-jekyll.md | 7 +-- 3 files changed, 33 insertions(+), 43 deletions(-) diff --git a/pages/documentation/before-you-launch.md b/pages/documentation/before-you-launch.md index b54786e3..ec4e9a1a 100644 --- a/pages/documentation/before-you-launch.md +++ b/pages/documentation/before-you-launch.md @@ -30,19 +30,19 @@ We've worked to make publishing a government site on Federalist as simple as pos - email: `federalist-support@gsa.gov` - Slack: `#federalist-support` -2. Federalist support will: -- initiate GSA IT-provided scans of the preview build and source code of your site to identify any vulnerabilites -- send you a brief site questionnaire that must be completed before continuing +2. Federalist support will send you a brief site questionnaire that must be completed before continuing. -3. Complete the site questionnaire and resolve all required vulnerabilities identified by the scans as identified by Federalist Support (this may take several scans) +3. Upon receipt of the completed site questionnaire, Federalist support will perform a static code scan of your repository and request a live site scan of your preview build to identify any vulnerabilities. If your repository is not open source, you must provide access to the source by either sending an archive to Federalist support or adding a Federalist operator as a read-only collaborator. -4. Complete the process of [adding your custom domain](/documentation/custom-domains). If you are migrating an existing site to Federalist, make sure to review [minimizing downtime](/documentation/custom-domains#minimizing-downtime) +4. After all findings from the aforementioned scans are resolved, your site is ready to launch! -5. Your site will now be live! +5. Complete the process of [adding your custom domain](/documentation/custom-domains) and notify Federalist Support. If you are migrating an existing site to Federalist, make sure to review [minimizing downtime](/documentation/custom-domains#minimizing-downtime). -6. A scan of your custom domain will be run by GSA IT just to verify the final configuration, then the Federalist ISSO will share the Site Review document for your product owner to sign +6. Federalist Support will reach out once the custom domain has been provisioned and your site is live!! Note, current limitations require a rebuild of your site once it is provisioned, so there may be a slight delay between then the custom domain resolves to your site and when css, images, and other assets are linked properly. This is triggered automatically, but if you have concerns, you can follow the steps in [minimizing downtime](/documentation/custom-domains#minimizing-downtime). -6. Sign and return the Site Review document provided by the Federalist ISSO +7. An additional live site scan of your custom domain will be run by GSA IT just to verify the final configuration, then the Federalist ISSO will share the Site Review document for your product owner to sign. + +8. Sign and return the Site Review document provided to the Federalist ISSO. ## Launch Checklist @@ -52,5 +52,4 @@ We've worked to make publishing a government site on Federalist as simple as pos 3. Resolve any findings identified by vulnerability scans 4. [Configure your DNS](/documentation/custom-domains#configure-your-dns) 5. Notify Federalist support -6. [Update your site settings](/documentation/custom-domains#update-your-site-settings) -7. Sign and return the Site Review document to the Federalist ISSO \ No newline at end of file +6. Sign and return the Site Review document to the Federalist ISSO \ No newline at end of file diff --git a/pages/documentation/custom-domains.md b/pages/documentation/custom-domains.md index b90dab99..e6d5f7ec 100644 --- a/pages/documentation/custom-domains.md +++ b/pages/documentation/custom-domains.md @@ -11,17 +11,17 @@ If you are migrating an existing site to Federalist and wish to minimize downtim It is possible to add up to 2 custom domains for your site, each one requires the completion of the following 3 steps: -1. [Configure your DNS](#configure-your-dns) - * [Determine your domain type](#determine-your-domain-type) - * [Adding an apex domain](#adding-an-apex-domain) - - [Your DNS provider supports `ALIAS` records](#your-dns-provider-supports-alias-records) - - [Your DNS provider does **not** support `ALIAS` records](#your-dns-provider-does-not-support-alias-records) - * [Adding a subdomain](#adding-a-subdomain) - - [Minimizing downtime](#minimizing-downtime) - * [IPv6](#ipv6) - * [CAA records](#caa-records) -2. [Notify Federalist](#notify-federalist) -3. [Update your Site Settings](#update-your-site-settings) +- [Configure your DNS](#configure-your-dns) + - [Determine your domain type](#determine-your-domain-type) + - [Examples](#examples) + - [Adding an apex domain](#adding-an-apex-domain) + - [Your DNS provider supports `ALIAS` records](#your-dns-provider-supports-alias-records) + - [Your DNS provider does **not** support `ALIAS` records](#your-dns-provider-does-not-support-alias-records) + - [Adding a subdomain](#adding-a-subdomain) + - [Minimizing downtime](#minimizing-downtime) + - [IPv6](#ipv6) + - [CAA records](#caa-records) +- [Notify Federalist](#notify-federalist) --- @@ -51,8 +51,17 @@ An "apex" or "2nd level" domain is the "root" of your domain and will contain on Because Federalist does not currently provide static IP addresses, in order for Federalist to serve a site at an apex domain your DNS provider must support `ALIAS` records. If they do not, you may require additional help for Federalist to be able to serve your site at that domain. -- [Your DNS provider supports `ALIAS` records](#your-dns-provider-supports-alias-records) -- [Your DNS provider does **not** support `ALIAS` records](#your-dns-provider-does-not-support-alias-records) +- [Configure your DNS](#configure-your-dns) + - [Determine your domain type](#determine-your-domain-type) + - [Examples](#examples) + - [Adding an apex domain](#adding-an-apex-domain) + - [Your DNS provider supports `ALIAS` records](#your-dns-provider-supports-alias-records) + - [Your DNS provider does **not** support `ALIAS` records](#your-dns-provider-does-not-support-alias-records) + - [Adding a subdomain](#adding-a-subdomain) + - [Minimizing downtime](#minimizing-downtime) + - [IPv6](#ipv6) + - [CAA records](#caa-records) +- [Notify Federalist](#notify-federalist) #### Your DNS provider supports `ALIAS` records @@ -126,18 +135,3 @@ Once your DNS changes are complete, notify Federalist support via: - Slack: `#federalist-support` Someone from the Federalist support team will assist you and make the updates to the Federalist platform. - ---- - -## Update your site settings -Once the Federalist team has notified you that the platform changes are complete, update your Site Settings to reflect the new custom domain. - -1. In the Federalist web application, navigate to the Site Settings page for your site by clicking on the `Site Settings` link on the lefthand navigation: - - ![Site Settings 1]({{ site.baseurl }}/assets/images/site-settings-1.png) - -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" - - ![Site Settings 2]({{ site.baseurl }}/assets/images/site-settings-2.png) - -3. Federalist 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. \ No newline at end of file diff --git a/pages/documentation/getting-started-with-jekyll.md b/pages/documentation/getting-started-with-jekyll.md index 9b5bedc2..83560e43 100644 --- a/pages/documentation/getting-started-with-jekyll.md +++ b/pages/documentation/getting-started-with-jekyll.md @@ -170,9 +170,6 @@ Once you've got the basics down, we recommend that you check out our [customizat guide]({{ site.baseurl }}{% link pages/documentation/customization.md %}) for some more details on how to customize your site. +## Assets and internal links -[Federalist]: {{ site.baseurl }} -[federalist-sites]: {{ site.baseurl }}/sites -[resources-front-matter]: {{ site.baseurl }}{% link pages/documentation/resources.md %}#working-with-front-matter -[resources-markdown]: {{ site.baseurl }}{% link pages/documentation/resources.md %}#working-with-markdown -[resources-yaml]: {{ site.baseurl }}{% link pages/documentation/resources.md %}#working-with-yaml +Make sure that the urls to assets and internal links will be correct locally, for preview builds and custom domains by using `site.baseurl` when constructing asset urls manually or use the `asset` helper tag if using the `jekyll-assets` gem. The value is provided by the platform environment variable `BASEURL`. See [environment-variables](env-vars-federalist) for more information. From 7650a7f08b9b558e7427db813f255467c67f16a3 Mon Sep 17 00:00:00 2001 From: David Corwin Date: Thu, 14 Apr 2022 14:28:30 -0700 Subject: [PATCH 2/3] Update link --- pages/documentation/getting-started-with-jekyll.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pages/documentation/getting-started-with-jekyll.md b/pages/documentation/getting-started-with-jekyll.md index 83560e43..a498048d 100644 --- a/pages/documentation/getting-started-with-jekyll.md +++ b/pages/documentation/getting-started-with-jekyll.md @@ -172,4 +172,4 @@ some more details on how to customize your site. ## Assets and internal links -Make sure that the urls to assets and internal links will be correct locally, for preview builds and custom domains by using `site.baseurl` when constructing asset urls manually or use the `asset` helper tag if using the `jekyll-assets` gem. The value is provided by the platform environment variable `BASEURL`. See [environment-variables](env-vars-federalist) for more information. +Make sure that the urls to assets and internal links will be correct locally, for preview builds and custom domains by using `site.baseurl` when constructing asset urls manually or use the `asset` helper tag if using the `jekyll-assets` gem. The value is provided by the platform environment variable `BASEURL`. See [build environment variables](../env-vars-on-federalist-builds) for more information. From e98503217a5fbcce21f84d5c4522d29dc4b84aae Mon Sep 17 00:00:00 2001 From: David Corwin Date: Thu, 14 Apr 2022 14:31:47 -0700 Subject: [PATCH 3/3] update internal links --- pages/documentation/before-you-launch.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/pages/documentation/before-you-launch.md b/pages/documentation/before-you-launch.md index ec4e9a1a..51019a26 100644 --- a/pages/documentation/before-you-launch.md +++ b/pages/documentation/before-you-launch.md @@ -19,7 +19,7 @@ We've worked to make publishing a government site on Federalist as simple as pos - Your agency must accept the risk of launching a site on Federalist. This requirement varies by agency, some will accept Federalist's GSA Agency ATO while others may require additional documentation. -- You must understand [your responsibilities](/documentation/customer-responsibilities). +- You must understand [your responsibilities](../customer-responsibilities). - Ensure you know how, or who to contact to make changes to the DNS configuration for your domain. @@ -36,9 +36,9 @@ We've worked to make publishing a government site on Federalist as simple as pos 4. After all findings from the aforementioned scans are resolved, your site is ready to launch! -5. Complete the process of [adding your custom domain](/documentation/custom-domains) and notify Federalist Support. If you are migrating an existing site to Federalist, make sure to review [minimizing downtime](/documentation/custom-domains#minimizing-downtime). +5. Complete the process of [adding your custom domain](../custom-domains) and notify Federalist Support. If you are migrating an existing site to Federalist, make sure to review [minimizing downtime](../custom-domains#minimizing-downtime). -6. Federalist Support will reach out once the custom domain has been provisioned and your site is live!! Note, current limitations require a rebuild of your site once it is provisioned, so there may be a slight delay between then the custom domain resolves to your site and when css, images, and other assets are linked properly. This is triggered automatically, but if you have concerns, you can follow the steps in [minimizing downtime](/documentation/custom-domains#minimizing-downtime). +6. Federalist Support will reach out once the custom domain has been provisioned and your site is live!! Note, current limitations require a rebuild of your site once it is provisioned, so there may be a slight delay between then the custom domain resolves to your site and when css, images, and other assets are linked properly. This is triggered automatically, but if you have concerns, you can follow the steps in [minimizing downtime](../custom-domains#minimizing-downtime). 7. An additional live site scan of your custom domain will be run by GSA IT just to verify the final configuration, then the Federalist ISSO will share the Site Review document for your product owner to sign. @@ -50,6 +50,6 @@ We've worked to make publishing a government site on Federalist as simple as pos 1. Notify Federalist support that you are ready to launch your site 2. Complete the site questionnaire provided to you by Federalist support 3. Resolve any findings identified by vulnerability scans -4. [Configure your DNS](/documentation/custom-domains#configure-your-dns) +4. [Configure your DNS](../custom-domains#configure-your-dns) 5. Notify Federalist support 6. Sign and return the Site Review document to the Federalist ISSO \ No newline at end of file