-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
doc site: add initial baseline content
Add some initial baseline content to the documentation site so the team can understand the approach. Add a top level page and sections for introductory overview and examples. Some of the markdown contains placeholders for links to future content to show a suggested structure. Signed-off-by: Stephen Lawrence <[email protected]>
- Loading branch information
Showing
9 changed files
with
263 additions
and
0 deletions.
There are no files selected for viewing
4 changes: 4 additions & 0 deletions
4
docs/docs-gen/assets/Logical-Architecture-Overview.drawio.svg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,20 @@ | ||
--- | ||
title: "Central Data Service Playground" | ||
--- | ||
# Central Data Service Playground | ||
## Overview | ||
Learn the basics and benefits of using the playground | ||
|
||
[Overview]({{< ref "cdsp-overview" >}} "playground overview") | ||
|
||
## Browse by section | ||
|
||
### Manuals | ||
This section contains user guides and reference manuals for the playground | ||
|
||
Overview \| Integration guides \| etc. | ||
|
||
### Examples | ||
Learn how to use the playground by stepping through examples. | ||
|
||
[Overview]({{< ref "examples" >}} "playground overview") |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
--- | ||
title: "Playground examples" | ||
weight: 30 | ||
--- | ||
|
||
Learn how to use the playground by stepping through examples. | ||
|
||
Note: There is not a separate section for the VSS data model because the vast majority of the examples will be making use of it. | ||
|
||
## Getting started | ||
[Docker sanity test](https://github.com/COVESA/cdsp/blob/main/docker/README.md) \| [Hello-world](https://github.com/COVESA/cdsp/tree/main/examples/cdsp-hello-world) | ||
|
||
## Data Layer, Processing and Analysis | ||
Data Reduction \| Data Quality \| Events \| Data Streams etc. | ||
|
||
## Knowledge Layer, Reasoning and Data Models | ||
Data Layer Connector \| A \| B \| C etc. | ||
|
||
## Feeders | ||
RemotiveLabs \| WAII VISS \| etc. | ||
|
||
## COVESA Touchpoints | ||
A \| B \| C | ||
|
||
## COVESA Technologies | ||
vsome/ip (SOME/IP) \| uServices \| Vehicle API \| VISS etc. | ||
|
||
## Databases | ||
Apache IoTDB \| MongoDB Realm \| Redis/SQLite/memcache etc. | ||
|
||
## Frameworks / Protocols | ||
vsome/ip (SOME/IP) \| VISS \| uServices/uProtocol/Capabilities \| Vehicle API \| MQTT \| Kafka \| Apache Zeppelin etc. | ||
|
||
## Big data | ||
Hadoop \| Flink \| Spark \| Cloud DB \| Nifi etc. | ||
|
||
## Other examples | ||
A \| B \| C |
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
--- | ||
title: "Playground overview" | ||
chapter: true | ||
weight: 10 | ||
--- | ||
|
||
# Introduction | ||
|
||
Learn the basics and benefits of using the playground |
22 changes: 22 additions & 0 deletions
22
docs/docs-gen/content/overview/cdsp-implementation-concept.md
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
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
--- | ||
title: "Playground implementation" | ||
weight: 30 | ||
--- | ||
|
||
{{% notice warning %}} | ||
This placeholder text comes from the Playground Proposal and will be replaced with a fuller discussion of the implementation | ||
{{% /notice %}} | ||
|
||
## Implementation Concepts | ||
|
||
The logical section above should be read to understand the concepts to be implemented. This section suggests starting points for discussion in the community. | ||
Initial idea for the Central Data Service | ||
|
||
As outlined in the logical description, as a starting point the Service could be realised as a basic building block combining VISS Data Server with highly functional VSS Data Store. The availability of generic code allows flexible deployment to meet the two high level implementation needs to support easy development trials, whilst also supporting investigation closer to production, including a path to production. | ||
|
||
Initial idea/sketch for base building block: | ||
- Generic code: VISS Data Server with VSS Data Store backend | ||
- Data Architecture requirements: Add Apache IotDB (Apache eco-system, embedded and UDF) and Realm (embedded, sync) as backends to enable research. | ||
- Example using WAII VISS Data Protocol Server, which supports historical data and has a data store backend and various embedded databases: | ||
- Deployment 1 - Easy to develop (assumed first target): x86 host Docker containers | ||
- Deployment 2 - Closer to production (assumed second target): ARM64 using common automotive deployment, e.g. Yocto Linux. |
Oops, something went wrong.