developmentseed / developmentseed/observe
Clean up documentation of .env file
- Dominant language
- JavaScript
- Stars
- 66
- Forks
- 4
- PR merge metrics
- No merged PRs in 30d
Description
The `.env` file has grown a lot, and I think the documentation has not always kept up -- let's make sure the docs around it are clearer, ideally with better examples.
Also, it would be great to be able to fail with hard errors if certain env vars are not set.
My suggestion would be to have the env vars as comments in the `.env.sample` file and not as values meant to be replaced. Then if the user does not uncomment them purposefully and looks at them, it should just fail with an `Env Var not set` type error.
cc @vgeorge @geohacker
Contributor guide
Research direction
Start with the existing documentation around the `.env` file and the `.env.sample` file mentioned in the issue. Separate the request for clearer examples from the proposed hard errors for unset variables; done should mean the environment-variable guidance is clear and the desired missing-variable behavior is explicitly resolved.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100