Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Add how to validate configuration file with synapse.config script#16714

Merged
DMRobertson merged 4 commits intomatrix-org:developfrom
amandahla:add-config-parser-doc
Dec 5, 2023
Merged

Add how to validate configuration file with synapse.config script#16714
DMRobertson merged 4 commits intomatrix-org:developfrom
amandahla:add-config-parser-doc

Conversation

@amandahla
Copy link
Contributor

@amandahla amandahla commented Dec 1, 2023 •
edited
Loading

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?

@amandahla amandahla requested a review from a team as a code owner December 1, 2023 15:23
@erikjohnston
Copy link
Member

erikjohnston commented Dec 1, 2023

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
Copy link
Contributor Author

amandahla commented Dec 4, 2023

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
DMRobertson approved these changes Dec 5, 2023
View reviewed changes
Copy link
Contributor

@DMRobertson DMRobertson left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Brilliant, thank you!

@DMRobertson DMRobertson merged commit e87499b into matrix-org:develop Dec 5, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Reviewers

1 more reviewer

@DMRobertson DMRobertson DMRobertson approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Document config parser utility

3 participants

@amandahla @erikjohnston @DMRobertson