-
Notifications
You must be signed in to change notification settings - Fork 3.7k
Closed
Labels
old-coursePR or issue relates to the old course, which will be replaced soon.PR or issue relates to the old course, which will be replaced soon.
Description
Description
The "Navigating the Editor UI" lesson in the Level One course provides a comprehensive overview of the Editor UI but lacks detailed documentation for the Logs panel, a critical component for workflow execution monitoring. Existing pull requests (#3588 and #3590) have initiated efforts to address this, focusing on execution results, errors, and status indicators. However, the following aspects remain undocumented:
- Activation mechanism (e.g., populating after workflow execution).
- Advanced UI features such as "Sync selection with canvas" and "Pop out panel".
Proposed Enhancement
I propose adding a dedicated "Logs Panel" subsection to the lesson to ensure completeness. Suggested content:
- Location: Positioned at the bottom of the canvas.
- Purpose: Provides detailed execution logs, including node inputs, outputs, statuses (e.g., success, error), and error messages.
- Activation: Populates with data upon executing a workflow via the "Execute workflow" button or an active trigger.
- Additional Features: Includes "Sync selection with canvas" (aligns log entries with corresponding nodes) and "Pop out panel" (enables a detachable view for enhanced usability).
- Note: In the Community Edition, execution logs are retained for 24 hours; longer retention is available in paid plans.
- Benefit: This addition will empower users to effectively debug and monitor workflows, aligning the documentation with the UI’s full capabilities.
Next Steps
I am prepared to submit a pull request to implement this enhancement.
Supporting Rationale
- Enhances user onboarding by clarifying a key debugging tool.
- Complements ongoing efforts in PR docs: add Log Panel section to Editor UI lesson #3588 and docs: add Logs panel section with example screenshot #3590 with additional functionality.
- Ensures documentation reflects the latest UI experience.
Metadata
Metadata
Assignees
Labels
old-coursePR or issue relates to the old course, which will be replaced soon.PR or issue relates to the old course, which will be replaced soon.