Desktop Modeler Flags improvements (#3899)

Related to camunda/camunda-modeler#4350
camunda · Jun 7, 2024 · b422c15 · b422c15
1 parent bae7519
commit b422c15
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 15 deletions.
diff --git a/docs/components/modeler/desktop-modeler/flags/flags.md b/docs/components/modeler/desktop-modeler/flags/flags.md
@@ -4,17 +4,21 @@ title: Flags
 description: "Flags allow you to control the availability of certain features within Desktop Modeler."
 ---
 
-Flags allow you to control the availability of certain features within Desktop Modeler.
+Flags allow you to control the availability of certain features within Desktop Modeler. Learn which flags [are available](#available-flags) and how to [configure them](#configuration).
 
-## Configuring Flags
+## Configuration
 
 You may configure flags in a `flags.json` file or pass them via CLI.
 
-### Configure in `flags.json`
+### Configuration via `flags.json`
+
+:::note
+Configuration changes via `flags.json` will only take effect once you restart the application.
+:::
 
 Place a `flags.json` file inside the `resources` folder of your local [`{USER_DATA}`](../search-paths#user-data-directory) or [`{APP_DATA_DIRECTORY}`](../search-paths#app-data-directory) directory to persist them.
 
-### Configure via CLI
+### Configuration via command line
 
 Pass flags via the command line when starting the application.
 
@@ -24,7 +28,7 @@ camunda-modeler --disable-plugins
 
 Flags passed as command line arguments take precedence over those configured via a configuration file.
 
-## Available Flags
+## Available flags
 
 | flag                                                       | default value                       |
 | ---------------------------------------------------------- | ----------------------------------- |
@@ -48,13 +52,13 @@ Flags passed as command line arguments take precedence over those configured via
 
 ## Examples
 
-### Disable Plug-ins
+### Disable plug-ins
 
 Start the modeler without activating installed plug-ins. This is useful to debug modeler errors.
 
-### BPMN-only Mode
+### BPMN-only mode
 
-To disable the DMN and Form editing capabilities of the App, configure your `flags.json` like this:
+To disable the CMMN and DMN editing capabilities of the App, configure your `flags.json` like this:
 
 ```js
 {

diff --git a/versioned_docs/version-8.5/components/modeler/desktop-modeler/flags/flags.md b/versioned_docs/version-8.5/components/modeler/desktop-modeler/flags/flags.md
@@ -4,17 +4,21 @@ title: Flags
 description: "Flags allow you to control the availability of certain features within Desktop Modeler."
 ---
 
-Flags allow you to control the availability of certain features within Desktop Modeler.
+Flags allow you to control the availability of certain features within Desktop Modeler. Learn which flags [are available](#available-flags) and how to [configure them](#configuration).
 
-## Configuring Flags
+## Configuration
 
 You may configure flags in a `flags.json` file or pass them via CLI.
 
-### Configure in `flags.json`
+### Configuration via `flags.json`
+
+:::note
+Configuration changes via `flags.json` will only take effect once you restart the application.
+:::
 
 Place a `flags.json` file inside the `resources` folder of your local [`{USER_DATA}`](../search-paths#user-data-directory) or [`{APP_DATA_DIRECTORY}`](../search-paths#app-data-directory) directory to persist them.
 
-### Configure via CLI
+### Configuration via command line
 
 Pass flags via the command line when starting the application.
 
@@ -24,7 +28,7 @@ camunda-modeler --disable-plugins
 
 Flags passed as command line arguments take precedence over those configured via a configuration file.
 
-## Available Flags
+## Available flags
 
 | flag                                                       | default value                       |
 | ---------------------------------------------------------- | ----------------------------------- |
@@ -47,11 +51,11 @@ Flags passed as command line arguments take precedence over those configured via
 
 ## Examples
 
-### Disable Plug-ins
+### Disable plug-ins
 
 Start the modeler without activating installed plug-ins. This is useful to debug modeler errors.
 
-### BPMN-only Mode
+### BPMN-only mode
 
 To disable the CMMN and DMN editing capabilities of the App, configure your `flags.json` like this: