Skip to content

Commit

Permalink
adding intial site contents
Browse files Browse the repository at this point in the history
  • Loading branch information
david-waltermire committed May 7, 2024
1 parent e1930a4 commit 54de2d7
Show file tree
Hide file tree
Showing 168 changed files with 11,256 additions and 3 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,2 @@
/public
/.hugo_build.lock
1 change: 1 addition & 0 deletions .hugo-version
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
0.123.3
6 changes: 3 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
# Welcome!

We are glad you’re thinking about contributing to the FedRAMP Automation Project!
We are glad you’re thinking about contributing to the FedRAMP Automation Website project!

We’re an open source project that accepts contributions from our community members. FedRAMP Automation Project is the result of community contributions, large and small. Your contribution helps to make FedRAMP processes more automated.
We’re an open source project that accepts contributions from our community members. The FedRAMP Automation Website project is the result of community contributions, large and small. Your contribution helps to make FedRAMP processes more automated.

## Code of Conduct

GSA is committed to building a safe, welcoming, harassment-free culture for everyone. The FedRAMP Automation Project is a part of the Technology Transformation Services (TTS) within the General Services Administration (GSA) and we expect everyone to follow the [GSA TTS Code of Conduct](https://handbook.tts.gsa.gov/about-us/code-of-conduct/).

We encourage you to read this project’s Contribution Guide (you are here), its [LICENSE](https://github.com/GSA/automate.fedramp.gov/blob/main/LICENSE.md) and its [README](https://github.com/GSA/automate.fedramp.gov/blob/main/README.md). If you want to read more about our open source policy or have questions, check out the [GSA Open Source Policy GitHub repository](https://github.com/GSA/open-source-policy) or send us an [email](mailto:[email protected]).

## Licenses and attribution
## Licenses and Attribution

### This project is in the public domain

Expand Down
80 changes: 80 additions & 0 deletions README.md
100644 → 100755
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,86 @@

The website for the FedRAMP Automation Project is maintained here.

Below are instructions for building the site for local development if making any contributions to the documentation.

The website is built using the [Hugo](https://gohugo.io/) static site generator and the [United States Web Design System](https://designsystem.digital.gov/) (USWDS).

## Prerequisites

If using Docker:

- [Docker 23.0+](https://docs.docker.com/get-docker/)

If not using Docker:

- macOS, Linux or Windows Subsystem for Linux (WSL) (model doc build scripts don't support Windows natively at this time)
- [Hugo](https://gohugo.io/)

## Using Hugo

[Hugo](https://gohugo.io/) is a popular open source static site generator. It is a general-purpose framework that builds pages when the content is created or updated.

Instructions for installing the Hugo CLI on your OS can be found [here](https://gohugo.io/getting-started/installing).

The website's visual styling is also backed by the U.S. Web Design System (USWDS) via an open source Hugo theme at https://github.com/usnistgov/hugo-uswds.

The USWDS framework is documented here: https://designsystem.digital.gov/.

### Building the site with LiveReload

Hugo provides built-in LiveReload which watches for any changes to the source content and automatically reloads the site when changes are detected.

1. Pull the currently used USWDS Hugo theme revision to your locally cloned copy of the OSCAL repo by executing the following command from within the folder of the git repo

```
git submodule update --init
```

2. Verify that Hugo is installed

```
hugo version
```
NOTE: The extended version of Hugo is required. The reported version should include the word "extended".

3. Navigate into the `docs/` directory

```
cd docs
```

4. Start the Hugo server

```
hugo server -v --debug --minify
```

alternatively, you may bind Hugo to a network adapter on your workstation using its assigned IP address

```
hugo server -v --debug --minify --bind [ipv4-address] -b http://[ipv4-address]:1313/fedramp-automation
```

5. Open your browser and navigate to `http://localhost:1313/fedramp-automation` to view the locally built site.

If you bound Hugo to an IP address, navigate to `http://[ipv4-address]:1313/fedramp-automation` either locally or with another device on the network.

Whenever you make any changes to the content with the Hugo server running, you'll notice that the site automatically updates itself to reflect those changes.


## Developing with Docker

The website can also be developed and built using the included Docker resources.

Assuming you've [installed Docker](https://docs.docker.com/get-docker/) and [Docker Compose](https://docs.docker.com/compose/install/) for your system, you can build and serve the site using Docker Compose as follows:

```
docker-compose build
docker-compose up
```

Once the site is running, it can be accessed at [http://localhost:1313/](http://localhost:1313/).

## Need installation help?

Do you have questions or need help with setup? Did you run into any weird errors while following these instructions? Feel free to open an issue here:
Expand Down
6 changes: 6 additions & 0 deletions archetypes/default.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
---
title: "{{ replace .Name "-" " " | title }}"
date: {{ .Date }}
draft: true
---

48 changes: 48 additions & 0 deletions config/_default/hugo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
title: "FedRAMP Automation"
baseURL: https://automate.fedramp.gov/
defaultContentLanguage: en
languageCode: "en-us"
MetaDataFormat: "yaml"
#googleAnalytics: UA-
enableGitInfo: true
enableRobotsTXT: true
menu:
secondary:
- name: FedRAMP
url: https://fedramp.gov/
weight: 10
- name: Marketplace
url: https://marketplace.fedramp.gov/
weight: 10
- name: Github
url: https://github.com/GSA/fedramp-automation
weight: 90
# Configuration for hugo-uswds
#
module:
mounts:
- source: static
target: static
- source: static/img
target: assets/img
- source: ../examples
target: static/examples
imports:
- path: github.com/GSA/uswds-hugo
params:
header:
project_shortname: "FedRAMP Automation"
project_name: "FedRAMP Automation"
page_repo_path: https://github.com/GSA/fedramp-automation/tree/feature-guides-updates/docs
contentRepoPath: https://github.com/GSA/automate.fedramp.gov/tree/develop
# searchAffiliate: fedramp
usabanner: true
sidenav:
# debug: true
markup:
goldmark: # Markdown Rendering
renderer:
unsafe: true # required for the Hugo USWDS theme
highlight: # Code Highlighting
guessSyntax: true
noClasses: false # enables USWDS styled syntax highlighting
3 changes: 3 additions & 0 deletions config/production/hugo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
build:
buildStats:
enable: true
1 change: 1 addition & 0 deletions config/staging/hugo.yaml
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
disableAliases: true
27 changes: 27 additions & 0 deletions content/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
---
title: "FedRAMP Automation"
toc:
display: false
cascade:
suppresstopiclist: true
toc:
display: true
sidenav:
collapsedepth: 4
---
{{% usa-hero image="img/homepage-banner-desktop.jpg" calloutText="Control-Based Assessments" calloutAltText="Automating" buttonURL="/about/" buttonText="Learn More" %}}
Using OSCAL to streamline and<br>
automate risk management processes
{{% /usa-hero %}}

{{% usa-tagline caption="Modernizing Security Assessments, System Authorizations, and Continuous Monitoring" %}}
OSCAL offers a number of benefits to streamlining and automating components of the authorization process. Below are just a few examples:

- **Cloud Service Providers (CSPs)** are able to create their FedRAMP authorization packages more rapidly and accurately, validating much of their content before submission to the government for review.
- **Third Party Assessment Organizations (3PAOs)** are able to use OSCAL-based authorization package artifacts to automate the planning, execution, and reporting of cloud assessment activities.
- **Agencies** are able to expedite their reviews of the FedRAMP authorization packages.

The FedRAMP Program Management Office (PMO) expects to be able to build tooling to further reduce the cost and improve the quality of package reviews.

[Get started](/start) with FedRAMP OSCAL-based authorization packages today.
{{% /usa-tagline %}}
17 changes: 17 additions & 0 deletions content/about/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
---
title: More about FedRAMP OSCAL
menu:
primary:
name: About
weight: 1
toc:
enabled: true
---

# Learn more about FedRAMP OSCAL

Coming Soon: Overview of FedRAMP OSCAL...

## Why OSCAL at FedRAMP?

Coming Soon: Description of FedRAMP's OSCAL adoption program
14 changes: 14 additions & 0 deletions content/about/faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: FAQs
menu:
primary:
name: FAQs
parent: About
weight: 9
toc:
enabled: true
---

# Frequently Asked Questions

Coming Soon: List of FAQs and answers
14 changes: 14 additions & 0 deletions content/about/release.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
---
title: Release Strategy
menu:
primary:
name: Release Strategy
parent: About
weight: 2
toc:
enabled: true
---

# Release Strategy

Coming Soon: Description of FedRAMP's OSCAL release strategy
16 changes: 16 additions & 0 deletions content/contact/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Contact Us
description: Contact Us
menu:
primary:
name: Contact Us
weight: 500
toc:
enabled: true
---

# Contact Us

We want to hear from you. All development efforts have been performed openly and we are seeking your feedback on our progress to date. Will these machine-readable formats and guidance aid your organization in going through the authorization process efficiently? Do you have any further ideas to enhance the work? Let us know!

If you have questions or feedback, please provide comments either via email to [[email protected]](mailto:[email protected]) or as a comment to an existing issue within the [FedRAMP Automation repository](https://github.com/GSA/fedramp-automation/issues).
Loading

0 comments on commit 54de2d7

Please sign in to comment.