Doc: Core, Bedrock and Distribution layers #1
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
danyill
reviewed
Apr 10, 2025
| ## Context | ||
|
|
||
| As a community we would like to have a stable and UI technology agnostic API to use in our plugins and build on top of it. | ||
| Current, the name "OpenSCD Core" can lead to misunderstandings. It not only contains and API but it provides a ready-to-go UI, the plugin loading mechanism and other things. |
There was a problem hiding this comment.
Suggested change
| Current, the name "OpenSCD Core" can lead to misunderstandings. It not only contains and API but it provides a ready-to-go UI, the plugin loading mechanism and other things. | |
| Current, the name "OpenSCD Core" can lead to misunderstandings. It not only contains an API but it provides a ready-to-go UI, the plugin loading mechanism and other things. |
|
|
||
| As a community we would like to have a stable and UI technology agnostic API to use in our plugins and build on top of it. | ||
| Current, the name "OpenSCD Core" can lead to misunderstandings. It not only contains and API but it provides a ready-to-go UI, the plugin loading mechanism and other things. | ||
| However, we still need an API and specification, and a a quick way to create and configure a new distribution of OpenSCD. |
There was a problem hiding this comment.
Suggested change
| However, we still need an API and specification, and a a quick way to create and configure a new distribution of OpenSCD. | |
| However, we still need an API and specification, and a quick way to create and configure a new distribution of OpenSCD. |
|
|
||
| 2. Bedrock: You can use a given Bedrock to build your own OpenSCD distribution. It is a Web Component that you can easily deploy and configure. If you need more or different functionality that you cannot achive by configuring a Bedrock, you can create your own. | ||
|
|
||
| 3. Core: it is mainly for plugin-, bedrock- and distribution developers in the ecosystem to help each other create plugins that are compatible with every distributions and also to create distributions that are compatible with most of the plugins. |
There was a problem hiding this comment.
Suggested change
| 3. Core: it is mainly for plugin-, bedrock- and distribution developers in the ecosystem to help each other create plugins that are compatible with every distributions and also to create distributions that are compatible with most of the plugins. | |
| 3. Core: it is mainly for plugin-, bedrock- and distribution developers in the ecosystem to help each other create plugins that are compatible with every distribution and also to create distributions that are compatible with most plugins. |
|
|
||
| ## Consequences | ||
|
|
||
| - With the new, simpler Core we can agree on the common API on the code level |
There was a problem hiding this comment.
Suggested change
| - With the new, simpler Core we can agree on the common API on the code level | |
| - With the new, simpler Core we can agree on the common API at the code level |
|
|
||
| - With the new, simpler Core we can agree on the common API on the code level | ||
| - Other components and layers are not bound to a specific UI technology | ||
| - We aggre on what belongs into the core |
There was a problem hiding this comment.
Suggested change
| - We aggre on what belongs into the core | |
| - We agree on what belongs into the core |
|
|
||
| 1. Distribution: It is for distributors who want to create a new instance of OpenSCD and tailor it for specific needs through possible configurations. | ||
|
|
||
| 2. Bedrock: You can use a given Bedrock to build your own OpenSCD distribution. It is a Web Component that you can easily deploy and configure. If you need more or different functionality that you cannot achive by configuring a Bedrock, you can create your own. |
There was a problem hiding this comment.
Can we describe what is in bedrock with some concrete examples? For instance:
- Providing information to plugins for state management
- Provide basic user interface for undo and redo
- Provide identity management and back-end integration
- Provide overall look and feel for distribution
Does it also include
- Plugin loading? Or is that the distribution? Or is that core?
| └──────────┘ | ||
| ``` | ||
|
|
||
| 1. Distribution: It is for distributors who want to create a new instance of OpenSCD and tailor it for specific needs through possible configurations. |
There was a problem hiding this comment.
What is in a distribution - is it just a collection of plugins built on top of bedrock or is it more? Does it include bundling/packaging?
Should we show plugins here in relation to a distribution? I feel they should be in this diagram somewhere...
```txt
┌──────────────────────┐ ┌─────────┐
│ Distribution │<--│ Plugins |
└──┬────────────────┬──┘ └─────────┘
│ Bedrock │
└──┬──────────┬──┘
│ Core │
└──────────┘
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.