airbnb / airbnb/synapse

Doc: README uses YAML config in Example Migration but only mentions JSON format in Configuration

Open
#324 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
Ruby
Stars
2.1k
Forks
248
PR merge metrics
No merged PRs in 30d

Description

Synapse can use both YAML and JSON format configuration files, and in Example Migration section of README.md, the example Synapse configuration is in YAML format. However Configuration section states "Synapse depends on a single config file in JSON format; it's usually called synapse.conf.json". This is not consistent with Synapse capability or the example config. Please fix by either change the example config file to JSON, or preferably, state that both JSON and YAML are valid for configuration.

Contributor guide

No contributing guide indexed for this repository

Research direction

Open README.md and compare the Configuration section with the YAML example in the Example Migration section. Update the Configuration wording to state that both JSON and YAML configuration files are valid, then verify that the README no longer contradicts the example.

Written by the indexing model from the issue text.

Assessment

Tech stack
json, yaml
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.