search

kubernetes / test-infra

Test infrastructure for the Kubernetes project.
Apache License 2.0
3.83k stars 2.65k forks source link

`▶ Details` blocks should hint about expanding or not be used as much. #22911

Closed BenTheElder closed 2 years ago

BenTheElder commented 3 years ago

What would you like to be added:

These are relatively un-styled on github.com and may not be obvious to expand.

A lot of bot comments hide the really useful details on how to deal with a problem behind these.

We should consider not using these or at least making their own usage more obvious.

Why is this needed:

I haven't really seen <details> blocks used on the web, certainly not unstyled, and I'm observing what I strongly suspect to be new users not expanding and reading these. I suspect that at least some of them would read these but aren't figuring out that they need to click on the ▶

@kubernetes/sig-contributor-experience

MadhavJivrajani commented 3 years ago

/assign

@BenTheElder I think changing Details to something along the lines of Click here for more details might help. Not sure if we should remove the <details> block, mainly because too much text in a comment can also cause non-attention to the info provided ("too much text" is again subjective). WDYT?

nikhita commented 3 years ago

@MadhavJivrajani It might be helpful to get data on which prow plugins use Details today. This can help us identify areas of friction in a much clearer way.

spiffxp commented 3 years ago

/sig contributor-experience @BenTheElder do you have a list of comments that use this and which ones should be changed?

MadhavJivrajani commented 3 years ago

From what I could tell, the following use <details> blocks (either through format functions in prow/respond.go or directly as part of a format string constant defined):

BenTheElder commented 3 years ago

As noted above there are a lot of these. I don't have a list, I'm looking for input on the concept.

I've never seen the unstyled <details> block anywhere else on the web myself and I can't say that I've seen any other GitHub automation use it. I suspect that without a demonstration or prior experience people probably just never read any of the contents which makes it somewhat less useful.

But it's hard to tell for sure and I'm not sure what we should do instead. In emails these aren't collapsed IIRC so it might make sense to stop using them at all.

I wouldn't ask anyone to move forward on this without more input on what the solution should be from contribex etc.

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

k8s-triage-robot commented 2 years ago

The Kubernetes project currently lacks enough active 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 rotten

k8s-triage-robot commented 2 years ago

The Kubernetes project currently lacks enough active 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.

/close

k8s-ci-robot commented 2 years ago

@k8s-triage-robot: Closing this issue.

In response to [this](https://github.com/kubernetes/test-infra/issues/22911#issuecomment-1011490046): >The Kubernetes project currently lacks enough active contributors to adequately respond to all issues and PRs. > >This bot triages issues and PRs according to the following rules: >- After 90d of inactivity, `lifecycle/stale` is applied >- After 30d of inactivity since `lifecycle/stale` was applied, `lifecycle/rotten` is applied >- After 30d of inactivity since `lifecycle/rotten` was applied, the issue is closed > >You can: >- Reopen this issue or PR with `/reopen` >- Mark this issue or PR as fresh with `/remove-lifecycle rotten` >- Offer to help out with [Issue Triage][1] > >Please send feedback to sig-contributor-experience at [kubernetes/community](https://github.com/kubernetes/community). > >/close > >[1]: https://www.kubernetes.dev/docs/guide/issue-triage/ Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.