camunda / camunda-modeler

An integrated modeling solution for BPMN, DMN and Forms based on bpmn.io.
https://camunda.com/products/modeler
MIT License
1.47k stars 473 forks source link

Make `flags.json` accessible from option menu #3467

Open christian-konrad opened 1 year ago

christian-konrad commented 1 year ago

Problem you would like to solve

The flags.json is an important place for some settings, for example to configure the path to an SSL certificate to connect to a self-managed Zeebe installation. However, users don't know it exist, what it is used for, and how to configure it, until they read the documentation.

Proposed solution

Have an Settings entry in the Desktop Modeler menu (toolbar and/or tab context menu) that opens the flags.json in an (external? OS default?) editor.

Cf. how it works in Windows Terminal:

https://learn.microsoft.com/en-us/windows/terminal/customize-settings/profile-general

image

Alternatives considered

Provide a full-fledged settings page in Desktop Modeler. But that should be a future iteration.

Additional context

Cf. https://jira.camunda.com/browse/SUPPORT-15806


Depends on https://github.com/camunda/camunda-modeler/issues/2913

nikku commented 1 year ago

Is this a duplicate of https://github.com/camunda/camunda-modeler/issues/2913? I absolutely agree that this is worth tackling at some point.

christian-konrad commented 1 year ago

@nikku https://github.com/camunda/camunda-modeler/issues/2913 is the full-fledged solution. However, this is a first increment.

Cf. how it was done in Windows Terminal (I linked it above). They started with the settings.json opened via the settings menu, and later added an UI on top

nikku commented 1 year ago

We currently have different files:

I think we should invest into a simple settings dialog instead of exposing all these files through the menu.

christian-konrad commented 1 year ago

@nikku how feasible is it to start implementing https://github.com/camunda/camunda-modeler/issues/2913 ?

We can be super agile here and just add more and more options to the page. Every option exposed in the UI instead of the jsons will add value to it.

The dialog could then also start with a section saying "every other option can be specified in JSON files. Read the docs to understand what and where etc"

nikku commented 1 year ago

@christian-konrad I agree.

Let's keep it very basic to start with, and add more as we see the need. Starting basic with a setting stab is absolutely feasible. For now the pressing issue is "access to startup flags" (and/or related configuration). :arrow_right: https://github.com/camunda/camunda-modeler/issues/2913#issuecomment-1432843628.

CatalinaMoisuc commented 1 year ago

I suggest that we validate with the customer if the solution that @nikku proposed in the support ticket would actually be a better and simpler option to solve their problem.

That being said, I suggest that we don't prioritize this yet, but @christian-konrad you support us with getting in touch with the customer to validate if the solution mentioned above would lead to a better result and user experience for the customer.