GSA / us-data-federation

U.S. Data Federation website
https://federation.data.gov
Other
10 stars 10 forks source link

GitHub Actions GitHub Actions

us-data-federation

U.S. Data Federation website

Usage

Development

Requirements

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 for additional information.

This site is automatically published based on the branch.

Branch Environment URL Description
develop staging federation-staging.data.gov Ad-hoc development and significant changes requiring partner review.
main production federation.data.gov Production instance.

Federalist automatically builds previews for all branches. Changes to main are automatically published to federation.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.

Public domain

This project is in the worldwide public domain. As stated in CONTRIBUTING:

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.

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.