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: Use "Multi Tenancy" to describe the second design pattern #963

Merged
merged 1 commit into from
Jun 13, 2024
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ Built into the framework of the UI is a side navigation bar, along with the top,
There are two core Design Patterns that are possible when building with Dashboard 2.0:

- **Single Source of Truth:** All users of your Dashboard will see the same data. This is useful for industrial IoT or Home Automation applications.
- **Client-Driven Data:** Data shown in a particular widget is unique to a given client/session/user. This represents a more traditional web application, where each user has their own session and associated data.
- **Multi Tenancy:** Data shown in a particular widget is unique to a given client/session/user. This represents a more traditional web application, where each user has their own session and associated data.

It's worth noting that these two patterns can be mixed and matched within a single Dashboard 2.0 application, shown [later](#example).

Expand All @@ -117,10 +117,10 @@ When a user goes to visit a Dashboard, the widgets will load their respective st

An example of this is that if you have interactive elements, e.g. a slider linked to a chart, then one user moving the slider will draw data to the chart of every other user's Dashboards too.

### Client-Driven Data
### Multi Tenancy

![Client-Driven Data](./assets/images/design-pattern-client.png){data-zoomable}
_Example workflow to demonstrate the "Client-Driven Data" design pattern._
![Multi Tenancy](./assets/images/design-pattern-client.png){data-zoomable}
_Example workflow to demonstrate the "Multi Tenancy" design pattern._

In Dashboard 2.0 we can configure a given node type to ["Accept Client Data"](/user/sidebar.html#client-data) from the sidebar:

Expand Down
Loading