Skip to content

Conversation

MightyPen
Copy link
Contributor

Summary

'description-missing' Suggestions, bulk auto fixes, first round. (ML)
These build Suggestions were activated 2020/Aug/20, and are scheduled to escalate to Warnings in late October 2020.

I discussed this demo PR with Mark LeBlanc. I will not merge this PR without Mark LeBlanc's prior OK.

(Not a GitHub Issue.) Fixes #Issue_Number (if available)

GeneMi (= MightyPen)

@MightyPen MightyPen requested a review from BillWagner as a code owner August 28, 2020 00:21
@dotnet-bot dotnet-bot added this to the August 2020 milestone Aug 28, 2020
@dnfadmin
Copy link

dnfadmin commented Aug 28, 2020

CLA assistant check
All CLA requirements met.

@MightyPen
Copy link
Contributor Author

@mcleblanc @BillWagner
Hello Mark and Bill, This PR #20322 can be Closed (and thereafter ignored) -or- Merged, whichever you prefer.

If you choose to have this PR Closed, your team of FTE writers might thereby be taking on the duty/task of manually fixing the 11,000 description-missing Suggestion messages in repo 'dotnet/docs'. It is unclear whether there will ever be sufficient vendor resources for them to manually fix all these (note that other repositories also have thousands of similar Suggestions that also must be fixed).

If you choose to Merge this PR #20322, I would next run the .Exe again, for another 980 .md files, and repeat the whole run-PR process several times, until all 'description-missing' Suggestions are fixed.

Please let me know how you would like to proceed. I have been told to keep MartinEk and his LT informed how each major repo is progressing on their many Suggestion (and Warning) messages.

It might be possible for me to allocate vendor resources to fix the fewer number of other new Suggestion messages in this repo.


Suggestion        Count
description-missing      10043
column-header-missing      661
duplicate-headings       519
image-alt-text-duplicated      130
duplicate-h1s      122
duplicate-titles      42
duplicate-descriptions      17


Thanks. GeneMi (= MightyPen)
. .

@MightyPen
Copy link
Contributor Author

@Youssef1313 @mcleblanc
Youssef, Your recommended changes to the new 'description:' values in this PR #20322 may well be better than the bulk auto values this PR has to offer. In particular, the keywords "custom event accessors" seems plenty desirable to have (as one of your examples).

But this repo has 11,000 'description-missing' Suggestion messages to fix, plus over 1,000 other messages to fix, all in the next two months. We must balance the ideal vs the practical. No final decision yet.

Thanks.

@Youssef1313
Copy link
Member

@MightyPen I just picked small amount of files to make this balance. Obviously it' too hard to manually write this large amount of descriptions.

Copy link
Member

@BillWagner BillWagner left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is great @MightyPen

Also, thanks for the extra suggestions @Youssef1313 Those are an improvement. As mentioned, we don't think it will be worth the investment to hand edit every article. When you do have suggestions, making them is great, but I wouldn't spend too much time on it.

I'll :shipit: now, and keep 👀 out for upcoming PRs.

Thanks again.

@BillWagner BillWagner merged commit 13219b2 into dotnet:master Aug 28, 2020
@MightyPen
Copy link
Contributor Author

@mcleblanc @BillWagner Hi, Just fyi, I have been asked to slooow down the bulk auto fixes of 'description-missing' until after the IGNITE conference is completed, on 2020/Sept/24. The Localization system would become clogged at a time when any IGNITE changes need to be processed promptly.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

5 participants