Readme Content Verification - need to format readmes to match template doc #5499
Comments
scbedd
added
the
Client
|
@scbedd @AlexGhiondea - Does this need to stay open or close? |
|
Existing issues related to opt-out:
Service-specific issues:
|
* updates to READMEs for #5499 * updates * initial work on Storage auth sections * updates to Storage READMEs * sorted and culled list of presence issue exceptions * alphabetize sections and update webpubsub to comply * file some issues to track open issues; reorganize the exceptions a bit. * update snippets * update requested by WebPubSub
annelo-msft
added
the
MQ
|
@scbedd, I'm not getting any output for the |
|
@annelo-msft I'm slow on notifications 👎 Are you invoking it as the CI does? If so, you're likely passing along the Reasoning was that we didn't want to turn all pipelines red forever. So we filed the issues for backlog address and moved on from there. To see the issues as they are now, just remove the All that being said, we've lived long enough without traction on this issue, is it worth re-opening? Up to you, but that's the full context! 👍 |
The following data-plane items need to be addressed. Validation has failed on the following readme list items.
tl;dr: Readmes should have at least have sections that correspond to the main sections as defined in the template readme.
This is what the tool checks, but the ideal scenario is the readme is reworked to be somewhat like the readme example.
For a rundown on what you need to do to resolve these breaking issues ASAP, check out aka.ms/azure-sdk-analyze-failed
Content Validation Items
23 readmes have at least one missing required section. Run
ward scan -d <repo root> -c <repo root>/eng/.docsettings.ymlto get the full list.Presence Validation Items
Warden detected there to be a missing readme in the below relative locations. These are much squishier than content verification, as there are real reasons for readmes not being present. Getting eyes on what
doc-wardenis ignoring is still good for awareness though. If a readme "missing" below is correct, feel free to remove the exception from the checklist.For the .NET repo, it is very difficult to tell what is actually missing, and what is missing due to repo structure. However, @mmacy was curious what we saw missing for .NET. The detected missing ones are below.
32 missing readmes detected at:
The text was updated successfully, but these errors were encountered: