An open API service indexing awesome lists of open source software.

https://github.com/gsa/data-strategy

Federal data strategy website
https://github.com/gsa/data-strategy

Last synced: 6 months ago
JSON representation

Federal data strategy website

Awesome Lists containing this project

README

          

[![GitHub Actions](https://github.com/GSA/data-strategy/actions/workflows/build.yml/badge.svg)](https://github.com/GSA/data-strategy/actions/workflows/build.yml)
[![GitHub Actions](https://github.com/GSA/data-strategy/actions/workflows/qa.yml/badge.svg)](https://github.com/GSA/data-strategy/actions/workflows/qa.yml)

# data-strategy

Federal data strategy website

### Requirements

- [Ruby](https://www.ruby-lang.org/en/) = 3.1.4
- [Bundler](https://bundler.io/) > 2.0
- [Node](https://nodejs.org/en/download/) = 20

### Setup

After you've confirmed the above requirements, all lifecycle operations can be run with NPM scripts (ex. `npm run build`)

| NPM Command | Description |
| ----------- | ------------------------------- |
| build | Build the site |
| setup | Install ruby gems |
| start | Serve a local build |
| test | Check for broken internal links |
| qa | Check for broken external links |

## Contributing

See [CONTRIBUTING](CONTRIBUTING.md) for additional information.

This site is automatically published based on the branch.

| Branch | Environment | URL | Description |
| --------- | ----------- | --------------------------------------------------------------- | ------------------------------------------------------------------- |
| `develop` | staging | [strategy-staging.data.gov](https://strategy-staging.data.gov/) | Ad-hoc development and review of significant changes with partners. |
| `main` | production | [strategy.data.gov](https://strategy.data.gov/) | Production instance. |

Federalist automatically builds previews for all branches. Changes to `main` are
automatically published to [strategy.data.gov](https://strategy.data.gov/).
Feature branches should be branched from `main`.

`develop` is used ad-hoc in order to preview significant changes with partners
and is not part of the development workflow.

### Broken Links

We run a [weekly QA cron job](https://github.com/GSA/data-strategy/actions/workflows/qa.yml) to test for broken links.

Any errors the QA job finds will be added to the [📌 Link Checker Report](https://github.com/GSA/data-strategy/issues/338).

False positives, or URLs you wish to ignore can be put in the `.lycheeignore` file. This supports regex matching as well.

This job can also be run locally. Install instructions here: https://lychee.cli.rs/installation/

Then run with args: `lychee --base=https://strategy.data.gov .`

## Public domain

This project is in the worldwide [public domain](LICENSE.md). As stated in [CONTRIBUTING](CONTRIBUTING.md):

> This project is in the public domain within the United States, and copyright and related rights in the work worldwide are waived through the [CC0 1.0 Universal public domain dedication](https://creativecommons.org/publicdomain/zero/1.0/).
>
> All contributions to this project will be released under the CC0 dedication. By submitting a pull request, you are agreeing to comply with this waiver of copyright interest.