Skip to content

Commit f2fe50f

Browse files
authored
Clean up entries in docsettings.yml (Azure#15146)
We expect the readme files in each of the packages to follow a particular template. The docsettings.yml file is where we have added exceptions for this rule. The `omitted_paths` is for those readmes that intentionally do not follow this rule The `known_content_issues` is for those readmes that we believe should follow the rule and so there is a tracking issue to update it The `known_presence_issues` is for those readmes that dont exist but should This PR cleans up this file as follows: - Add Track 1 packages into the omitted path list. Since these are auto generated, they will not be following the rule - Add service level readmes into the omitted path list. /sdk/*/README.md - Use glob patterns when possible - Sort alphabetically
1 parent c5f7000 commit f2fe50f

File tree

1 file changed

+20
-90
lines changed

1 file changed

+20
-90
lines changed

eng/.docsettings.yml

Lines changed: 20 additions & 90 deletions
Original file line numberDiff line numberDiff line change
@@ -1,42 +1,28 @@
11
omitted_paths:
2+
- README.md
3+
- common/*
24
- documentation/ServicePrincipal/*
35
- eng/*
6+
- samples/*
7+
- sdk/*/README.md
8+
- sdk/**/samples-*/*
9+
- sdk/**/samples/*
10+
- sdk/**/swagger/*
11+
- sdk/**/test/**
412
- sdk/*/arm-*
513
- sdk/*/perf-tests/*
614
- sdk/appconfiguration/app-configuration/sample-react/README.md
7-
- sdk/core/README.md
15+
- sdk/applicationinsights/applicationinsights-query/README.md
16+
- sdk/batch/batch/README.md
817
- sdk/cognitiveservices/*
9-
- sdk/communication/*/test/README.md
10-
- sdk/identity/identity/test/manual/*
11-
- sdk/identity/identity/test/manual-integration/*
12-
- sdk/test-utils/perfstress/README.md
13-
- sdk/keyvault/*/test/README.md
14-
- sdk/keyvault/README.md
15-
- sdk/keyvault/keyvault-common/*
16-
- sdk/appconfiguration/*/test/README.md
17-
- sdk/eventhub/*/test/README.md
18-
- sdk/eventhub/README.md
19-
- sdk/search/*/test/README.md
20-
- sdk/servicebus/*/test/README.md
21-
- sdk/servicebus/README.md
22-
- sdk/servicebus/service-bus/test/perf-js-libs/service-bus-*
23-
- sdk/servicebus/service-bus/test/perf/**
24-
- sdk/servicebus/service-bus/test/stress/*
25-
- sdk/web-pubsub/web-pubsub-express/README.md
26-
- sdk/eventhub/event-hubs/test/perf/track-1/*
27-
- sdk/eventhub/event-hubs/test/perf/track-2/*
28-
- sdk/schemaregistry/README.md
29-
- sdk/storage/*/test/README.md
30-
- sdk/storage/README.md
18+
- sdk/core/README.md
19+
- sdk/eventhub/event-processor-host/README.md
20+
- sdk/graphrbac/graph/README.md
21+
- sdk/operationalinsights/loganalytics/README.md
22+
- sdk/servicefabric/servicefabric/README.md
23+
- sdk/storage/storage-datalake/README.md
3124
- sdk/storage/storage-internal-avro/*
32-
- sdk/storage/*/test/perfstress/track-1/*
33-
- sdk/storage/*/test/perfstress/track-2/*
34-
- sdk/textanalytics/*/test/README.md
35-
- sdk/**/samples/*
36-
- sdk/**/samples-*/*
37-
- sdk/**/swagger/*
38-
- common/*
39-
- samples/*
25+
- sdk/test-utils/perfstress/README.md
4026
language: js
4127
root_check_enabled: True
4228
required_readme_sections:
@@ -49,74 +35,18 @@ required_readme_sections:
4935
- ^Contributing$
5036

5137
known_content_issues:
52-
- ["README.md",  "#1583"]
53-
- ["sdk/appconfiguration/app-configuration/README.md",  "#1583"]
54-
- ["sdk/applicationinsights/applicationinsights-query/README.md",  "#1583"]
55-
- ["sdk/batch/batch/README.md",  "#1583"]
56-
- [
57-
"sdk/cognitiveservices/cognitiveservices-anomalydetector/README.md",
58-
 "#1583",
59-
]
60-
- ["sdk/cognitiveservices/cognitiveservices-autosuggest/README.md",  "#Azure/autorest.typescript#895"]
61-
- [
62-
"sdk/cognitiveservices/cognitiveservices-computervision/README.md",
63-
 "#Azure/autorest.typescript#895",
64-
]
65-
- [
66-
"sdk/cognitiveservices/cognitiveservices-contentmoderator/README.md",
67-
 "#Azure/autorest.typescript#895",
68-
]
69-
- [
70-
"sdk/cognitiveservices/cognitiveservices-customimagesearch/README.md",
71-
 "#Azure/autorest.typescript#895",
72-
]
73-
- ["sdk/cognitiveservices/cognitiveservices-customsearch/README.md",  "#Azure/autorest.typescript#895"]
74-
- [
75-
"sdk/cognitiveservices/cognitiveservices-customvision-prediction/README.md",
76-
 "#Azure/autorest.typescript#895",
77-
]
78-
- [
79-
"sdk/cognitiveservices/cognitiveservices-customvision-training/README.md",
80-
 "#Azure/autorest.typescript#895",
81-
]
82-
- ["sdk/cognitiveservices/cognitiveservices-entitysearch/README.md",  "#Azure/autorest.typescript#895"]
83-
- ["sdk/cognitiveservices/cognitiveservices-face/README.md",  "#Azure/autorest.typescript#895"]
84-
- ["sdk/cognitiveservices/cognitiveservices-imagesearch/README.md",  "#Azure/autorest.typescript#895"]
85-
- ["sdk/cognitiveservices/cognitiveservices-localsearch/README.md",  "#Azure/autorest.typescript#895"]
86-
- [
87-
"sdk/cognitiveservices/cognitiveservices-luis-authoring/README.md",
88-
 "#Azure/autorest.typescript#895",
89-
]
90-
- ["sdk/cognitiveservices/cognitiveservices-luis-runtime/README.md",  "#Azure/autorest.typescript#895"]
91-
- ["sdk/cognitiveservices/cognitiveservices-newssearch/README.md",  "#Azure/autorest.typescript#895"]
92-
- ["sdk/cognitiveservices/cognitiveservices-qnamaker/README.md",  "#Azure/autorest.typescript#895"]
93-
- ["sdk/cognitiveservices/cognitiveservices-spellcheck/README.md",  "#Azure/autorest.typescript#895"]
94-
- [
95-
"sdk/cognitiveservices/cognitiveservices-textanalytics/README.md",
96-
 "#Azure/autorest.typescript#895",
97-
]
98-
- ["sdk/cognitiveservices/cognitiveservices-videosearch/README.md",  "#Azure/autorest.typescript#895"]
99-
- ["sdk/cognitiveservices/cognitiveservices-visualsearch/README.md",  "#Azure/autorest.typescript#895"]
100-
- ["sdk/cognitiveservices/cognitiveservices-websearch/README.md",  "#Azure/autorest.typescript#895"]
10138
- ["sdk/core/abort-controller/README.md",  "#14714"]
10239
- ["sdk/core/core-amqp/README.md",  "#14715"]
10340
- ["sdk/core/core-auth/README.md",  "#14716"]
10441
- ["sdk/core/core-tracing/README.md",  "#14725"]
10542
- ["sdk/core/logger/README.md",  "#14726"]
106-
- ["sdk/cosmosdb/cosmos/test/readme.md",  "azure-sdk-tools/issues/1530"]
10743
- ["sdk/eventhub/event-processor-host/README.md",  "#14727"]
10844
- ["sdk/eventhub/mock-hub/README.md",  "azure-sdk-tools/issues/1530"]
109-
- ["sdk/graphrbac/graph/README.md",  "#deprecated"]
110-
- ["sdk/operationalinsights/loganalytics/README.md",  "#14729"]
111-
- ["sdk/servicebus/service-bus/test/README.md",  "azure-sdk-tools/issues/1530"]
112-
- ["sdk/servicefabric/servicefabric/README.md",  "#14732"]
113-
- ["sdk/storage/storage-datalake/README.md",  "#14731"]
114-
- ["sdk/storage/storage-blob/test/README.md",  "azure-sdk-tools/issues/1530"]
115-
- ["sdk/storage/storage-file-datalake/test/README.md",  "azure-sdk-tools/issues/1530"]
116-
- ["sdk/storage/storage-file-share/test/README.md",  "azure-sdk-tools/issues/1530"]
117-
- ["sdk/storage/storage-queue/test/README.md",  "azure-sdk-tools/issues/1530"]
11845
- ["sdk/test-utils/multi-version/README.md", "#14728"]
11946

47+
known_presence_issues:
48+
- ["sdk/keyvault/keyvault-common/README.md",  "#15587"]
49+
12050
package_indexing_exclusion_list:
12151
- "@azure/template"
12252
- "azure-sp"

0 commit comments

Comments
 (0)