Update the readme files.

hightoon · Aug 21, 2015 · e946022 · e946022
1 parent 5857736
commit e946022
Show file tree

Hide file tree

Showing 13 changed files with 290 additions and 82 deletions.
diff --git a/README.rst b/README.rst
@@ -34,7 +34,7 @@ Features
 Installation
 ============
 
-To install a bundle that includes all of the Azure client libraries listed above, see the `Azure bundle package <>`__.
+To install a bundle that includes all of the Azure client libraries listed above, see the `Azure bundle package <https://github.com/Azure/azure-sdk-for-python/tree/master/azure>`__.
 
 
 Usage

diff --git a/azure-common/README.rst b/azure-common/README.rst
@@ -6,4 +6,4 @@ This is the Microsoft Azure common code.
 This package provides shared code by the Azure packages.
 
 If you are looking to install the Azure client libraries, see the
-`Azure <https://pypi.python.org/pypi/azure>`__ bundle package.
+`azure <https://pypi.python.org/pypi/azure>`__ bundle package.
diff --git a/azure-mgmt-common/README.rst b/azure-mgmt-common/README.rst
@@ -6,4 +6,4 @@ This is the Microsoft Azure Resource Management common code.
 This package provides shared code by the Azure Management packages.
 
 If you are looking to install the Azure client libraries, see the
-`Azure <https://pypi.python.org/pypi/azure>`__ bundle package.
+`azure <https://pypi.python.org/pypi/azure>`__ bundle package.
diff --git a/azure-mgmt-compute/README.rst b/azure-mgmt-compute/README.rst
@@ -6,27 +6,50 @@ This is the Microsoft Azure Compute Resource Management 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.3 and 3.4.
+
+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.
+
+
+Compatibility
+=============
+
+**IMPORTANT**: If you have an earlier version of the azure package
+(version < 1.0), you should uninstall it before installing this package.
+
+You can check the version using pip:
+
+.. code:: shell
+
+    pip freeze
+
+If you see azure==0.11.0 (or any version below 1.0), uninstall it first:
+
+.. code:: shell
+
+    pip uninstall azure
+
 
 This is a preview release
 =========================
 
-The ARM libraries are being released as a preview, to gather feedback.
+The ARM libraries are being released as a preview, to solicit feedback.
 
-**Future releases of this library are subject to breaking changes**.
+**Future releases are subject to breaking changes**.
 
-We are working on a new Python REST API code generator, which will replace
-our existing code generator. The extent of the breaking changes is unknown
-at this time.
+The Python code generator used to create this version of the ARM
+libraries is being replaced, and may not generate code that is compatible
+with this version of the ARM libraries.
 
 Although future revisions will likely have breaking changes, the ARM concepts
 along with the REST APIs that the library is wrapping should remain the same.
 
 Please try the libraries and give us feedback, which we can incorporate into
 future versions.
 
-If you prefer to use the old Azure Service Management APIs, see the
-`azure-servicemanagement-legacy <https://pypi.python.org/pypi/azure-servicemanagement-legacy>`__ library.
-
 
 Usage
 =====
@@ -43,11 +66,14 @@ for examples on using the ARM APIs.
 Authentication
 --------------
 
-Authentication with ARM is done via tokens (certificates are not supported).
+Authentication with ARM is done via tokens.
 
-You can use the `ADAL <https://pypi.python.org/pypi/azure>`__ library to
+You can use the `ADAL <https://pypi.python.org/pypi/adal>`__ library to
 obtain authentication tokens.
 
+TODO: Link to documentation on how to setup AAD.
+TODO: Code example for alternative to ADAL.
+
 
 Provide Feedback
 ================

diff --git a/azure-mgmt-network/README.rst b/azure-mgmt-network/README.rst
@@ -6,27 +6,50 @@ This is the Microsoft Azure Network Resource Management 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.3 and 3.4.
+
+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.
+
+
+Compatibility
+=============
+
+**IMPORTANT**: If you have an earlier version of the azure package
+(version < 1.0), you should uninstall it before installing this package.
+
+You can check the version using pip:
+
+.. code:: shell
+
+    pip freeze
+
+If you see azure==0.11.0 (or any version below 1.0), uninstall it first:
+
+.. code:: shell
+
+    pip uninstall azure
+
 
 This is a preview release
 =========================
 
-The ARM libraries are being released as a preview, to gather feedback.
+The ARM libraries are being released as a preview, to solicit feedback.
 
-**Future releases of this library are subject to breaking changes**.
+**Future releases are subject to breaking changes**.
 
-We are working on a new Python REST API code generator, which will replace
-our existing code generator. The extent of the breaking changes is unknown
-at this time.
+The Python code generator used to create this version of the ARM
+libraries is being replaced, and may not generate code that is compatible
+with this version of the ARM libraries.
 
 Although future revisions will likely have breaking changes, the ARM concepts
 along with the REST APIs that the library is wrapping should remain the same.
 
 Please try the libraries and give us feedback, which we can incorporate into
 future versions.
 
-If you prefer to use the old Azure Service Management APIs, see the
-`azure-servicemanagement-legacy <https://pypi.python.org/pypi/azure-servicemanagement-legacy>`__ library.
-
 
 Usage
 =====
@@ -43,11 +66,14 @@ for examples on using the ARM APIs.
 Authentication
 --------------
 
-Authentication with ARM is done via tokens (certificates are not supported).
+Authentication with ARM is done via tokens.
 
-You can use the `ADAL <https://pypi.python.org/pypi/azure>`__ library to
+You can use the `ADAL <https://pypi.python.org/pypi/adal>`__ library to
 obtain authentication tokens.
 
+TODO: Link to documentation on how to setup AAD.
+TODO: Code example for alternative to ADAL.
+
 
 Provide Feedback
 ================

diff --git a/azure-mgmt-nspkg/README.rst b/azure-mgmt-nspkg/README.rst
@@ -1,11 +1,11 @@
 Microsoft Azure SDK for Python
 ==============================
 
-This is the Microsoft Azure Management core.
+This is the Microsoft Azure Management namespace package.
 
 This package is not intended to be installed directly by the end user.
 
 It provides the necessary files for other packages to extend the azure.mgmt namespace.
 
 If you are looking to install the Azure client libraries, see the
-`Azure <https://pypi.python.org/pypi/azure>`__ bundle package.
+`azure <https://pypi.python.org/pypi/azure>`__ bundle package.
diff --git a/azure-mgmt-resource/README.rst b/azure-mgmt-resource/README.rst
@@ -6,27 +6,50 @@ This is the Microsoft Azure Resource Management 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.3 and 3.4.
+
+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.
+
+
+Compatibility
+=============
+
+**IMPORTANT**: If you have an earlier version of the azure package
+(version < 1.0), you should uninstall it before installing this package.
+
+You can check the version using pip:
+
+.. code:: shell
+
+    pip freeze
+
+If you see azure==0.11.0 (or any version below 1.0), uninstall it first:
+
+.. code:: shell
+
+    pip uninstall azure
+
 
 This is a preview release
 =========================
 
-The ARM libraries are being released as a preview, to gather feedback.
+The ARM libraries are being released as a preview, to solicit feedback.
 
-**Future releases of this library are subject to breaking changes**.
+**Future releases are subject to breaking changes**.
 
-We are working on a new Python REST API code generator, which will replace
-our existing code generator. The extent of the breaking changes is unknown
-at this time.
+The Python code generator used to create this version of the ARM
+libraries is being replaced, and may not generate code that is compatible
+with this version of the ARM libraries.
 
 Although future revisions will likely have breaking changes, the ARM concepts
 along with the REST APIs that the library is wrapping should remain the same.
 
 Please try the libraries and give us feedback, which we can incorporate into
 future versions.
 
-If you prefer to use the old Azure Service Management APIs, see the
-`azure-servicemanagement-legacy <https://pypi.python.org/pypi/azure-servicemanagement-legacy>`__ library.
-
 
 Usage
 =====
@@ -43,11 +66,14 @@ for examples on using the ARM APIs.
 Authentication
 --------------
 
-Authentication with ARM is done via tokens (certificates are not supported).
+Authentication with ARM is done via tokens.
 
-You can use the `ADAL <https://pypi.python.org/pypi/azure>`__ library to
+You can use the `ADAL <https://pypi.python.org/pypi/adal>`__ library to
 obtain authentication tokens.
 
+TODO: Link to documentation on how to setup AAD.
+TODO: Code example for alternative to ADAL.
+
 
 Provide Feedback
 ================

diff --git a/azure-mgmt-storage/README.rst b/azure-mgmt-storage/README.rst
@@ -6,27 +6,50 @@ This is the Microsoft Azure Storage Resource Management 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.3 and 3.4.
+
+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.
+
+
+Compatibility
+=============
+
+**IMPORTANT**: If you have an earlier version of the azure package
+(version < 1.0), you should uninstall it before installing this package.
+
+You can check the version using pip:
+
+.. code:: shell
+
+    pip freeze
+
+If you see azure==0.11.0 (or any version below 1.0), uninstall it first:
+
+.. code:: shell
+
+    pip uninstall azure
+
 
 This is a preview release
 =========================
 
-The ARM libraries are being released as a preview, to gather feedback.
+The ARM libraries are being released as a preview, to solicit feedback.
 
-**Future releases of this library are subject to breaking changes**.
+**Future releases are subject to breaking changes**.
 
-We are working on a new Python REST API code generator, which will replace
-our existing code generator. The extent of the breaking changes is unknown
-at this time.
+The Python code generator used to create this version of the ARM
+libraries is being replaced, and may not generate code that is compatible
+with this version of the ARM libraries.
 
 Although future revisions will likely have breaking changes, the ARM concepts
 along with the REST APIs that the library is wrapping should remain the same.
 
 Please try the libraries and give us feedback, which we can incorporate into
 future versions.
 
-If you prefer to use the old Azure Service Management APIs, see the
-`azure-servicemanagement-legacy <https://pypi.python.org/pypi/azure-servicemanagement-legacy>`__ library.
-
 
 Usage
 =====
@@ -43,11 +66,14 @@ for examples on using the ARM APIs.
 Authentication
 --------------
 
-Authentication with ARM is done via tokens (certificates are not supported).
+Authentication with ARM is done via tokens.
 
-You can use the `ADAL <https://pypi.python.org/pypi/azure>`__ library to
+You can use the `ADAL <https://pypi.python.org/pypi/adal>`__ library to
 obtain authentication tokens.
 
+TODO: Link to documentation on how to setup AAD.
+TODO: Code example for alternative to ADAL.
+
 
 Provide Feedback
 ================