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

Jump to bottom

Test & document API usage scenarios #711

Open

SaboniAmine opened this issue Nov 15, 2024 · 0 comments

Labels

API

Collaborator

SaboniAmine commented Nov 15, 2024

Description

In order to open the dashboard to the public, we must ensure the following user journeys are valid & documented :

Local usage, with data sent to the API (tested, documentation outdated)
Local usage, without sending data to the API (not tested, documented)
Remote usage, with the python tracker :

Using a pre-generated config file (not tested, not documented)
Using the tracker parameters (not tested, not documented)
Using only env vars (not tested, not documented)

Remote usage, with the monitor mode with a project token / config file

A getting started is being added to the interface in @prmths128's PR : #705

SaboniAmine added the API label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment