Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update links after migration #69

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Update links after migration #69

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 9 additions & 9 deletions docs/QUICKSTART.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,8 +5,8 @@ This guide explains on how to setup the infrastructure to use and test the KUKSA
## Requirements
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since this ticket does not really fix a bug, I would use the Conventional Commit Type "docs" instead of "fix"


- 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)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- 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.

- a running [KUKSA Mock Provider](https://github.com/eclipse-kuksa/kuksa-mock-provider) (Optional)

## Setup KUKSA Databroker

Expand All @@ -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)
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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


## Setup Vehicle Mock Service (Optional)
## Setup KUKSA Mock Provider (Optional)

This step is only required when connecting to a local running KUKSA Databroker, which is not
integrated into an actual vehicle.

To use the Companion App the KUKSA Databroker needs to be connected to the Mock Service.
The Mock Service 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 Service can be found here:
[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:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

[Running mock provider](https://github.com/eclipse-kuksa/kuksa-mock-provider?tab=readme-ov-file#running-mock-provider)

The Mock Service needs to be run with the
The Mock Provider needs to be run with the
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
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
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

project to use it.

## Configure Companion App
Expand Down
Loading