Add documentation for Prow jobs

[joshjms]

Ref: #18707

/cc @ivanvc

Please read https://github.com/etcd-io/etcd/blob/main/CONTRIBUTING.md#contribution-flow.

[k8s-ci-robot]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: joshjms
Once this PR has been reviewed and has the lgtm label, please assign spzala for approval. For more information see the Code Review Process.

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

Needs approval from an approver in each of these files:

• OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 69.20%. Comparing base (4976738) to head (d9f803c).
Report is 305 commits behind head on main.

Additional details and impacted files

see 57 files with indirect coverage changes

@@            Coverage Diff             @@
##             main   #20132      +/-   ##
==========================================
+ Coverage   68.76%   69.20%   +0.43%     
==========================================
  Files         422      413       -9     
  Lines       35813    34364    -1449     
==========================================
- Hits        24628    23782     -846     
+ Misses       9768     9189     -579     
+ Partials     1417     1393      -24     

---

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 4976738...d9f803c. Read the comment docs.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[serathius]

List of every dashboard in prow will quickly make it outdated.

[joshjms]

List of every dashboard in prow will quickly make it outdated.

Hmm, that's true. Should I just make a description for each tests we have (e.g. instead of test-robustness-amd64 and test-robustness-arm64, we can just have them under "Robustness Tests" and a brief description of what they do)?

[serathius]

Hmm, that's true. Should I just make a description for each tests we have (e.g. instead of test-robustness-amd64 and test-robustness-arm64, we can just have them under "Robustness Tests" and a brief description of what they do)?

Sounds good, however for robustness tests we already have documentation https://github.com/etcd-io/etcd/blob/main/tests/robustness/README.md. Maybe instead of writing another one, just link to it. We don't have documentation for other types of tests, mostly because it's spread around the codebase, like unit tests. E2e and integration tests have their own directories so maybe we could add documentation there.

I think documenting types of tests, their goals and their method would be great.

[joshjms]

Right, definitely we can link to it. I'll write the documentation for the tests as well as how do we use Prow in the same documentation then. I'll write any questions I have here :)

[ivanvc]

Hi, @joshjms. Please also take a look at my comment on the parent issue (#18707 (comment)). I believe the proposed breakdown it's a bit different from what this pull request has. Thanks.

[joshjms]

Hi, @joshjms. Please also take a look at my comment on the parent issue (#18707 (comment)). I believe the proposed breakdown it's a bit different from what this pull request has. Thanks.

Ah okay noted, I was thinking of a good way to provide a high level overview for the Prow jobs that we have. I think making brief descriptions and linking it to their respective documentations (if any) would be good. Will work on the other sections too of course.