Auto-deploy docs built from commit 1674045

README.md

@@ -0,0 +1 @@
+This directory contains the project documentation including the sources for the online documentation website.

cdsp-best-practise.md

@@ -0,0 +1,4 @@
+# CDSP Best Practices/Design Guide
+This is currently a rough notepad of Best Practices to capture important points as the project establishes itself. The intention is for this to result in Best Practice and Design Guide documents to guide the project.
+
+1. Developers SHALL document both the *logical* and *implementation* concepts for extensions and examples. In particular the logical concept SHOULD at a minimum give a sense of the requirements for the problem being tackled in a way that allows alternative implementations to be considered. Contrast *problem/requirements XYZ can be met by logical concept ABC, illustrated in the implementation using technologies Foo* and *Product Foo has features XYZ*. The former contains useful information about a problem, how it might be logically addressed and an illustration implementing it. The latter possibly little if anything to say about the first two.

docs-gen/config.toml

@@ -0,0 +1,22 @@
+baseURL = "https://covesa.github.io/cdsp/"
+languageCode = "en-us"
+title = "Central Data Service Playground"
+theme = "learn"
+publishDir = "../docs"
+[params]
+  # Change default color scheme with a variant one. Can be "red", "blue", "green".
+  themeVariant = "blue"
+  disableInlineCopyToClipBoard = true
+  editURL = "https://github.com/covesa/cdsp/edit/master/docs/docs-gen/content/"
+  disableLandingPageButton = true
+
+
+[[menu.shortcuts]]
+name = "<i class='fab fa-github'></i> Github repo"
+identifier = "ds"
+url = "https://github.com/covesa/cdsp"
+weight = 10
+
+# Generation of JSON index to allow search
+[outputs]
+home = [ "HTML", "RSS", "JSON"]

docs-gen/content/_index.md

@@ -0,0 +1,16 @@
+---
+title: "Central Data Service Playground"
+---
+# Central Data Service Playground
+
+Intro to CDSP...
+
+To insert a figure:
+![Figure text](/cdsp/images/cdsp.png?width=50pc)
+
+To insert a link to[the sub chapter in the subchapter](/cdsp/cdsp_sub_chapter/sub-chapter)
+
+To insert a link to [COVESA/VSS-Tools](https://github.com/COVESA/vss-tools).
+
+## Another section
+Some CDSP detail....

docs-gen/content/cdsp_sub_chapter/_index.md

@@ -0,0 +1,9 @@
+---
+title: Sub-chapter
+weight: 20
+chapter: true
+---
+
+# Sub-chapter
+
+CDSP SwC explained maybe...

docs-gen/content/cdsp_sub_chapter/sub-chapter.md

@@ -0,0 +1,6 @@
+---
+title: "Sub-chapter"
+weight: 5
+---
+
+That does not contain other sub chapters.

docs-gen/data/units.yaml

@@ -0,0 +1,226 @@
+# This file defines units supported in the VSS standard catalog
+units:
+  mm:
+    label: millimeter
+    description: Distance measured in millimeters
+    domain: distance
+  cm:
+    label: centimeter
+    description: Distance measured in centimeters
+    domain: distance
+  m:
+    label: meter
+    description: Distance measured in meters
+    domain: distance
+  km:
+    label: kilometer
+    description: Distance measured in kilometers
+    domain: distance
+  inch:
+    label: inch
+    description: Distance measured in inches
+    domain: distance
+  km/h:
+    label: kilometer per hour
+    description: Speed measured in kilometers per hours
+    domain: speed
+  m/s:
+    label: meters per second
+    description: Speed measured in meters per second
+    domain: speed
+  m/s^2:
+    label: meters per second squared
+    description: Acceleration measured in meters per second squared
+    domain: acceleration
+  cm/s^2:
+    label: centimeters per second squared
+    description: Acceleration measured in centimeters per second squared
+    domain: acceleration
+  ml:
+    label: milliliter
+    description: Volume measured in milliliters
+    domain: volume
+  l:
+    label: liter
+    description: Volume measured in liters
+    domain: volume
+  cm^3:
+    label: cubic centimeters
+    description: Volume measured in cubic centimeters
+    domain: volume
+  celsius:
+    label: degree celsius
+    description: Temperature measured in degree celsius
+    domain: temperature
+  degrees:
+    label: degree
+    description: Angle measured in degrees
+    domain: angle
+  degrees/s:
+    label: degree per second
+    description: Angular speed measured in degrees per second
+    domain: angular speed
+  W:
+    label: watt
+    description: Power measured in watts
+    domain: power
+  kW:
+    label: kilowatt
+    description: Power measured in kilowatts
+    domain: power
+  PS:
+    label: horsepower
+    description: Power measured in horsepower
+    domain: power
+  kWh:
+    label: kilowatt hours
+    description: Energy consumption measured in kilowatt hours
+    domain: energy consumption
+  g:
+    label: gram
+    description: Mass measured in grams
+    domain: mass
+  kg:
+    label: kilogram
+    description: Mass measured in kilograms
+    domain: mass
+  lbs:
+    label: pound
+    description: Mass measured in pounds
+    domain: mass
+  V:
+    label: volt
+    description: Electric potential measured in volts
+    domain: electric potential
+  A:
+    label: ampere
+    description: Electric current measured in amperes
+    domain: electric current
+  Ah:
+    label: ampere hours
+    description: Electric charge measured in ampere hours
+    domain: electric charge
+  ms:
+    label: millisecond
+    description: Time measured in milliseconds
+    domain: time
+  s:
+    label: second
+    description: Time measured in seconds
+    domain: time
+  min:
+    label: minute
+    description: Time measured in minutes
+    domain: time
+  h:
+    label: hour
+    description: Time measured in hours
+    domain: time
+  day:
+    label: days
+    description: Time measured in days
+    domain: time
+  weeks:
+    label: weeks
+    description: Time measured in weeks
+    domain: time
+  months:
+    label: months
+    description: Time measured in months
+    domain: time
+  years:
+    label: years
+    description: Time measured in years
+    domain: time
+  UNIX Timestamp:
+    label: UNIX Timestamp
+    description: Unix time is a system for describing a point in time. It is the number of seconds that have elapsed since the Unix epoch, excluding leap seconds.
+    domain: point in time
+  mbar:
+    label: millibar
+    description: Pressure measured in millibars
+    domain: pressure
+  Pa:
+    label: pascal
+    description: Pressure measured in pascal
+    domain: pressure
+  kPa:
+    label: kilopascal
+    description: Pressure measured in kilopascal
+    domain: pressure
+  stars:
+    label: stars
+    description: Rating measured in stars
+    domain: rating
+  g/s:
+    label: grams per second
+    description: Mass per time measured in grams per second
+    domain: mass per time
+  g/km:
+    label: grams per kilometer
+    description: Mass per distance measured in grams per kilometers
+    domain: mass per distance
+  kWh/100km:
+    label: kilowatt hours per 100 kilometers
+    description: Energy consumption per distance measured in kilowatt hours per 100 kilometers
+    domain: energy consumption per distance
+  ml/100km:
+    label: milliliter per 100 kilometers
+    description: Volume per distance measured in milliliters per 100 kilometers
+    domain: volume per distance
+  l/100km:
+    label: liter per 100 kilometers
+    description: Volume per distance measured in liters per 100 kilometers
+    domain: volume per distance
+  l/h:
+    label: liter per hour
+    description: Flow measured in liters per hour
+    domain: flow
+  mpg:
+    label: miles per gallon
+    description: Distance per volume measured in miles per gallon
+    domain: distance per volume
+  N:
+    label: newton
+    description: Force measured in newton
+    domain: force
+  Nm:
+    label: newton meter
+    description: Torque measured in newton meters
+    domain: torque
+  rpm:
+    label: revolutions per minute
+    description: Rotational speed measured in revolutions per minute
+    domain: rotational speed
+  Hz:
+    label: frequency
+    description: Frequency measured in hertz
+    domain: frequency
+  ratio:
+    label: ratio
+    description: Relation measured as ratio
+    domain: relation
+  percent:
+    label: percent
+    description: Relation measured in percent
+    domain: relation
+  nm/km:
+    label: nano meter per kilometer
+    description: nm/km
+    domain: nm/km
+  dBm:
+    label: decibel milliwatt
+    description: Power level expressed in decibels with reference to one milliwatt
+    domain: relation
+  kN:
+    label: kilo newton
+    description: Force measured in kilo newton
+    domain: force
+  cpm:
+    label: cycles per minute
+    description: Number of cycles per minute
+    domain: frequency
+  bpm:
+    label: beats per minute
+    description: Number of human heart beats per minute
+    domain: frequency

docs-gen/layouts/partials/favicon.html

@@ -0,0 +1 @@
+<link rel="shortcut icon" href="/hierarchical_information_model/images/fav.png" type="image/x-icon" />

docs-gen/layouts/partials/logo.html

@@ -0,0 +1,3 @@
+<a id="logo" href="{{ .Site.BaseURL }}">
+  <img src="/cdsp/images/cdsp.png">
+</a>

docs-gen/themes/learn/.editorconfig

@@ -0,0 +1,16 @@
+# https://editorconfig.org
+
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+indent_size = 2
+indent_style = space
+trim_trailing_whitespace = true
+
+[*.js]
+insert_final_newline = true
+
+[*.md]
+trim_trailing_whitespace = false

docs-gen/themes/learn/.gitignore

@@ -0,0 +1,3 @@
+.DS_Store
+public/
+exampleSite/public

docs-gen/themes/learn/.grenrc.yml

@@ -0,0 +1,25 @@
+---
+  dataSource: "prs"
+  prefix: "v"
+  onlyMilestones: false
+  changelogFilename: "CHANGELOG.md"
+  includeMessages: "all"
+  ignoreIssuesWith:
+    - "support"
+  ignoreLabels:
+    - "duplicate"
+    - "invalid"
+    - "wontfix"
+  groupBy:
+    New features:
+      - "feature"
+    Bug Fixes:
+      - "bug"
+    Enhancements:
+      - "enhancement"
+    Internationalisation:
+      - "i18n"
+    Theme Meta:
+      - "meta"
+    Uncategorised:
+      - "closed"