yesodweb / yesodweb/persistent
Document the fact that most of the adapters silently support environment variables
Open
Nobody has claimed this yet.
documentation
Newcomer
- Dominant language
- Haskell
- Stars
- 486
- Forks
- 306
- PR merge metrics
- No merged PRs in 30d
Description
As environment variables are arguably "the right way to do it", and as people occasionally ask in #yesodweb whether it's really a good idea to put a database password in a file, I think it's a good idea to mention what environment variables are supported by which adapters, maybe even in the haddocks.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the adapters and their Haddock documentation, then identify which environment variables each adapter supports. Done means the documentation maps supported variables to adapters and addresses the database-password guidance.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- haskell
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 30/100