Add new FAQ #2159
Add new FAQ #2159
Conversation
📝 WalkthroughWalkthroughThe changes in the Changes
Possibly related PRs
Suggested reviewers
Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media? 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
Documentation and Community
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Outside diff range and nitpick comments (4)
docs/Support/FAQ.md (4)
Line range hint
1-592: Consider reorganizing FAQs into topic-based sectionsThe FAQs would be more navigable if organized into topic-based sections such as:
- Getting Started
- Installation & Configuration
- Authentication & Security
- Integration & External Systems
- Workflow Design
- Task Management
- Troubleshooting
🧰 Tools
🪛 Markdownlint (0.35.0)
543-543: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
544-544: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
583-591: Add language identifier to code blockAdd the Python language identifier to the code block for better syntax highlighting:
- ``` + ```python import uuid unique_id = str(uuid.uuid4())--- `468-470`: **Remove line number artifacts** Remove the line numbers ("468~", "469~", "470~") that appear to be artifacts in the text. --- `543-544`: **Fix list indentation** Adjust the indentation of the unordered list items to be consistent with the rest of the document: ```diff - - Use single `=` for variable assignments (e.g., `result = "approve"`). - - Avoid using double `==`, as it is a comparison operator, not an assignment. + - Use single `=` for variable assignments (e.g., `result = "approve"`). + - Avoid using double `==`, as it is a comparison operator, not an assignment.🧰 Tools
🪛 Markdownlint (0.35.0)
543-543: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
544-544: Expected: 0; Actual: 2
Unordered list indentation(MD007, ul-indent)
📜 Review details
Configuration used: .coderabbit.yaml
Review profile: CHILL
📒 Files selected for processing (1)
docs/Support/FAQ.md(4 hunks)
🧰 Additional context used
🪛 Markdownlint (0.35.0)
docs/Support/FAQ.md
543-543: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
544-544: Expected: 0; Actual: 2
Unordered list indentation
(MD007, ul-indent)
| @@ -464,7 +465,9 @@ The SpiffWorkflow backend is highly modular, supporting various worker types thr | |||
| **Q:** Do multiple instances of the SpiffWorkflow backend require a shared filesystem for storing process models? | |||
There was a problem hiding this comment.
Let’s remove this question and answer.
| - **Data Payload:** Provide a JSON object in the `data` field for POST requests. | ||
| - **Common Errors:** | ||
| - **Missing `headers`:** Add `{}` to the `headers` field. | ||
| - **Connection Refused:** Replace `localhost` with `host.docker.internal` in containerized environments. |
There was a problem hiding this comment.
This isn’t a common enough cause for connection refused. I’d remove this.
|
|
||
| Also, ensure input/output mappings are correctly defined in the parent process to facilitate data transfer. | ||
|
|
||
| ### **46: Embed the BPMN editor in an iframe** |
There was a problem hiding this comment.
I don’t think we’ve ever successfully used the editor in an iframe. I’d probably avoid this question to avoid misleading people.
|
|
||
| ### **49: Generate UUIDs in Python Script Tasks** | ||
|
|
||
| **Q:** How do I generate UUIDs in Python Script Tasks?** |
There was a problem hiding this comment.
Does import uuid actually work in a script task? I thought maybe import was not allowed.
Summary by CodeRabbit
New Features
Enhancements
Clarifications
Code Examples