Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
dahutu opened this issue Apr 30, 2020 · 0 comments

Comments

@dahutu
Copy link
Collaborator

dahutu commented Apr 30, 2020

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant