-
Notifications
You must be signed in to change notification settings - Fork 188
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
true/false in config docs #4118
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I've reviewed the changes, and all the default value changes to lower case look good to me.
Non-blocking: I know it's not part of this PR scope, but I did notice the following:
- For the descriptions, we could standardise and make them less passive. For example, 'When true, Importer module is enabled" > "Enable the Importer module".
- The use of "whether" could be changed to use "if" as per the Camunda writing style guide: https://camunda.com/brand/writing-style-guide/
@mesellings, thanks for the review! Can you add an issue to the backlog for this? To be complete, we'll also need to change the config "docs" in the codebase. |
Will do - forgive my ignorance, what do you mean by "config docs in the codebase"? Where would this be? |
If we're going through the trouble of updating these, my preference is to use |
On a quick review of the templates, we may not need to change this at all! The templates for broker config really drive this documentation. We moved it into the docs to make it easier to discover. At the top of the page we link to the template.
We do something similar for gateway config. |
Issue created: #4123 |
Description
Closes #3047
When should this change go live?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).