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

Improve documentation for enabling/disabling feature flags #4350

Closed
2 tasks
GeethaParthasarathy opened this issue Jun 6, 2024 · 3 comments
Closed
2 tasks
Assignees
Labels
bug Something isn't working documentation Improvements or additions to documentation
Milestone

Comments

@GeethaParthasarathy
Copy link

GeethaParthasarathy commented Jun 6, 2024

Describe the bug

Currently while I try to enable the feature flag for a particular feature in the Desktop Modeler there is no sufficient documentation to enable them in Mac OS.

Steps to reproduce

  1. open the documentation to configure feature flags https://docs.camunda.io/docs/next/components/modeler/desktop-modeler/flags/#configuring-flags

  2. Try to configure a feature flag in Mac OS.

  3. We could see that the documentation lacks the following :

  4. The way to reach the {USER_DATA}] or {APP_DATA_DIRECTORY} directory in Mac OS where the .json file could be added

  5. Missing step to create a feature flag folder

  6. Missing mention about restarting the app->,Once the .json file is added to the feature flag folder the app needs to be restarted completely for the changes to be effective

Expected behavior

All the above missing info should be documented therefore the users are finding it easy configure feature flags from Mac OS

  • As a user I have a MacOS example showing me where to store the flags file
  • As a user I can learn about app restart being required to activate flags

Environment

  • OS: [e.g. MacOS 10.2]
  • Camunda Modeler Version: [e.g. 5.24.0]
  • Execution Platform: [e.g. Camunda 7, Camunda 8]

Additional context

No response

@GeethaParthasarathy GeethaParthasarathy added the bug Something isn't working label Jun 6, 2024
@nikku nikku added the ready Ready to be worked on label Jun 7, 2024
@nikku
Copy link
Member

nikku commented Jun 7, 2024

Let's pick this up as a follow-up action (post release).

@nikku nikku added the documentation Improvements or additions to documentation label Jun 7, 2024
nikku added a commit to camunda/camunda-docs that referenced this issue Jun 7, 2024
nikku added a commit to camunda/camunda-docs that referenced this issue Jun 7, 2024
@nikku
Copy link
Member

nikku commented Jun 7, 2024

@nikku nikku self-assigned this Jun 7, 2024
@nikku nikku added fixed upstream Requires integration of upstream change and removed ready Ready to be worked on labels Jun 7, 2024
nikku added a commit to camunda/camunda-docs that referenced this issue Jun 7, 2024
@nikku nikku added this to the M78 milestone Jun 7, 2024
nikku added a commit to camunda/camunda-docs that referenced this issue Jun 7, 2024
nikku added a commit to camunda/camunda-docs that referenced this issue Jun 7, 2024
@nikku
Copy link
Member

nikku commented Jun 7, 2024

Closing with both documentation PRs being merged.

@nikku nikku closed this as completed Jun 7, 2024
@bpmn-io-tasks bpmn-io-tasks bot removed the fixed upstream Requires integration of upstream change label Jun 7, 2024
@nikku nikku modified the milestones: M78, M77 Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants