stale bot: even more TL;DR

[ryantm]

Continuation of #100462 since I couldn't figure out how to make a PR against @blaggacao's repo.

The goal here is to make the stale bot's message super short, and direct people to a documentation page that we can update over time.

[blaggacao]

Excellent! Thanks also for the rewordings!

[blaggacao]

Formatting Oversight

[doronbehar]

Looks Great to me. Good thinking!

[ryantm]

I resolved my formatting mistake and added a Thank you to the top.

cc @abathur who cares about this too.

[abathur]

I either didn't stay in the loop or have simply forgotten, but I didn't realize the current messages were this big. It's good to give information, but I agree the message is trying to do much work.

What sort of feedback/edits are you looking for? I don't have time to read everything or copyedit the manual section just this moment, but I think I'd like to at least make a suggested edit that rounds the corners of the new message later today.

[ryantm]

@abathur I'm planning to merge this tomorrow, so if your suggestions don't happen by then, feel free to do a separate PR!

[ryantm]

@abathur Sorry, I didn't answer your question. I was looking for proof reading/copy editing, since the text changed a lot. The most important part to get right is the short markComment part though, since we can dynamically change the other part.

[abathur]

I'll try to double-dip some build time to look at it this evening :)

Edit: I didn't explain most of these, but feel free to haggle or ask for reasoning.

[ryantm]

squashed all those commits into one

[blaggacao]

@abathur Thanks for your rewordings. Spot on.

@ryantm I really like the conciseness of just linking to the help. It feels like being consequent about TL;DR and people will respect that (and find respecfulness within it).

[Mic92]

Good to merge!

[cole-h]

I think this needs at least some form of short introduction. Just linking to another document without any other information seems... bad, to me. See #85956 (comment) -- just dropping a link doesn't feel like a good user experience to me, at least without some kind of short explanation.

[ryantm]

@cole-h Thanks for the feedback! Here's our reasons for making it super short:

1. We can't change all the old comments it makes if something changes
2. We'd like people to read the more detailed page
3. We don't want to annoy regular contributors with a long message

How does that sit with you? Do you have a suggestion or what to change?

[blaggacao]

Maye a compromise could be:

I marked this as stale. → More Info

[cole-h]

@ryantm I definitely agree with all of your reasoning, but I also think there ought to be a small "springboard" (if you will), as @blaggacao suggested.

I would lean more towards a message like the following:

I've marked this issue as stale due to inactivity. For more information, click here.

or something similar. It gives a "why", and then links to the document, instead of just dropping a link and saying "cya".

[blaggacao]

@cole-h Sounds good, just avoid "issue" or "pr" to make the text ubiquitous.

I marked this as stale due to inactivity. → More Info

[blaggacao]

→ #101781

[colemickens]

Am I missing something or does this ... not actually tell the user how to remove the stale tag from an issue that is still important?

[ryantm]

@colemickens the doc it links to says "To remove the stale label, just leave a new comment" very prominently.

[colemickens]

I don't know why I glazed over that and went straight to "suggestions for PRs" (and then skimmed the text for any monospaced font with the key phrase), but indeed, it does clearly say to just leave a comment. My mistake.