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

true/false in config docs #4118

Merged
merged 1 commit into from
Aug 7, 2024
Merged

true/false in config docs #4118

merged 1 commit into from
Aug 7, 2024

Conversation

akeller
Copy link
Member

@akeller akeller commented Aug 6, 2024

Description

Closes #3047

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@akeller akeller added the component:docs Documentation improvements, including new or updated content label Aug 6, 2024
@akeller akeller requested a review from a team August 6, 2024 21:22
@akeller akeller self-assigned this Aug 6, 2024
@mesellings mesellings self-requested a review August 7, 2024 10:31
Copy link
Contributor

@mesellings mesellings left a 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/

@akeller
Copy link
Member Author

akeller commented Aug 7, 2024

@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.

@mesellings
Copy link
Contributor

@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?

@conceptualshark
Copy link
Contributor

If we're going through the trouble of updating these, my preference is to use inline code when referring to specific boolean values (or any value), but I don't think we have a company style for this use.

@akeller
Copy link
Member Author

akeller commented Aug 7, 2024

@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?

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.

A complete broker configuration template is available in the Zeebe repo.

We do something similar for gateway config.

@mesellings
Copy link
Contributor

Issue created: #4123

@akeller akeller merged commit 1f2d61c into main Aug 7, 2024
10 checks passed
@akeller akeller deleted the fix-boolean-casing branch August 7, 2024 21:41
pepopowitz pushed a commit that referenced this pull request Oct 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:docs Documentation improvements, including new or updated content
Projects
Archived in project
Development

Successfully merging this pull request may close these issues.

Example values in config docs tables should match the YAML snippet casing
3 participants