Update documentation
@pk910 is already working on this.
Since Feb 23, 2024.
Assessment
This issue has not been assessed yet.
Description
Reminder to keep the documentation up to date!
Missing stuff:
-
schedulesection in test configuration & test scheduler description -
coordinatorsection in test configuration with general settings (test retention time & execution concurrency) - existence of API,
api.enabledsetting & reference to swagger api documentation within the assertoor UI - enhance description of variable system (global / test config is not passed down to all task configs)
- describe
configVarsand the ability to use jq syntax for more complex expressions
Nice to have:
- Description of assertoor code structure
- How to use assertoor as go library (call tasks, call tests)
- Dominant language
- Go
- Stars
- 75
- Forks
- 29
- PR merge metrics
- No merged PRs in 30d
Getting set up
- Ships a Dockerfile or Docker Compose file
- No pull request template
- No contributing 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.
More from ethpandaops/assertoor
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
ethpandaops/assertoor#125 ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
ethpandaops/assertoor#88 ·
-
Difficulty 5/5 Over a week Newbie friendliness 20/100
ethpandaops/assertoor#67 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 25/100
ethpandaops/assertoor#49 ·
-
Difficulty 3/5 1-2 days Newbie friendliness 45/100
ethpandaops/assertoor#17 ·
All issues in ethpandaops/assertoor
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
prime-radiant-inc/evener#3726 ·
Maintainers usually reply within 1 day
-
[BUG] Async engine endpoint-label relationship counts include pending relationships of every typeOpen
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
Maintainers usually reply within 1 day
-
status/0-needs-triage
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 86/100
modelcontextprotocol/go-sdk#1340 ·
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100