resources.data.gov

Resources for open data and enterprise data inventory management.

Usage

Editing content

This site uses Netlify to manage its editorial workflow. Content is added and edited in collections via the Netlify interface, which can be accessed by approved contributors at resources.data.gov/admin. Collections are managed via the config.yml file in pages/admin.

Branches and environments

Environment	Branch	Description
resources.data.gov	main	The production instance of r.d.g.
resources-staging.data.gov	develop	A preview site used for ad-hoc development or significant changes requiring partner review.
*	feature branches	Feature branches to preview a single change.

Federalist builds all branches and creates previews for them. Two branches are special, main which is automatically deployed by Federalist to resources.data.gov and develop which is used as a staging branch for significant changes.

Deploying to staging is not required. It might be useful for previewing significant changes to the site that require partner review.

Development

Prerequisites

• Ruby 3.1.4
• Bundler 1.17.x (we use an older version for Federalist compatibility)
  • install via gem install bundler -v 1.17.3
  • use version by bundle _1.17.3_ ...
• Node.js 20

Setup

Install Node.js dependencies.

$ npm install

Install Ruby dependencies ( !WARNING! If you use a mac ensure you install a version manager for ruby to avoid messing up your system ruby installation ).

$ npm run setup

Run the build.

$ npm run build

Run the server

$ npm run start

Open your web browser to localhost:4000.

Test the generated site.

$ npm run test

Check for broken links.

$ npm run qa

Update dependencies

To update dependencies, you can run bundle update {dependency} after running npm install. Then follow all other development steps above to validate site is working as expected.