kubernetes-sigs / release-team-shadow-stats

Kubernetes release team shadow program application analysis
Apache License 2.0
14 stars 6 forks source link

Improve project usability #6

Closed leonardpahlke closed 2 years ago

leonardpahlke commented 2 years ago

This tool is expected to get used any other month at the start of a release cycle by a changing audience due to the rotation in the release-team. To make the project usage as smooth as possible it is needed to document and improve usability. The project and tools should be used with minimal engineering knowledge.

Currently this is not give and the README is quite cryptic about which steps are needed to use the project and adopt a new shadow application survey layout.

Questions that should be answered and streamlined

Right now you need to make changes in code to adopt a new application schema, it would be good to define this with configuration files (this also allows to generate old reports over again since multiple configs can be specified) (the config can be written in python...)

ref tracking issue: https://github.com/kubernetes-sigs/release-team-shadow-stats/issues/4

leonardpahlke commented 2 years ago

/assign

I will start with this as soon as I find time (prob end of this week 17)

k8s-triage-robot commented 2 years ago

The Kubernetes project currently lacks enough contributors to adequately respond to all issues and PRs.

This bot triages issues and PRs according to the following rules:

You can:

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

leonardpahlke commented 2 years ago

/remove-lifecycle stale