-
Notifications
You must be signed in to change notification settings - Fork 189
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
Conversation
@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. |
There was a problem hiding this comment.
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
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. |
There was a problem hiding this comment.
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?
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please have a look.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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.
@camunda/tech-writers We'd apprechiate a review here. |
@nikku I'll have a look today 👍 |
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?
hold
label or convert to draft PR)PR Checklist
/versioned_docs
directory./docs
directory (aka/next/
).