Update links after migration #69
Conversation
lukasmittag
force-pushed
the
update/links_migrated
branch
from
7916280
to
59b209d
Compare
| @@ -15,19 +15,19 @@ KUKSA Databroker might run inside a car or on your local system for testing purp | |||
| to set up a local KUKSA Databroker can be found in | |||
| the [KUKSA Quickstart Guide](https://github.com/eclipse/kuksa.val/blob/master/doc/quickstart.md) | |||
There was a problem hiding this comment.
Shall we try to get rid of all kuksa.val references, like here use https://github.com/eclipse-kuksa/kuksa-databroker/blob/main/doc/quickstart.md
There was a problem hiding this comment.
There are also some links at the end to kuksa.val which we better shall get rid of. I.e. check if the files have been migrated or if not discuss how we best should migrate them
There was a problem hiding this comment.
If you get rid of the kuksa.val occurences make sure to align full_description.txt (which is used by F-Droid) as well as README.md
| @@ -15,19 +15,19 @@ KUKSA Databroker might run inside a car or on your local system for testing purp | |||
| to set up a local KUKSA Databroker can be found in | |||
| the [KUKSA Quickstart Guide](https://github.com/eclipse/kuksa.val/blob/master/doc/quickstart.md) | |||
There was a problem hiding this comment.
If you get rid of the kuksa.val occurences make sure to align full_description.txt (which is used by F-Droid) as well as README.md
| @@ -5,8 +5,8 @@ This guide explains on how to setup the infrastructure to use and test the KUKSA | |||
| ## Requirements | |||
There was a problem hiding this comment.
Since this ticket does not really fix a bug, I would use the Conventional Commit Type "docs" instead of "fix"
| [Running mockservice](https://github.com/eclipse/kuksa.val.services/tree/main/mock_service#running-mockservice) | ||
| To use the Companion App the KUKSA Databroker needs to be connected to the Mock Provider. | ||
| The Mock Provider simulates the interaction with the car e.g. sensors and actuators of a car. | ||
| The steps to set up a local instance of the Vehicle Mock Provider can be found here: |
There was a problem hiding this comment.
| The steps to set up a local instance of the Vehicle Mock Provider can be found here: | |
| The steps to set up a local instance of the Mock Provider can be found here: |
Naming should be aligned as per line 18
| following [mock.py](https://github.com/eclipse-kuksa/kuksa-android-companion/blob/main/mock/mock.py). | ||
| Simply replace the mock.py inside the Vehicle Mock Service repository with the one provided by this | ||
| Simply replace the mock.py inside the Vehicle Mock Provider repository with the one provided by this |
There was a problem hiding this comment.
| Simply replace the mock.py inside the Vehicle Mock Provider repository with the one provided by this | |
| Simply replace the mock.py inside the Mock Provider repository with the one provided by this |
Naming should be aligned as per line 18
| @@ -5,8 +5,8 @@ This guide explains on how to setup the infrastructure to use and test the KUKSA | |||
| ## Requirements | |||
|
|
|||
| - Android Device with API Level >= 27 (Android 8.1) | |||
| - a running [KUKSA DataBroker](https://github.com/eclipse/kuksa.val/tree/master/kuksa_databroker) | |||
| - a running [Vehicle Mock Service](https://github.com/eclipse/kuksa.val.services/tree/main/mock_service) (Optional) | |||
| - a running [KUKSA DataBroker](https://github.com/eclipse-kuksa/kuksa-databroker) | |||
There was a problem hiding this comment.
| - a running [KUKSA DataBroker](https://github.com/eclipse-kuksa/kuksa-databroker) | |
| - a running [KUKSA Databroker](https://github.com/eclipse-kuksa/kuksa-databroker) |
Name should be aligned. While internally our class is named "DataBroker" (to support camel case usage) we still want to follow the official naming when it comes to the "real Databroker". This was an oversight on our end.
|
@lukasmittag - do you want to fix the remaining items here so we can get it merged? Do not think it should take that long time :-) |
This updates links in quickstart.md for mock provider and databroker