Conversation
aspnetcore/web-api/index.md
Outdated
|
|
||
| ### Log automatic 400 responses | ||
|
|
||
| For information about how to log automatic HTTP 400 responses, see [issue #12157 in the AspNetCore.Docs repo](https://github.com/aspnet/AspNetCore.Docs/issues/12157). |
There was a problem hiding this comment.
I propose we standardize our engineering issue/PR links. I suggest basing them on their titles (unless the titles are really bad). The following is the format that I've been using, but I'd like to adopt a format that the team agrees on and use it everywhere. I'll keep an 👂 out for guidance from the team.
| For information about how to log automatic HTTP 400 responses, see [issue #12157 in the AspNetCore.Docs repo](https://github.com/aspnet/AspNetCore.Docs/issues/12157). | |
| For information on how to log automatic HTTP 400 responses, see [How automatically triggered model validation errors can be logged? (aspnet/AspNetCore.Docs #12157)](https://github.com/aspnet/AspNetCore.Docs/issues/12157). |
There was a problem hiding this comment.
It's important to let people know they're linking out of the docs. And if we include the title in the link text we should change the title to make it as effectively descriptive as possible within a reasonable length limit.
There was a problem hiding this comment.
Since we don't control them on the engineering side, there was a case or two where I had to use a different title. IIRC, most of the engineering issue titles were fine.
It's just a personal thing, but I've usually been less concerned on the where-it-is aspect. I just put that under the umbrella of this is the Internet ... this is how the whole thing works. 😄
There was a problem hiding this comment.
Anywho ... let me know if you cats standardize. Otherwise, I'll keep going. I haven't had negative feedback from a reader about any of my cross-links ...... yet 🤞.
Fixes #12157