Skip to content

Commit

Permalink
chore: expand docs on our config file setup (#2008)
Browse files Browse the repository at this point in the history
Expand docs on our config file setup
  • Loading branch information
Bryce Kalow authored Jun 26, 2023
1 parent 502bc3a commit f0df95a
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -160,7 +160,7 @@ export default SomePage

## Configuration

Per-environment configuration values are defined in JSON files in the `config/` folder. Each environment has its own config file, currently:
Per-environment configuration values are defined in JSON files in the `config/` folder. Each environment has its own config file, controlled by the `HASHI_ENV` environment variable, currently:

```
config/
Expand All @@ -184,7 +184,7 @@ The configuration values are available globally within the application. They can
console.log(__config.my_config_value)
```

Configuration files should be used for any non-sensitive configuration values needed throughout the application which might vary by environment. Consider API endpoints, constants, and flags in scope for the configuration files.
Configuration files should be used for any non-sensitive configuration values needed throughout the application which might vary by environment. Consider API endpoints, constants, and flags in scope for the configuration files. Any references to `__config` are replaced at build-time with the values from the environment's configuration file using [Webpack's DefinePlugin](https://webpack.js.org/plugins/define-plugin/).

## Analytics

Expand Down

1 comment on commit f0df95a

@vercel
Copy link

@vercel vercel bot commented on f0df95a Jun 26, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please sign in to comment.