From b422c15dd30efae16900df0e987db90321eb45c8 Mon Sep 17 00:00:00 2001 From: Nico Rehwaldt Date: Fri, 7 Jun 2024 15:32:52 +0200 Subject: [PATCH] Desktop Modeler Flags improvements (#3899) Related to https://github.com/camunda/camunda-modeler/issues/4350 --- .../modeler/desktop-modeler/flags/flags.md | 20 +++++++++++-------- .../modeler/desktop-modeler/flags/flags.md | 18 ++++++++++------- 2 files changed, 23 insertions(+), 15 deletions(-) diff --git a/docs/components/modeler/desktop-modeler/flags/flags.md b/docs/components/modeler/desktop-modeler/flags/flags.md index ba88d31892..c53a07565a 100644 --- 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 index 71d2bc19bb..69d052dce3 100644 --- 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: