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

docs(modeler): add troubleshooting entry for sandboxing issue #4607

Merged
merged 6 commits into from
Nov 19, 2024

Conversation

nikku
Copy link
Member

@nikku nikku commented Nov 15, 2024

Description

This adds a knowledge base / troubleshooting entry for camunda/camunda-modeler#4695.

Related to camunda/camunda-modeler#4695

When should this change go live?

  • This is a bug fix, security concern, or something that needs urgent release support.
  • This is already available but undocumented and should be released within a week.
  • This on a specific schedule and the assignee will coordinate a release with the DevEx team. (apply hold label or convert to draft PR)
  • This is part of a scheduled alpha or minor. (apply alpha or minor label)
  • There is no urgency with this change and can be released at any time.

PR Checklist

  • My changes are for an already released minor and are in /versioned_docs directory.
  • My changes are for the next minor and are in /docs directory (aka /next/).

@nikku nikku added the component:desktop-modeler Issues related with Desktop Modeler label Nov 15, 2024
@nikku nikku requested review from a team November 15, 2024 11:27
@nikku nikku self-assigned this Nov 15, 2024
@nikku nikku requested review from barmac and abdul99ahad and removed request for a team November 15, 2024 11:27
@nikku nikku requested a review from misiekhardcore November 15, 2024 11:30
@nikku
Copy link
Member Author

nikku commented Nov 15, 2024

@misiekhardcore Assigning you as a reviewer as this may hit you (or did already hit you). Be the first user 🙂

zsh: trace trap (core dumped) ./camunda-modeler
```

To remedy this you have to configure your system to allow the sandboxing (again) or disable the sandbox altogether (dangerous, not recommended). [This resource](https://github.com/camunda/camunda-modeler/issues/4695#issuecomment-2478581677) explains the available options in depth.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wouldn't phrase it like that, this might bring confusion to those who started from v24

Suggested change
To remedy this you have to configure your system to allow the sandboxing (again) or disable the sandbox altogether (dangerous, not recommended). [This resource](https://github.com/camunda/camunda-modeler/issues/4695#issuecomment-2478581677) explains the available options in depth.
To remedy this you have to configure your system to allow the sandboxing or disable the sandbox altogether (dangerous, not recommended). [This resource](https://github.com/camunda/camunda-modeler/issues/4695#issuecomment-2478581677) explains the available options in depth.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also is it a good practice to link to a discussion under an issue instead of place the recommended solution directly here and add the link to that discussion as an additional source of information?

Copy link
Member Author

@nikku nikku Nov 17, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Also is it a good practice to link to a discussion under an issue instead of place the recommended solution directly here and add the link to that discussion as an additional source of information?

Consider yourself as a user: Would you want the recommended solution here, and link to alternatives (outside of this topic)? Especially as a "I'm not root and I don't care" solution is available that we do not recommend, but may be the only option for some users. I'm actually torn. I think we should show different resolutions, and allows users to decide. Hence I rather linked to the external source, which goes full length to explain what can be done (and what are the consequences).

Further note: We can always iterate on this, based on user feedback.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried to inline the recommended option, but it feels odd (as it hides crucial information). What I could imagine instead is to link directly to the respective comment.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Please have a look.

Copy link
Member Author

@nikku nikku Nov 18, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

So what I'd like to compare is fe5bd52 (inlined resolution) vs. 770f0dc (compact version).

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In my opinion from a user perspective, it is always good to have the documentation give you the recommended solution straight away instead of redirect to other sources and make you find the correct answer yourself. Of course there are many solution to this problem as you listed them under that linked issue, but if there is any "best practice" or "recommended solution" from our side, we should give it directly to the user and as an extension (for those who still have issues) there is the link to alternative options for which most of users won't have to bother.
Looking at your both solutions, they both look good to me, cause they are both clearly indicate the recommendation. If the recommended solution should be placed in the docs directly or not this is a subjective matter - to me personally I like it to be in the doc instead of linked, even if it looks a little bulky and takes space.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

to me personally I like it to be in the doc instead of linked, even if it looks a little bulky and takes space.

Let's consider this as a follow-up and merge the shorter solution for now.

misiekhardcore
misiekhardcore previously approved these changes Nov 18, 2024
@nikku
Copy link
Member Author

nikku commented Nov 18, 2024

@camunda/tech-writers We'd apprechiate a review here.

@christinaausley
Copy link
Contributor

@nikku I'll have a look today 👍

@christinaausley christinaausley requested review from christinaausley and removed request for a team November 18, 2024 15:14
@nikku nikku merged commit 5e7ce8b into main Nov 19, 2024
6 checks passed
@nikku nikku deleted the trouble-shooting-desktop-modeler-userns-hint branch November 19, 2024 06:21
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
component:desktop-modeler Issues related with Desktop Modeler
Projects
Status: ✅ Done
Development

Successfully merging this pull request may close these issues.

3 participants