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

Improvements to Self-Managed deployment table descriptions #4123

Open
mesellings opened this issue Aug 7, 2024 · 1 comment
Open

Improvements to Self-Managed deployment table descriptions #4123

mesellings opened this issue Aug 7, 2024 · 1 comment
Labels
component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have)

Comments

@mesellings
Copy link
Contributor

This issue was prompted by the work for #4118.

For the description columns in the tables:

  • Standardise the descriptions to 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/.

These files are affected, there may be other tables in these docs that are also affected?

@mesellings mesellings added kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have) component:docs Documentation improvements, including new or updated content component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed labels Aug 7, 2024
@mesellings
Copy link
Contributor Author

FYI @akeller

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 component:self-managed Docs and issues related to Camunda Platform 8 Self-Managed kind/enhancement Issues related with enhancing existing documentation or the documentation structure (nice to have)
Projects
Status: 🆕 Inbox
Development

No branches or pull requests

1 participant