Add docs - Githubissues

st-tech / gatling-operator

Automating distributed Gatling load testing using Kubernetes operator

MIT License

68 stars 21 forks source link

Add docs #22

Closed yokawasa closed 1 year ago

yokawasa commented 2 years ago

At least, the following docs are needed

Architecture design doc
features list
Quick start guide
Configuration docs
API reference

yokawasa commented 2 years ago

PR #27 covers the following items:

[x] Architecture design doc
[x] features list
[x] Quick start guide (but outdated)
[x] Configuration docs
[x] API reference

yokawasa commented 2 years ago

@tmrekk121 let me assign Quick start guide update to you.

[x] Quick start guide Update

yokawasa commented 2 years ago

I'll be working on Architecture design doc

[x] Architecture design doc

ksudate commented 2 years ago

I think it would be great to have another sample Gatling CR running where both reporting and notification are enabled. We can add that to the quickstart guide in another PR

https://github.com/st-tech/gatling-operator/pull/41#pullrequestreview-898513325

yokawasa commented 1 year ago

closing the issue as all relevant PRs has been merged