Skip to content

Commit

Permalink
First pass at removing references to Federalist
Browse files Browse the repository at this point in the history
  • Loading branch information
hursey013 committed Nov 8, 2022
1 parent fec1326 commit 3a02111
Show file tree
Hide file tree
Showing 14 changed files with 31 additions and 31 deletions.
12 changes: 6 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@

# cloud.gov

This site uses the [Federalist USWDS Jekyll template](https://github.com/18F/federalist-uswds-jekyll). [Federalist](https://federalist.18f.gov/) runs on cloud.gov and supports the development of this template. By leveraging this template cloud.gov get the benefits of a maintained template as well as a way to test out new functionality in the template.
This site uses the [cloud.gov Pages USWDS Jekyll template](https://github.com/cloud-gov/pages-uswds-jekyll). [cloud.gov Pages](https://cloud.gov/pages/) runs on cloud.gov and supports the development of this template. By leveraging this template cloud.gov get the benefits of a maintained template as well as a way to test out new functionality in the template.

This [Jekyll theme](https://jekyllrb.com/docs/themes/) uses the [U.S. Web Design System v 2.0](https://v2.designsystem.digital.gov) and provides developers a starter kit and reference implementation for Federalist websites.
This [Jekyll theme](https://jekyllrb.com/docs/themes/) uses the [U.S. Web Design System v 2.0](https://v2.designsystem.digital.gov) and provides developers a starter kit and reference implementation for cloud.gov Pages websites.

This code uses the [Jekyll](https://jekyllrb.com) site engine and built with Ruby. If you prefer to use Javascript, check out [federalist-uswds-gatsby](https://github.com/18F/federalist-uswds-gatsby), which uses [Gatsby](https://gatsbyjs.org) site engine.
This code uses the [Jekyll](https://jekyllrb.com) site engine and built with Ruby. If you prefer to use Javascript, check out [pages-uswds-gatsby](https://github.com/18F/pages-uswds-gatsby), which uses [Gatsby](https://gatsbyjs.org) site engine.

This site uses a customized [U.S. Web Design System](https://v2.designsystem.digital.gov) theme and strives to be compliant with requirements set by [21st Century IDEA Act](https://designsystem.digital.gov/website-standards/). The standards require that a website or digital service:

Expand Down Expand Up @@ -55,7 +55,7 @@ permalink: /document-with-sidenav
---
searchgov:
endpoint: https://search.gov # You should not change this.
affiliate: federalist-uswds-example # replace this with your search.gov account
affiliate: pages-uswds-example # replace this with your search.gov account
access_key: your-access-key # This is placeholder. Not private.
inline: true #this renders the results on the same domain. Otherwise, it will render the results in the search.gov domain
---
Expand All @@ -70,7 +70,7 @@ searchgov:

- The contents inside `_assets/` folder store your Javascript, SCSS/CSS, images, and other media assets are managed by [jekyll-assets](https://github.com/envygeeks/jekyll-assets). Assets are combined, compressed, and automatically available in your theme

- If you look at `package.json` you will see that the `npm run federalist` command that will run when running on the Federalist platform.
- If you look at `package.json` you will see that the `npm run federalist` command that will run when running on the cloud.gov Pages platform.

- Do not edit files in the `_site/` folder. These files are auto-generated, and any change you make in the folder will be overwritten.

Expand All @@ -92,7 +92,7 @@ searchgov:
$ git clone https://github.com/cloud-gov/cg-site
$ cd cg-site

Note that when built by Federalist, `npm run federalist` is used instead of the
Note that when built by cloud.gov Pages, `npm run federalist` is used instead of the
`build` script.

### Install dependencies and run app
Expand Down
2 changes: 1 addition & 1 deletion _assets/js/app.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
//= require js/uswds.min.js

// Add your custom javascript here
console.log("Hi from Federalist");
console.log("Hi from cloud.gov Pages");

mermaid.initialize({startOnLoad:true, theme: null}, ".someOtherClass");

Expand Down
4 changes: 2 additions & 2 deletions _data/pages/templates.yml
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@

items:
- title: Jekyll - U.S. Web Design System v2.0
docs_url: https://github.com/18F/federalist-uswds-jekyll
docs_url: https://github.com/cloud-gov/pages-uswds-jekyll
preview_url: https://federalist-71976045-72b8-456f-838d-26eeb0c707a3.app.cloud.gov/site/18f/federalist-uswds-jekyll/
img: /assets/pages/images/templates/federalist-jekyll-uswds-template.png
order: 2
summary: ""
- title: Gatsby - U.S. Web Design System v2.0
docs_url: https://github.com/18F/federalist-uswds-gatsby
docs_url: https://github.com/cloud-gov/pages-uswds-gatsby
preview_url: https://federalist-b146cf1e-c756-4b1f-bb83-c516cac94fbb.app.cloud.gov/site/18f/federalist-uswds-gatsby/
img: /assets/pages/images/templates/federalist-gatsby-uswds-template.png
order: 3
Expand Down
2 changes: 1 addition & 1 deletion _docs/deployment/frameworks.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,5 +48,5 @@ Several cloud.gov customers have their code available as open source for review
* [ATF eRegulations](https://github.com/18F/atf-eregs): Python Django application that uses PostgreSQL.
* [College Scorecard API](https://github.com/RTICWDT/open-data-maker/): Ruby application with an Elasticsearch backend.
* [Federal Election Commission API](https://github.com/fecgov/openFEC): Python application with PostgreSQL and Elasticsearch backends.
* [Federalist](https://github.com/18F/federalist): NodeJS and Docker workers in cloud.gov with S3 and RDS backends.
* [cloud.gov Pages](https://github.com/cloud-gov/pages-core): NodeJS and Docker workers in cloud.gov with S3 and RDS backends.
* [NSF Beta Drupal](https://github.com/18F/nsf): Drupal 8 with setup for Docker local development, and cloud.gov staging/live environments.
2 changes: 1 addition & 1 deletion _docs/ops/contingency-plan.md
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ This plan is most effective if all core cloud.gov team members know about it, re
* How we protect this plan from unauthorized modification:
* This plan is stored in a public GitHub repository ([https://github.com/18F/cg-site](https://github.com/18F/cg-site)) with authorization to modify it limited to 18F staff by GitHub access controls. cloud.gov team policy is that 18F staff may not directly make changes to this document; they must propose a change by making a pull request and ask another team member to review and merge the pull request.

## Federalist
## cloud.gov Pages

[This Contingency Plan doc](https://docs.google.com/document/d/1YG6oucagNO_ZmmlsLPdQeFABCiVcY1BYuhDEEvDwe4Q/edit?usp=sharing) provides guidance for our team in the case of trouble delivering our essential mission and business functions due to disruption, compromise, or failure of any system components or services.

Expand Down
4 changes: 2 additions & 2 deletions _pages/pages/documentation/before-you-launch.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,8 @@ We've worked to make publishing a government site on Pages as simple as possible

## Launch Process
1. Notify Pages support of your intent to launch along with your repository name/url and production-ready git branch via:
- email: `federalist-support@gsa.gov`
- Slack: `#federalist-support`
- email: `pages-support@cloud.gov`
- Slack: `#cg-pages`

2. Pages support will:
- initiate GSA IT-provided scans of the preview build and source code of your site to identify any vulnerabilites
Expand Down
2 changes: 1 addition & 1 deletion _pages/pages/documentation/customization.md
Original file line number Diff line number Diff line change
Expand Up @@ -99,7 +99,7 @@ If a user navigates to a page on your site that does not exist, they will see a
## Pages default 404 page
![Default 404 Page]({{site.baseurl}}/assets/pages/images/default-404.png)

In order to use a custom 404 Page, name your 404 Page "404.html" and make sure it is at the root of and included in the resources that are deployed. Jekyll sites should also have the file in the root of the project with the front matter data value set to `permalink: /404.html`, see [the docs for reference](https://jekyllrb.com/tutorials/custom-404-page/). If you need to direct 404 errors to a file not named "404.html" to support single page applications (SPA), let #federalist-support or [email protected] know that you would like to use a custom 404 page for a SPA and we will handle the rest.
In order to use a custom 404 Page, name your 404 Page "404.html" and make sure it is at the root of and included in the resources that are deployed. Jekyll sites should also have the file in the root of the project with the front matter data value set to `permalink: /404.html`, see [the docs for reference](https://jekyllrb.com/tutorials/custom-404-page/). If you need to direct 404 errors to a file not named "404.html" to support single page applications (SPA), let #cg-pages or [email protected] know that you would like to use a custom 404 page for a SPA and we will handle the rest.

> If you have a custom domain and, while trying to set up your custom 404 page using a development branch, you are able to see it when running locally, but not live on the branch site, try pushing it to your custom domain.
Expand Down
8 changes: 4 additions & 4 deletions _pages/pages/documentation/getting-started-with-jekyll.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ hesitate to [reach out](mailto:{{ site.support_email }})._

Pages monitors your site’s GitHub repository (or repo) for changes you
make. It will automatically build a new version of your site in a few minutes.
You can view the live site [from Pages](https://federalistapp.18f.gov/sites) and clicking
You can view the live site [from Pages](https://pages.cloud.gov/sites) and clicking
"View site".

{% capture content %}
Expand Down Expand Up @@ -53,8 +53,8 @@ site_width: wide
# This is used for adding an edit this page link
# to the footer
github:
organization: 18F
repository: federalist-uswds-template
organization: cloud-gov
repository: pages-jekyll-uswds-template
default_branch: report-config
# Notice how two space characters are used to
# indent the properties. This means they are
Expand Down Expand Up @@ -102,7 +102,7 @@ the changes you’ve made when looking back on the repo’s history.
{% include pages/components/alert--best-practice.html content=content %}

Once your change is committed, Pages will start rebuilding your site. You
can see the build progress on the [build history page](https://federalistapp.18f.gov/sites).<!--
can see the build progress on the [build history page](https://pages.cloud.gov/sites).<!--
TODO link to this site’s build history page. -->


Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,8 +33,8 @@ If your site is already up and running, please follow the instructions on [Netli
- Gatsby or Hugo: `/static/admin/config.yml`

For examples of existing configurations, see the Pages starter:
- [Pages USWDS Jekyll](https://github.com/18F/federalist-uswds-jekyll/blob/main/admin/config.yml)
- [Pages USWDS Gatsby](https://github.com/18F/federalist-uswds-gatsby/blob/main/static/admin/config.yml)
- [Pages USWDS Jekyll](https://github.com/cloud-gov/pages-uswds-jekyll/blob/main/admin/config.yml)
- [Pages USWDS Gatsby](https://github.com/cloud-gov/pages-uswds-gatsby/blob/main/static/admin/config.yml)

### Configuration Requirements
To use Netlify CMS, you must authenticate with Github, and in order for Pages to facilitate this, your Netlify CMS configuration should include the following:
Expand All @@ -44,9 +44,9 @@ To use Netlify CMS, you must authenticate with Github, and in order for Pages to
backend:
name: github
repo: <your org>/<your repo>
base_url: https://federalistapp.18f.gov
base_url: https://pages.cloud.gov
auth_endpoint: external/auth/github
preview_context: federalist/build
preview_context: pages/build
branch: main
Expand Down
2 changes: 1 addition & 1 deletion _pages/pages/documentation/how-pages-works.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ permalink: /pages/documentation/how-pages-works/
layout: docs
navigation: pages
sidenav: pages-documentation

published: false
---

Pages is a hosted service run by [cloud.gov](https://cloud.gov/) for use by US federal government agencies. The software behind this service is open source and released to the public domain for anyone to use. We also welcome your contributions and ideas.
Expand Down
4 changes: 2 additions & 2 deletions _pages/pages/documentation/node-on-pages.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ After adding that, jekyll will ignore the `node_modules` directory when building

```json
{
"name": "federalist-gatsby-uswds-template",
"name": "pages-gatsby-uswds-template",
"description": "Description A template for Pages that uses Gatsby and USWDS 2.0",
"license": "CC0-1.0",
"version": "0.1.0",
Expand All @@ -106,7 +106,7 @@ After adding that, jekyll will ignore the `node_modules` directory when building
### Use Node to build an Eleventy site
```
{
"name": "federalist-eleventy-template",
"name": "pages-eleventy-template",
"version": "1.0.0",
"description": "An example Pages site using eleventy",
"scripts": {
Expand Down
4 changes: 2 additions & 2 deletions _pages/pages/documentation/supported-site-engines.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ For all engines **except Static** Pages will serve whatever is in the `_site` fo
### Node
A Node script can be run to generate a site OR as a preliminary step to generating one with Jekyll or Hugo. To use a Node script as the generator, choose **Node.js** as the **Site Engine** in the Advanced Settings configuration for your site.

For more details on using Node see [node on federalist]({{site.baseurl}}/pages/documentation/node-on-pages).
For more details on using Node see [node on cloud.gov Pages]({{site.baseurl}}/pages/documentation/node-on-pages).

## Jekyll Resources
Pages can generate any Jekyll website, which lets you build custom websites hosted on Pages. For documentation on getting started with Jekyll, see [jekyllrb.com](http://jekyllrb.com/).
Expand Down Expand Up @@ -71,7 +71,7 @@ Pages supports Jekyll plugins, enabling any plugins in a site's `_plugins` direc

Several dependencies are already available for use in the building environment. These include `ruby`, `python`, and `node.js`. You can write plugins that take advantage of these without needing a `Gemfile`.

To see the exact configuration of the build environment, see the [build environment `Dockerfile`](https://github.com/18F/federalist-garden-build/blob/main/Dockerfile).
To see the exact configuration of the build environment, see the [build environment `Dockerfile`](https://github.com/cloud-gov/pages-garden-build/blob/main/Dockerfile).

**Note:** using `Gemfile` may considerably slow down the generation of your website, depending on how long the `bundle install` step takes to complete.

Expand Down
2 changes: 1 addition & 1 deletion _plugins/paginate-patch.rb
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ module Jekyll
module PaginateV2::Generator

#
# https://github.com/18F/federalist-uswds-jekyll/pull/260 introduced a
# https://github.com/cloud-gov/pages-uswds-jekyll/pull/260 introduced a
# patch that resolved an issue where paginated pages were using a single
# cached layout file, causing the wrong content to be displayed.
#
Expand Down
6 changes: 3 additions & 3 deletions admin/config.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,10 +2,10 @@
backend:
name: github
repo: cloud-gov/cg-site
base_url: https://federalistapp.18f.gov
base_url: https://pages.cloud.gov
auth_endpoint: external/auth/github
preview_context: federalist/build
branch: master
preview_context: pages/build
branch: main
use_graphql: true

##
Expand Down

0 comments on commit 3a02111

Please sign in to comment.