Test & document API usage scenarios
Open
Nobody has claimed this yet.
API
- Dominant language
- Python
- Stars
- 1.9k
- Forks
- 323
- Avg merge
- 1d 12h
- Merged PRs (30d)
- 12
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by reviewing the getting-started work in PR #705 and the existing documentation for local and remote usage. Check each listed tracker, API, and monitor scenario, including configuration files, parameters, environment variables, and project tokens. Done means every scenario is tested and its documentation matches the validated behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- api, documentation, testing
- Issue type
- Documentation
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100