Move Readme and Changelog template from RST -> MD (Azure#9510)

* Move Readme and Changelog template from RST -> MD * Switch Management HISTORY.rst to CHANGELOG.md * Include .md in Manifest * Convert readmes and Update setup.py * Fix manifest.in and setup.py
w-javed · Feb 5, 2020 · f3743bf · f3743bf
1 parent ceb7197
commit f3743bf
Show file tree

Hide file tree

Showing 589 changed files with 15,719 additions and 14,515 deletions.
diff --git a/sdk/advisor/azure-mgmt-advisor/CHANGELOG.md b/sdk/advisor/azure-mgmt-advisor/CHANGELOG.md
@@ -0,0 +1,100 @@
+# Release History
+
+## 3.0.0 (2019-10-24)
+
+**Features**
+
+  - Added operation group RecommendationMetadataOperations
+
+**General Breaking Changes**
+
+This version uses a next-generation code generator that might introduce
+breaking changes if from some import. In summary, some modules were
+incorrectly visible/importable and have been renamed. This fixed several
+issues caused by usage of classes that were not supposed to be used in
+the first place. AdvisorManagementClient cannot be imported from
+azure.mgmt.advisor.advisor_management_client anymore (import from
+azure.mgmt.advisor works like before)
+AdvisorManagementClientConfiguration import has been moved from
+azure.mgmt.advisor.advisor_management_client to azure.mgmt.advisor A
+model MyClass from a "models" sub-module cannot be imported anymore
+using azure.mgmt.advisor.models.my_class (import from
+azure.mgmt.advisor.models works like before) An operation class
+MyClassOperations from an operations sub-module cannot be imported
+anymore using azure.mgmt.advisor.operations.my_class_operations
+(import from azure.mgmt.advisor.operations works like before) Last but
+not least, HTTP connection pooling is now enabled by default. You should
+always use a client as a context manager, or call close(), or use no
+more than one client per process.
+
+## 2.0.1 (2018-10-16)
+
+**Bugfix**
+
+  - Fix sdist broken in 2.0.0. No code change.
+
+## 2.0.0 (2018-10-15)
+
+**Features**
+
+  - Model ResourceRecommendationBase has a new parameter
+    extended_properties
+  - Client class can be used as a context manager to keep the underlying
+    HTTP session open for performance
+
+**General Breaking changes**
+
+This version uses a next-generation code generator that *might*
+introduce breaking changes.
+
+  - Model signatures now use only keyword-argument syntax. All
+    positional arguments must be re-written as keyword-arguments. To
+    keep auto-completion in most cases, models are now generated for
+    Python 2 and Python 3. Python 3 uses the "*" syntax for
+    keyword-only arguments.
+  - Enum types now use the "str" mixin (class AzureEnum(str, Enum)) to
+    improve the behavior when unrecognized enum values are encountered.
+    While this is not a breaking change, the distinctions are important,
+    and are documented here:
+    <https://docs.python.org/3/library/enum.html#others> At a glance:
+      - "is" should not be used at all.
+      - "format" will return the string value, where "%s" string
+        formatting will return `NameOfEnum.stringvalue`. Format syntax
+        should be prefered.
+  - New Long Running Operation:
+      - Return type changes from
+        `msrestazure.azure_operation.AzureOperationPoller` to
+        `msrest.polling.LROPoller`. External API is the same.
+      - Return type is now **always** a `msrest.polling.LROPoller`,
+        regardless of the optional parameters used.
+      - The behavior has changed when using `raw=True`. Instead of
+        returning the initial call result as `ClientRawResponse`,
+        without polling, now this returns an LROPoller. After polling,
+        the final resource will be returned as a `ClientRawResponse`.
+      - New `polling` parameter. The default behavior is
+        `Polling=True` which will poll using ARM algorithm. When
+        `Polling=False`, the response of the initial call will be
+        returned without polling.
+      - `polling` parameter accepts instances of subclasses of
+        `msrest.polling.PollingMethod`.
+      - `add_done_callback` will no longer raise if called after
+        polling is finished, but will instead execute the callback right
+        away.
+
+**Note**
+
+  - azure-mgmt-nspkg is not installed anymore on Python 3 (PEP420-based
+    namespace package)
+
+## 1.0.1 (2018-02-13)
+
+  - Fix list_by_subscription return type
+  - Fix list_by_resource_group return type
+
+## 1.0.0 (2018-01-16)
+
+  - GA Release
+
+## 0.1.0 (2017-11-06)
+
+  - Initial Release
diff --git a/sdk/advisor/azure-mgmt-advisor/HISTORY.rst b/sdk/advisor/azure-mgmt-advisor/HISTORY.rst
diff --git a/sdk/advisor/azure-mgmt-advisor/MANIFEST.in b/sdk/advisor/azure-mgmt-advisor/MANIFEST.in
@@ -1,5 +1,5 @@
 recursive-include tests *.py *.yaml
-include *.rst
+include *.md
 include azure/__init__.py
 include azure/mgmt/__init__.py
 
diff --git a/sdk/advisor/azure-mgmt-advisor/README.md b/sdk/advisor/azure-mgmt-advisor/README.md
@@ -0,0 +1,29 @@
+## Microsoft Azure SDK for Python
+
+This is the Microsoft Azure Advisor Client Library.
+
+Azure Resource Manager (ARM) is the next generation of management APIs
+that replace the old Azure Service Management (ASM).
+
+This package has been tested with Python 2.7, 3.5, 3.6 and 3.7.
+
+For the older Azure Service Management (ASM) libraries, see
+[azure-servicemanagement-legacy](https://pypi.python.org/pypi/azure-servicemanagement-legacy)
+library.
+
+For a more complete set of Azure libraries, see the
+[azure](https://pypi.python.org/pypi/azure) bundle package.
+
+## Usage
+
+For code examples, see
+[Advisor](https://docs.microsoft.com/python/api/overview/azure/advisor)
+on docs.microsoft.com.
+
+## Provide Feedback
+
+If you encounter any bugs or have suggestions, please file an issue in
+the [Issues](https://github.com/Azure/azure-sdk-for-python/issues)
+section of the project.
+
+![image](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fazure-mgmt-advisor%2FREADME.png)
diff --git a/sdk/advisor/azure-mgmt-advisor/README.rst b/sdk/advisor/azure-mgmt-advisor/README.rst
diff --git a/sdk/advisor/azure-mgmt-advisor/setup.py b/sdk/advisor/azure-mgmt-advisor/setup.py
@@ -43,17 +43,17 @@
 if not version:
     raise RuntimeError('Cannot find version information')
 
-with open('README.rst', encoding='utf-8') as f:
+with open('README.md', encoding='utf-8') as f:
     readme = f.read()
-with open('HISTORY.rst', encoding='utf-8') as f:
-    history = f.read()
+with open('CHANGELOG.md', encoding='utf-8') as f:
+    changelog = f.read()
 
 setup(
     name=PACKAGE_NAME,
     version=version,
     description='Microsoft Azure {} Client Library for Python'.format(PACKAGE_PPRINT_NAME),
-    long_description=readme + '\n\n' + history,
-    long_description_content_type='text/x-rst',
+    long_description=readme + '\n\n' + changelog,
+    long_description_content_type='text/markdown',
     license='MIT License',
     author='Microsoft Corporation',
     author_email='azpysdkhelp@microsoft.com',

diff --git a/sdk/aks/azure-mgmt-devspaces/CHANGELOG.md b/sdk/aks/azure-mgmt-devspaces/CHANGELOG.md
@@ -0,0 +1,20 @@
+# Release History
+
+## 0.2.0 (2019-05-23)
+
+**Features**
+
+  - Model ControllerUpdateParameters has a new parameter
+    target_container_host_credentials_base64
+  - Added operation group ContainerHostMappingsOperations
+
+**Breaking changes**
+
+  - Operation ControllersOperations.list_connection_details has a new
+    signature
+  - Operation ControllersOperations.update has a new signature
+  - Model ControllerConnectionDetails has a new signature
+
+## 0.1.0 (2018-07-12)
+
+  - Initial Release
diff --git a/sdk/aks/azure-mgmt-devspaces/HISTORY.rst b/sdk/aks/azure-mgmt-devspaces/HISTORY.rst
diff --git a/sdk/aks/azure-mgmt-devspaces/MANIFEST.in b/sdk/aks/azure-mgmt-devspaces/MANIFEST.in
@@ -1,5 +1,5 @@
 recursive-include tests *.py *.yaml
-include *.rst
+include *.md
 include azure/__init__.py
 include azure/mgmt/__init__.py
 
diff --git a/sdk/aks/azure-mgmt-devspaces/README.md b/sdk/aks/azure-mgmt-devspaces/README.md
@@ -0,0 +1,29 @@
+## Microsoft Azure SDK for Python
+
+This is the Microsoft Azure Dev Spaces Client Library.
+
+Azure Resource Manager (ARM) is the next generation of management APIs
+that replace the old Azure Service Management (ASM).
+
+This package has been tested with Python 2.7, 3.4, 3.5, 3.6 and 3.7.
+
+For the older Azure Service Management (ASM) libraries, see
+[azure-servicemanagement-legacy](https://pypi.python.org/pypi/azure-servicemanagement-legacy)
+library.
+
+For a more complete set of Azure libraries, see the
+[azure](https://pypi.python.org/pypi/azure) bundle package.
+
+## Usage
+
+For code examples, see [Dev
+Spaces](https://docs.microsoft.com/python/api/overview/azure/) on
+docs.microsoft.com.
+
+## Provide Feedback
+
+If you encounter any bugs or have suggestions, please file an issue in
+the [Issues](https://github.com/Azure/azure-sdk-for-python/issues)
+section of the project.
+
+![image](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fazure-mgmt-devspaces%2FREADME.png)
diff --git a/sdk/aks/azure-mgmt-devspaces/README.rst b/sdk/aks/azure-mgmt-devspaces/README.rst