5 | Want to talk about what Federalist can do for your agency? Questions about compliance? Want to try it out for yourself? 6 |
7 | Get in touch 8 |Federalist is a product of the General Services Administration.
21 | edit_page: 22 | text: Edit this page 23 | -------------------------------------------------------------------------------- /pages/documentation/rvm-on-federalist.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: RVM on Federalist 3 | permalink: /documentation/rvm-on-federalist/ 4 | layout: page 5 | sidenav: documentation 6 | redirect_from: 7 | - /pages/how-federalist-works/rvm-on-federalist/ 8 | --- 9 | 10 | Federalist uses [RVM](https://rvm.io/) to select which ruby version to use to build a Federalist site. 11 | 12 | ## Default Ruby version 13 | By default, the build will use Ruby version 2.6.3. 14 | 15 | ## Specifying a Ruby version 16 | 17 | Prior to building a site, the build will check for a file named `.ruby-version`. If one is found, it will use RVM to install and use the version specified there. 18 | 19 | For example, if you wish to use Ruby version 2.4.0 to build a site, add a new file named `.ruby-version` to your repository. The `.ruby-version` file should be at the top-level directory. The contents of that file should be "`2.4.0`". 20 | -------------------------------------------------------------------------------- /pages/documentation/bundler-on-federalist.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Bundler on Federalist 3 | layout: page 4 | sidenav: documentation 5 | permalink: /documentation/bundler-on-federalist/ 6 | redirect_from: 7 | - /pages/how-federalist-works/bundler-on-federalist/ 8 | 9 | --- 10 | 11 | 12 | Federalist uses [Bundler](https://bundler.io/) to manage your Federalist site's dependencies. By default, Federalist runs Bundler version 1. 13 | 14 | ## Specifying a Bundler version 15 | 16 | Prior to building a site, the build will check for a file named `.bundler-version`. If one is found, it will use the Bundler version specified to install the gems and versions declared for you site. 17 | 18 | For example, if you wish to use Bundler version 2.0.1 to build a site, add a new file named `.bundler-version` to your repository. The `.bundler-version` file should be at the top-level directory. The contents of that file should be "`2.0.1`". 19 | -------------------------------------------------------------------------------- /pages/documentation/build-errors.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Build Errors 3 | permalink: /documentation/build-errors/ 4 | layout: page 5 | sidenav: documentation 6 | --- 7 | 8 | 9 | The following is a non-exhausitve list of commmon issues we see partners run into: 10 | 11 | - Trying to deploy code that uses the `github-pages` gem interferes with the Federalist build process to specific URLs. Users should always remove that gem from their repos. 12 | - Errors like "Federalist can't confirm org permissions for 'your-org'." Either `your-org` hasn't approved access for Federalist or you aren't an org member. Ensure you are an org member and ask an org owner to authorize Federalist for the organization can be resolved by visiting [this link](https://github.com/settings/connections/applications/94d4097d74049df1039b) and requesting org access as needed. This happens because Federalist can't tap a repo without org approval. Typically these permissions are granted when initially granting access to Federalist. -------------------------------------------------------------------------------- /pages/documentation/search.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Search on Federalist Sites 3 | permalink: /documentation/search/ 4 | layout: page 5 | sidenav: documentation 6 | redirect_from: 7 | - /pages/using-federalist/search/ 8 | --- 9 | 10 | It's easy to add search functionality to a site. 11 | 12 | We recommend using [Search.gov][], a free site search and search analytics service for federal web sites. You will need to [register](https://search.usa.gov/signup) for Search.gov and follow their [instructions](https://search.gov/blog/go-live.html) to integrate this service with your Federalist site. For full details, visit [Search.gov][]. 13 | 14 | If you'd prefer another solution, you can configure a tool like [lunrjs](https://lunrjs.com/) that creates a search function run using the client browser. An example of this is at the [18F blog](https://18f.gsa.gov/blog/). This avoids any dependency on another service, but the search results are not as robust. 15 | 16 | [Search.gov]: https://search.gov/ 17 | -------------------------------------------------------------------------------- /_sass/fonts.scss: -------------------------------------------------------------------------------- 1 | /*! Generated by Font Squirrel (https://www.fontsquirrel.com) on August 2, 2019 */ 2 | 3 | 4 | 5 | @font-face { 6 | font-family: 'source_sans_proregular'; 7 | src: url('../fonts/sourcesanspro-regular-webfont.woff2') format('woff2'), 8 | url('../fonts/sourcesanspro-regular-webfont.woff') format('woff'); 9 | font-weight: normal; 10 | font-style: normal; 11 | 12 | } 13 | 14 | 15 | 16 | 17 | @font-face { 18 | font-family: 'source_sans_probold'; 19 | src: url('../fonts/sourcesanspro-bold-webfont.woff2') format('woff2'), 20 | url('../fonts/sourcesanspro-bold-webfont.woff') format('woff'); 21 | font-weight: normal; 22 | font-style: normal; 23 | 24 | } 25 | 26 | 27 | 28 | 29 | @font-face { 30 | font-family: 'merriweatherblack'; 31 | src: url('../fonts/merriweather-black-webfont.woff2') format('woff2'), 32 | url('../fonts/merriweather-black-webfont.woff') format('woff'); 33 | font-weight: normal; 34 | font-style: normal; 35 | 36 | } -------------------------------------------------------------------------------- /_data/screenshots.yml: -------------------------------------------------------------------------------- 1 | title: See more sites powered by Federalist. 2 | summary: >- 3 | Nine agencies use Federalist to host over 100 sites with over 140,000 page views per day. This page shows a sample of our partners. 4 | items: 5 | - title: Performance.gov 6 | url: https://www.performance.gov 7 | thumbnail: /assets/images/partner-sites/performance.gov.png 8 | 9 | - title: 18F 10 | url: https://18f.gsa.gov 11 | thumbnail: /assets/images/partner-sites/18f.gsa.gov.png 12 | 13 | - title: CIO.gov 14 | url: https://cio.gov 15 | thumbnail: /assets/images/partner-sites/cio.gov.png 16 | 17 | - title: U.S. Web Design System 18 | url: https://designsystem.digital.gov 19 | thumbnail: /assets/images/partner-sites/uswds.png 20 | 21 | - title: Office of Evaluation Sciences 22 | url: https://oes.gsa.gov 23 | thumbnail: /assets/images/partner-sites/oes.gsa.gov.png 24 | 25 | - title: PCLOB 26 | url: https://pclob.gov 27 | thumbnail: /assets/images/partner-sites/pclob.gov.png 28 | -------------------------------------------------------------------------------- /_includes/sidenav.html: -------------------------------------------------------------------------------- 1 |
18 |
19 |
20 |
21 |
23 | {% assign default_docs_url = template.url | prepend: site.baseurl %} 24 | Read the template documentation. 25 |
26 | {% endfor %} 27 | 28 | 29 | Federalist will build any Jekyll, Gatsby or Hugo website, supporting [custom website templates]({{site.baseurl}}/documentation/how-builds-work). 30 | Update 31 | -------------------------------------------------------------------------------- /_data/pricing.yml: -------------------------------------------------------------------------------- 1 | plans: 2 | - title: "Basic plan: Access to Federalist $24,949/year" 3 | summary: >- 4 | Basic training via video conference for Federalist and GitHub. This subscription is ideal if 1) you are focused on publishing content and do not need heavy customization of templates, or 2) you have a team capable of managing our easy-to-use templates on GitHub. 5 | features: 6 | - { text: GSA-maintained GSA Authority to Operate (ATO) for all your sites. } 7 | - { text: Automated tests and previews before going live. } 8 | - { text: Web-based configuration page for managing individual sites. } 9 | - { text: Highly scalable content delivery network (CDN) to ensure uptime. } 10 | - { text: Automatic HTTPS certificates and renewals for all your websites. } 11 | - { text: Unlimited sites for your office. } 12 | - { text: No charges for storage or bandwidth. } 13 | 14 | - title: "Basic plan + Additional support $82,699/year" 15 | summary: >- 16 | This subscription is ideal if you want your team to have hands-on support from Federalist staff. Our goal is to transfer knowledge to your team and does not include ad-hoc consulting services. 17 | features: 18 | - { text: Design feedback and technical implementation recommendations. } 19 | - { text: Technical assistance implementing a U.S Web Design System template. } 20 | - { text: Monthly conference call to discuss design or technical questions. } 21 | - { text: Two one-hour video conference sessions on GitHub, Markdown, Jekyll and Federalist. } -------------------------------------------------------------------------------- /pages/documentation/site-wide-alert.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Site Wide Alert 3 | permalink: /documentation/site-wide-alert/ 4 | layout: page 5 | sidenav: documentation 6 | redirect_from: 7 | - /pages/for-federalist-developers/site-wide-alert/ 8 | --- 9 | 10 | Members of the Federalist dev team can update Federalist to display a banner explaining any maintenance, bugs, or degradation that users should be aware of. This is done by setting values in a user provided service. 11 | 12 | ## Setting A Site Wide Alert 13 | 14 | To set a site wide alert, target the Federalist production space and run the following on the command line: 15 | 16 | ```shell 17 | cf uups federalist-site-wide-error -p '{ 18 | "HEADING": "There is an error", 19 | "BODY": "We are working on it" 20 | }' 21 | ``` 22 | 23 | Once the user provided service is updated, the app will need to be restaged. Restaging the app will result in downtime, so it is recommended that instead a zero-downtime-deploy is run. The easiest way to do this is by re-building the master branch in CI. 24 | 25 | Also, note the the `BODY` parameter in the user provided service may contain HTML tags to allow for the inclusion of links, bulleted lists, etc. 26 | 27 | ## Removing A Site Wide Alert 28 | 29 | To remove a site wide alert, first update the user provided service to contain no header or body: 30 | 31 | ```shell 32 | cf uups federalist-site-wide-error -p '{ 33 | "HEADING": "", 34 | "BODY": "" 35 | }' 36 | ``` 37 | 38 | After updating the user provided service, restage or rebuild the application as described in the instructions for setting a site wide alert above. 39 | -------------------------------------------------------------------------------- /pages/documentation/env-vars-federalist.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Build environment variables 3 | permalink: /documentation/env-vars-on-federalist-builds/ 4 | layout: page 5 | sidenav: documentation 6 | redirect_from: 7 | - /pages/how-federalist-works/env-vars-on-federalist-builds/ 8 | --- 9 | 10 | At the time your site is built with either Jekyll or Hugo, a number of special environment variables are exposed. You can access these environment variables with your build engine to customize your build (for instance, to add some special text to your site to show which branch has been built). 11 | 12 | See the [federalist-garden-build README](https://github.com/18f/federalist-garden-build#variables-exposed-during-builds) for further information on the environment variables that your site build can access. 13 | 14 | ## Default environment variables available when your site builds 15 | 16 | When Federalist builds your site it makes available the following environment variables: 17 | 18 | Name|Description 19 | ---|--- 20 | BRANCH|Github branch being built 21 | OWNER|Owner of Github repository 22 | REPOSITORY|Github repository 23 | SITE_PREFIX|Path of s3 bucket in which your site will be deployed 24 | BASEURL|Path for deployed site 25 | 26 | ## Adding custom environment variables available when your site builds 27 | 28 | Additional environment variables can be added to your live and demo site builds by: 29 | 1. Visit your site's Site Settings -> Advanced Settings 30 | 2. In the Site/Demo Configuration textarea enter your environment variables as yaml formatted text (Note: nested data is supported) 31 | 3. Click "Save advanced settings" 32 | -------------------------------------------------------------------------------- /pages/documentation/previews.md: -------------------------------------------------------------------------------- 1 | --- 2 | title: Builds and Previews 3 | permalink: /documentation/previews/ 4 | layout: page 5 | sidenav: documentation 6 | redirect_from: 7 | - /pages/using-federalist/previews/ 8 | 9 | --- 10 | 11 | ## Site previews 12 | 13 | _Every_ branch in a Federalist-enabled GitHub repo is built by Federalist with 14 | a site preview. 15 | 16 | Site preview links will auto-generate within pull requests. To see them, scroll to 17 | the bottom of your pull request and click "show all checks", then click on 18 | "details" to the right of the Federalist check. The site preview is only 19 | available after a build reports completion, usually within a few minutes. 20 | 21 |  22 | 23 | You can also find links to site previews in the "GitHub Branches" page after 24 | logging into Federalist. 25 | 26 | {% capture content %} 27 | For security reasons, site previews are unavailable with pull requests from 28 | forked repositories. 29 | {% endcapture %} 30 | {% include components/alert--note.html content=content %} 31 | 32 | There can be two "special" branches, which are specified in the web UI's Basic 33 | Settings page as the Live Site Branch and/or the Demo Site Branch. Those 34 | branches can be built with custom domains (that's really the only way they're 35 | special). 36 | 37 | Here's how the URLs work: 38 | - for the Live site: Live Site Domain, if set, OR `https://{{ site.data.case_studies.summary }}
16 |{{item.summary}}
25 |{{ site.data.screenshots.summary }}
41 |{{item.title}}
49 | 50 |6 | Our accessible, customizable templates let you spend more time on your content. 7 |
8 | 9 |
16 | 
26 | 
36 | 
46 | 
16 | Read me if you’re looking for:
Challenges with government compliance, and cultural challenges switching to Cloud solutions
29 | Read me if you’re looking for:
Enhanced functionality, hands-on support, and modern design
42 | Read me if you’re looking for:
How Federalist adds value to my work as a content strategist
If you’re interested in using Federalist at your agency, email the Federalist team at 10 | federalist-inquiries@gsa.gov with your name, agency or office, and information about the website you want to build or migrate. We’ll schedule a call to answer your questions and help you get started. You can also sign up using this Google form if your agency can access Google forms.
11 |If you’re in need of assistance, please submit a support ticket to 13 | federalist-support@gsa.gov with a link to your Federalist website, a link to the code repository for your site, and a description of your problem. If applicable, please also include any build logs that show 14 | the issue. Please do not include passwords or any sensitive information in your support ticket.
15 |The Federalist team provides support during business hours for U.S. East and West Coast time zones. While we're unable to guarantee support outside of these hours, we’re always monitoring for issues that might affect uptime as we host many sites using Federalist.
16 |Federalist is hosted on cloud.gov. cloud.gov is constantly monitored and set up for low or zero-downtime deployments, and should be continuously operating. 17 | Check cloud.gov's current status and history of uptime.
18 |We welcome vulnerability reports 20 | according to our vulnerability disclosure policy. We accept and discuss vulnerability reports on HackerOne, via email at tts-vulnerability-reports@gsa.gov, or through this reporting form. Please review our vulnerability disclosure policy before reporting a vulnerability. 21 |
22 |7 | Need more details about Federalist? Need help convincing your executive team? The Federalist team has developed these resources to help. See more on the Federalist support site. 8 |
9 |
15 | A two-page overview about Federalist for stakeholder briefings.
19 | Download PDF 20 |
28 |
29 | An outline of how all of Federalist’s parts work together.
33 | Download PDF 34 |
41 | Details about Federalist’s compliance and Authority to Operate.
45 | Download PDF 46 |6 | Federalist uses a public code hosting service to load and store code for your site. If your code is already on GitHub, Federalist can securely deploy a website from your repository in minutes. 7 |
8 |
14 | 
20 | 
26 | 
32 | 
40 | 
46 | 
52 | 
58 |
13 |
14 | Federalist is a publishing platform for
modern 21st Century IDEA websites.
15 |
BUILD
47 |
48 | Use our templates or develop your own and publish your web page right away.
50 | See how the Centers of Excellence (CoEs) used Federalist to get new pages up quickly → 51 |LAUNCH
57 |
58 | You focus on the content, we'll worry about the security, compliance, and deployment.
60 | Learn how DoD leveraged the Federalist platform to build their own template designs → 61 |MANAGE
68 |
69 | Use our intuitive interface to control the process from start to finish.
71 | Learn how DOI used a Federalist template to host their data projects → 72 |