kubernetes-sigs / release-team-shadow-stats

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

Update README's - add new examples/README to help browsing the examples #13

Closed leonardpahlke closed 2 years ago

leonardpahlke commented 2 years ago

What type of PR is this?

/kind documentation

What this PR does / why we need it:

  1. This PR adds a /examples/README.md which should help browsing the example data.
  2. Highlight that the examples are generated with fake data
  3. Update /README.md (remove some older comments...)

Which issue(s) this PR fixes:

Fixes #12

Special notes for your reviewer:

ref tracking issue: #4

Does this PR introduce a user-facing change?

None
leonardpahlke commented 2 years ago

cc @reylejano

leonardpahlke commented 2 years ago

@saschagrunert & @puerco if you find time for a review :pray: I just made changes to README's with this PR

/assign @justaugustus

k8s-ci-robot commented 2 years ago

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: leonardpahlke, saschagrunert

The full list of commands accepted by this bot can be found here.

The pull request process is described here

Needs approval from an approver in each of these files: - ~~[OWNERS](https://github.com/kubernetes-sigs/release-team-shadow-stats/blob/main/OWNERS)~~ [saschagrunert] Approvers can indicate their approval by writing `/approve` in a comment Approvers can cancel approval by writing `/approve cancel` in a comment
saschagrunert commented 2 years ago

/lgtm