search

Azure / azure-sdk-for-java

This repository is for active development of the Azure SDK for Java. For consumers of the SDK we recommend visiting our public developer docs at https://docs.microsoft.com/java/azure/ or our versioned developer docs at https://azure.github.io/azure-sdk-for-java.
MIT License
2.34k stars 1.98k forks source link

Readme Content Verification - need to format readmes to match template doc #3113

Closed scbedd closed 2 years ago

scbedd commented 5 years ago

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

12 readmes have at least one missing required section.

(the items below have identical failures as the root readme as well, explicit list omitted for brevity)

Presence Verification 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-warden is ignoring is still good for awareness though. If a readme "missing" below is correct, feel free to remove the exception from the checklist.

alzimmermsft commented 2 years ago

Closing this as many of the README references are outdated and point to libraries that aren't being actively maintained. There are only a limited number of maintained libraries that have suppressions but those are for specialty, non-standard SDK scenarios such as framework implementations.