-
Notifications
You must be signed in to change notification settings - Fork 51
KUKSA Naming Guidelines
Erik Jaegervall edited this page Jul 19, 2023
·
1 revision
This page gives guidelines on how to refer to components in the KUKSA family.
The scope covered is the following repositories:
- Free Text - Preferred name in pictures, presentations, documentations |
- Preferred Short name - Preferred name for directories, Docker images, Python packages, ...
- Exceptions - Cases where "Preferred Short name" cannot be used, and what is then the preferred alternative!
| Free Text | Preferred Short name | Exceptions/Comments | Current Repository | Potential future Repo under eclipse-kuksa | |
|---|---|---|---|---|---|
| Databroker | KUKSA Databroker | databroker | https://github.com/eclipse/kuksa.val | kuksa-databroker | |
| KUKSA.val Server | KUKSA Server | kuksa-server | https://github.com/eclipse/kuksa.val | archived old location? | |
| KUKSA.val Client | KUKSA Python Client | kuksa-client | split cli and lib? Do we need to add "python" somehwere, i.e. when we later maybe have RUST, Go, etc | https://github.com/eclipse/kuksa.val | kuksa-client (the lib, if we split out the CLI may be kuksa-cli) |
| CAN Feeder | KUKSA DBC Feeder | dbc2val | maybe specific name depends on terminology discussion | https://github.com/eclipse/kuksa.val.feeders/tree/main/dbc2val | kuksa-can-provider or kuksa-provider-can |
| GPS Feeder | KUKSA GPS Feeder | gps | kuksa-gps-provider | ||
| SOME/IP Feeder | KUKSA SOME/IP Feeder | someip2val-vsomeip | |||
| Seat Service | KUKSA Example Seat Service | oci_vservice-seat? | https://github.com/eclipse/kuksa.val.services/tree/main/seat_service | ||
| HVAC Service | KUKSA Example HVAC Service | oci_vservice-hvac? | https://github.com/eclipse/kuksa.val.services/tree/main/hvac_service | ||
| Shared actions | N/A | kuksa-actions |
"Historically", when the Eclipse KUKSA project was started with the scope of "Connected in-vehicle ecosystem", the components where rather domains, and as such there were kuksa.in-vehicle, kuksa.apps, kuksa.ide, kuksa.cloud and later kuksa.appstore. Several things since 2017
- Generally in writing we went to capitalize KUKSA, as it is in the logo (the trademark, "Wort/Bildmarke" may also say that, but actually not sure)
- We gained .hardware as project we spun out .val, which was only part of kuksa.in-vehicle before, that also included parts from kuksa.apps, that whose decendents are not part of .services and .val.feeders, which are solely related to val.services
- We have since officially retired the in-vehicle, .apps, .ide, and appstore
- 2023-07-19: Dropping
.valas recommended suffix, it does not any longer give any additional information, and it is not mentioned on the project homepage