Merge pull request #5472 from scbedd/content-verification-docsettings

Enabling Content Verification

.azure-pipelines/client.yml

@@ -44,6 +44,17 @@ jobs:
       vmImage: 'vs2017-win2016'
 
     steps:
+      - task: UsePythonVersion@0
+        displayName: 'Use Python 3.6'
+        inputs:
+          versionSpec: '3.6'
+
+      - script: |
+          pip install setuptools wheel 
+          pip install doc-warden
+          ward scan -d $(Build.SourcesDirectory) -c $(Build.SourcesDirectory)/eng/.docsettings.yml
+        displayName: 'Verify Readmes'
+      
       - task: DownloadBuildArtifacts@0
         displayName: 'Download Build Artifacts'
         condition: and(succeededOrFailed(), ne(variables['Build.Reason'],'PullRequest'))

eng/.docsettings.yml

@@ -0,0 +1,19 @@
+omitted_paths:
+  - archive/*
+  - eng/*
+  - tools/*
+  - src/*
+  - Documentation/*
+language: net
+root_check_enabled: True
+required_readme_sections:
+  - "Azure .+ client library for .NET"
+  - ^Getting started$
+  - ^Key concepts$
+  - ^Examples$
+  - ^Troubleshooting$
+  - ^Next steps$
+  - ^Contributing$
+known_presence_issues:
+known_content_issues:
+  - ['README.md','Root readme']

sdk/template/Azure.Template/README.md

@@ -93,6 +93,10 @@ If the package or a related package supports it, include tips for logging or ena
 * If appropriate, point users to other packages that might be useful.
 * If you think there's a good chance that developers might stumble across your package in error (because they're searching for specific functionality and mistakenly think the package provides that functionality), point them to the packages they might be looking for.
 
+## Contributing
+
+This is a template, but your SDK readme should include details on how to contribute code to the repo/package.
+
 <!-- LINKS -->
 [style-guide-msft]: https://docs.microsoft.com/style-guide/capitalization
 [style-guide-cloud]: https://worldready.cloudapp.net/Styleguide/Read?id=2696&topicid=25357