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: Add better/updated documentation of the events hierarchy of Dashboard 2.0 #646

Closed
joepavitt opened this issue Mar 5, 2024 · 2 comments · Fixed by #647
Closed

Docs: Add better/updated documentation of the events hierarchy of Dashboard 2.0 #646

joepavitt opened this issue Mar 5, 2024 · 2 comments · Fixed by #647
Assignees
Labels
area:docs Improvements or additions to documentation size:M - 3 Sizing estimation point task A piece of work that isn't necessarily tied to a specific Epic or Story.

Comments

@joepavitt
Copy link
Collaborator

joepavitt commented Mar 5, 2024

Description

I've had multiple people reach out asking for finer detail and clarity over the events architecture of Dashboard 2.0, especially detail on the state and data stores that exist on both client- and server- side.

This is the original events architecture diagram:

image

I also need to better document the lifecycle hooks APIs that exist for widgets too, and the default handlers, e.g. onInput in this diagram.

Example thread that raises this concern: https://discourse.nodered.org/t/vuejs-where-to-store-my-data/85939/8

Have you provided an initial effort estimate for this issue?

I have provided an initial effort estimate

@joepavitt joepavitt added task A piece of work that isn't necessarily tied to a specific Epic or Story. size:M - 3 Sizing estimation point area:docs Improvements or additions to documentation labels Mar 5, 2024
@joepavitt joepavitt self-assigned this Mar 5, 2024
@joepavitt
Copy link
Collaborator Author

joepavitt commented Mar 5, 2024

First pass at improved/updated events architecture diagrams. I've made the call to split these into multiple images, rather than try and fit them all into one image like I do currently, which makes it overwhelming to rad, especially where the full diagram isn't actually connected.

Part 1. Deployment & Loading Logic

Screenshot 2024-03-05 at 19 03 15

Part 2. Message Injection Logic

Screenshot 2024-03-05 at 19 03 10

Part 3. Dashboard Actions Logic

Screenshot 2024-03-06 at 16 06 43

@joepavitt
Copy link
Collaborator Author

This should also assist with #404

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area:docs Improvements or additions to documentation size:M - 3 Sizing estimation point task A piece of work that isn't necessarily tied to a specific Epic or Story.
Projects
Status: Done
Development

Successfully merging a pull request may close this issue.

1 participant