Skip to content

Commit

Permalink
Template documents for the website build
Browse files Browse the repository at this point in the history
  • Loading branch information
Naci Dai committed Jul 5, 2023
1 parent 2b8ac6c commit 86cd0f6
Show file tree
Hide file tree
Showing 4 changed files with 73 additions and 0 deletions.
8 changes: 8 additions & 0 deletions docs/_category_.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
{
"label": "Fleet Management",
"position": 2,
"link": {
"type": "generated-index",
"description": "5 minutes to learn the most important Docusaurus concepts."
}
}
43 changes: 43 additions & 0 deletions docs/docusaurus.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@

# Blueprints Documents

The documents in this folder are included in eclipse-sdv-blueprint website. The eclipse sdv blueprints website is created with Docusaurus (https://docusaurus.io) and deployed as github pages.

- Blueprints website repository:
https://github.com/eclipse-sdv-blueprints/blueprints-website

- Blueprints website URL (not CNAME):
https://eclipse-sdv-blueprints.github.io/blueprints-website

## Including new documents in the website build
The documents in this folder are included using the **https://github.com/rdilweb/docusaurus-plugin-remote-content** plugin. Please edit and commit the **blueprints-website/docusaurus.config.js** file to include new files and images, e.g:

```javascript
plugins:[ [
"docusaurus-plugin-remote-content",
{
name: "fleet-management",
// the base url for the markdown (gets prepended to all of the documents when fetching)
sourceBaseUrl: "https://raw.githubusercontent.com/eclipse-sdv-blueprints/fleet-management/main/docs",
// the base directory to output to.
outDir: "docs/fleet-management",
// the file names to download
documents: ["introduction.md"],
},
], [
"docusaurus-plugin-remote-content",
{
name: "fleet-management-img",
// the base url for the markdown (gets prepended to all of the documents when fetching)
sourceBaseUrl: "https://raw.githubusercontent.com/eclipse-sdv-blueprints/fleet-management/main/docs/img",
// the base directory to output to.
outDir: "docs/fleet-management/img",
// the file names to download
documents: ["architecture.png"],
},
]],
```

## Updating the website

Trigger the github action that builds the website for the eclipse sdv blueprints
Binary file added docs/img/architecture.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
22 changes: 22 additions & 0 deletions docs/introduction.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
---
sidebar_position: 1
title: Introduction
---



## Fleet Ops
| Truck Fleet Ops| |
|---|---|
|Short Summary | A close to "real-life" showcase for truck fleet management where trucks run SDV stacks so that logistics fleet operators can manage apps, data and services for a diverse set of vehicles.|
|What is in the showcase | Data collection from CANBus, In vehicle data brokers, VSS Signal Specification, FMS servers, Apps and Services using this data|
|SDV Projects Involved| Leda, Kuksa, Velocitas, Charriot, SommR?|
|Other interesting Technologies|InfluxDB, Prometheus, Eclipse Hono, Eclipse Kanto, Digital.Auto |
| Architecture Overview | ![FleetArchSDV.png](./img/architecture.png)|
| Distro | TBD|
| Coordinator | Kai Hudalla |

# Getting Started
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Phasellus ultrices rutrum tellus eget euismod. Nullam mauris metus, tincidunt quis scelerisque et, accumsan a ligula. Morbi eget tempus lacus. Ut sollicitudin laoreet nibh at ullamcorper. Maecenas at semper augue. Donec pulvinar bibendum lectus sit amet convallis. Vestibulum rhoncus mi in congue dictum. Proin mollis tristique elit, eu bibendum tellus pellentesque faucibus. Sed accumsan orci nisi, sollicitudin egestas neque volutpat non. Sed vulputate faucibus semper. Proin vestibulum nisl erat, sed pellentesque erat auctor et. Sed tristique sem eget urna sollicitudin maximus.

Fusce eget magna felis. Mauris sed efficitur risus. Suspendisse potenti. Maecenas quis dapibus nulla. In ultrices ligula nec condimentum facilisis. Pellentesque ut mi et orci egestas posuere. Sed vitae massa in neque faucibus blandit sit amet id justo. Aenean consequat, neque ac pulvinar auctor, est lacus hendrerit dolor, id tristique libero augue a lacus. In aliquet ligula a odio consectetur, non ornare elit posuere. Phasellus neque purus, consequat a auctor eu, facilisis ac ante. Etiam pulvinar nunc eget neque ornare, id dictum quam viverra. Etiam eu accumsan urna, eu commodo mi. Aliquam erat volutpat. Mauris ac fermentum enim. Suspendisse leo sem, tempor tincidunt orci id, dapibus accumsan odio.

0 comments on commit 86cd0f6

Please sign in to comment.