Add how to validate configuration file with synapse.config script

[amandahla]

Pull Request Checklist

• Pull request is based on the develop branch
• Pull request includes a changelog file. The entry should:
  • Be a short description of your change which makes sense to users. "Fixed a bug that prevented receiving messages from other servers." instead of "Moved X method from EventStore to EventWorkerStore.".
  • Use markdown where necessary, mostly for code blocks.
  • End with either a period (.) or an exclamation mark (!).
  • Start with a capital letter.
  • Feel free to credit yourself, by adding a sentence "Contributed by @github_username." or "Contributed by [Your Name]." to the end of the entry.
• Pull request includes a sign off
• Code style is correct
  (run the linters)

Resolves #8160
Signed-off-by: Amanda Hager Lopes de Andrade Katz amanda.katz@canonical.com

I didn't add anything to the changelog since this is a documentation change. Is it needed?

[erikjohnston]

I didn't add anything to the changelog since this is a documentation change. Is it needed?

Yes please! A documentation change uses a .doc suffix, so just adding something in changelog.d/16714.doc would do (something like "Add documentation for how to validate the configuration file with synapse.config script.")

[amandahla]

I didn't add anything to the changelog since this is a documentation change. Is it needed?

Yes please! A documentation change uses a .doc suffix, so just adding something in changelog.d/16714.doc would do (something like "Add documentation for how to validate the configuration file with synapse.config script.")

Perfect, thanks. I added it now.

[DMRobertson]

Brilliant, thank you!