Skip to content

Latest commit

 

History

History
33 lines (17 loc) · 747 Bytes

avoid-msdn-references.md

File metadata and controls

33 lines (17 loc) · 747 Bytes

AvoidMsdnReferences

Category

SDK Warning

Applies to

ARM and Data plane OpenAPI(swagger) specs

Output Message

For better generated code quality, remove all references to "msdn.microsoft.com".

Description

The documentation is being generated from the OpenAPI(swagger) and published at "docs.microsoft.com". From that perspective, documentation team would like to avoid having links to the "msdn.microsoft.com" in the OpenAPI(swagger) and SDK documentations.

Why the rule is important

Facilitate decoupling of "msdn.microsoft.com" from "docs.microsoft.com".

How to fix the violation

Please avoid using references to "msdn.microsoft.com" in title and descriptions.

Impact on generated code

N/A.

Examples

N/A.