Skip to content

Commit

Permalink
Scrub custom-words.txt for non-words and descriptions for more inclus…
Browse files Browse the repository at this point in the history
…ive terminology (Azure#21069)

* Delete term AADP from custom-words as its not a commonly known acronym.

* Delete term 'accountid' from custom-words.txt. You should use proper casing and spacing according to context, such as 'AccountId', 'accountId', 'accountID', 'account ID', or so on, instead.

* Delete a whole lot of terms that don't seem to be used anywhere in the specification folder according to a cursory search.

* Delete many duplicates from custom-words.txt

* Use cSpell.json to quarantine away some misspelled words from custom-words.txt. And remove duplicates of PPSX and PPTM.

* 'Mwarev' should not be a word. Terms like 'VMwarevSphere' 'vmware', 'vSphere' should be words instead.

* Using cSpell and custom-words better. 'targetv' should not be a custom word in order to allow 'targetvCenterId'.

* Actually remove UNKNOWON from custom-words now that it has a cSpell.json exception.

* Updation is not a real word.

* Sort 'vcenters'

* Expand away the nonstandard capitalized acronym Vrops from old documentation,

* Noreuse isn't a proper word, so making it a cSpell exception.

* Sort 'cadl'

* Retire some references to whitelists from documentation.

* Replace */* with **
  • Loading branch information
TimLovellSmith authored and kayousef committed Dec 21, 2022
1 parent 5ad74ef commit a69a307
Show file tree
Hide file tree
Showing 27 changed files with 73 additions and 45 deletions.
36 changes: 32 additions & 4 deletions cSpell.json
Original file line number Diff line number Diff line change
Expand Up @@ -164,6 +164,12 @@
"Ochestrator"
]
},
{
"filename": "**/specification/containerservice/resource-manager/Microsoft.ContainerInstance/stable/2021-10-01/containerInstance.json",
"words": [
"Noreuse"
]
},
{
"filename": "**/specification/containerregistry/data-plane/Microsoft.ContainerRegistry/preview/2018-08-10/containerregistry.json",
"words": [
Expand Down Expand Up @@ -758,6 +764,7 @@
"psqldb"
]
},

{
"filename": "**/specification/maps/data-plane/Microsoft.Maps/Render/preview/1.0/render.json",
"words": [
Expand Down Expand Up @@ -820,22 +827,29 @@
]
},
{
"filename": "**/specification/web/resource-manager/Microsoft.Web/stable/2020-12-01/CommonDefinitions.json",
"filename": "**/specification/web/resource-manager/Microsoft.Web/**/CommonDefinitions.json",
"words": [
"Guage"
]
},
{
"filename": "**/specification/confluent/resource-manager/Microsoft.Confluent/*/*/confluent.json",
"filename": "**/specification/confluent/resource-manager/Microsoft.Confluent/**/confluent.json",
"words": [
"orgvalidate"
]
},
{
"filename": "**/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2021-02-10/service.json",
"filename": "**/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/**/service.json",
"words": [
"Orignal",
"Seleted"
"Seleted",
"targetvCenterId"
]
},
{
"filename": "**/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/**/bms.json",
"words": [
"xcool"
]
},
{
Expand All @@ -851,6 +865,20 @@
"spreadsheetml",
"presentationml"
]
},
{
"filename": "**/specification/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2019-*/modelManagement.json",
"words": [
"UNKNOWON"
]
},
{
"filename": "**/specification/machinelearningservices/data-plane/Microsoft.MachineLearningServices/preview/2022-*-preview/machineLearningServices.json",
"words": [
"Tmpfs",
"tmpfs",
"npipe"
]
}
],
"enableFiletypes": [
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3377,7 +3377,7 @@
"tags": [
"Services"
],
"description": "Checks if the tenant, to which a service is registered, is whitelisted to use a feature.",
"description": "Checks if the tenant, to which a service is registered, is listed as allowed to use a feature.",
"x-ms-examples": {
"services_getTenantWhitelisting": {
"$ref": "./examples/TenantWhitelisting.json"
Expand Down Expand Up @@ -3405,7 +3405,7 @@
],
"responses": {
"200": {
"description": "Indicates if a tenant is whitelisted for a feature or not.",
"description": "Indicates if a tenant is listed as allowed for a feature or not.",
"schema": {
"$ref": "#/definitions/Result"
}
Expand Down Expand Up @@ -5503,7 +5503,7 @@
"type": "string"
},
"isWhitelistedIpAddress": {
"description": "A value indicating whether the IP address has been whitelisted.",
"description": "A value indicating whether the IP address has been listed as allowed.",
"type": "boolean"
},
"networkLocation": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3785,7 +3785,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
"description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
"description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3829,7 +3829,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
"description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
"description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4033,7 +4033,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
"description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
"description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4000,7 +4000,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
"description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
"description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4245,7 +4245,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
"description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
"description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4246,7 +4246,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
"description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
"description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4251,7 +4251,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
"description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
"description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4397,7 +4397,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
"description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
"description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4493,7 +4493,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
"description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
"description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4529,7 +4529,7 @@
"enableNamespaceResources": {
"type": "boolean",
"title": "Enable namespace as Azure resource.",
"description": "The default value is false. It can be enabled/disabled on creation and updation of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
"description": "The default value is false. It can be enabled/disabled on creation and updating of the managed cluster. See [https://aka.ms/NamespaceARMResource](https://aka.ms/NamespaceARMResource) for more details on Namespace as a ARM Resource."
},
"networkProfile": {
"$ref": "#/definitions/ContainerServiceNetworkProfile",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -505,7 +505,7 @@
"properties": {
"path": {
"type": "string",
"description": "The full path to whitelist",
"description": "The full path to the application to allow",
"example": "C:\\Windows\\System32\\calc.exe"
},
"action": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -951,7 +951,7 @@
}
},
"clientCertificateCommonNames": {
"description": "List of client certificates to whitelist based on common names.",
"description": "List of client certificates to trust based on common names.",
"type": "array",
"items": {
"$ref": "#/definitions/ClientCertificateCommonName"
Expand Down Expand Up @@ -1053,7 +1053,7 @@
}
},
"clientCertificateCommonNames": {
"description": " List of client certificates to whitelist based on common names",
"description": " List of client certificates to trust based on common names",
"type": "array",
"items": {
"$ref": "#/definitions/ClientCertificateCommonName"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -3016,7 +3016,7 @@
}
},
"vrOpsEnabled": {
"description": "Is Vrops enabled/disabled",
"description": "Is vRealize Operations Manager enabled/disabled",
"type": "boolean"
}
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,7 @@
}
},
"userWhitelistedIpRanges": {
"description": "User added ip ranges to whitelist on ASE db",
"description": "User added list of IP Ranges allowed on ASE db",
"type": "array",
"items": {
"type": "string"
Expand Down Expand Up @@ -1341,7 +1341,7 @@
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"description": "Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,7 @@
}
},
"userWhitelistedIpRanges": {
"description": "User added ip ranges to whitelist on ASE db",
"description": "User added list of IP Ranges allowed on ASE db",
"type": "array",
"items": {
"type": "string"
Expand Down Expand Up @@ -1579,7 +1579,7 @@
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"description": "Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -255,7 +255,7 @@
}
},
"userWhitelistedIpRanges": {
"description": "User added ip ranges to whitelist on ASE db",
"description": "User added list of IP Ranges allowed on ASE db",
"type": "array",
"items": {
"type": "string"
Expand Down Expand Up @@ -1506,7 +1506,7 @@
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"description": "Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@
}
},
"userWhitelistedIpRanges": {
"description": "User added ip ranges to whitelist on ASE db",
"description": "User added list of IP Ranges allowed on ASE db",
"type": "array",
"items": {
"type": "string"
Expand Down Expand Up @@ -1527,7 +1527,7 @@
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"description": "Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@
}
},
"userWhitelistedIpRanges": {
"description": "User added ip ranges to whitelist on ASE db",
"description": "User added list of IP Ranges allowed on ASE db",
"type": "array",
"items": {
"type": "string"
Expand Down Expand Up @@ -1531,7 +1531,7 @@
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"description": "Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -256,7 +256,7 @@
}
},
"userWhitelistedIpRanges": {
"description": "User added ip ranges to whitelist on ASE db",
"description": "User added list of IP Ranges allowed on ASE db",
"type": "array",
"items": {
"type": "string"
Expand Down Expand Up @@ -1531,7 +1531,7 @@
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"description": "Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
}
},
"userWhitelistedIpRanges": {
"description": "User added ip ranges to whitelist on ASE db",
"description": "User added list of IP Ranges allowed on ASE db",
"type": "array",
"items": {
"type": "string"
Expand Down Expand Up @@ -1823,7 +1823,7 @@
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"description": "Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
}
},
"userWhitelistedIpRanges": {
"description": "User added ip ranges to whitelist on ASE db",
"description": "User added list of IP Ranges allowed on ASE db",
"type": "array",
"items": {
"type": "string"
Expand Down Expand Up @@ -1844,7 +1844,7 @@
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"description": "Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@
}
},
"userWhitelistedIpRanges": {
"description": "User added ip ranges to whitelist on ASE db",
"description": "User added list of IP Ranges allowed on ASE db",
"type": "array",
"items": {
"type": "string"
Expand Down Expand Up @@ -1845,7 +1845,7 @@
"type": "boolean"
},
"tagWhitelistJson": {
"description": "Gets or sets a JSON string containing a list of tags that are whitelisted for use by the push registration endpoint.",
"description": "Gets or sets a JSON string containing a list of tags that are in the allowed list for use by the push registration endpoint.",
"type": "string"
},
"tagsRequiringAuth": {
Expand Down
Loading

0 comments on commit a69a307

Please sign in to comment.