Update azure-sdk-for-python root readme to common/consistent format #6240
Conversation
johanste
requested review from
bterlson,
lmazuel,
JonathanGiles,
KrzysztofCwalina and
kaerm
|
Can one of the admins verify this patch? |
README.md
Outdated
| ## Need help? | ||
| * For detailed documentation visit our [Azure SDK for Python documentation](aka.ms/python-docs) | ||
| * File an issue via [Github Issues](../../issues) | ||
| * Check [previous questions](https://stackoverflow.com/questions/tagged/azure-sdk-python) or ask new ones on StackOverflow using `azure-sdk-python` tag. |
There was a problem hiding this comment.
So far I was suggesting people to tag "azure" and "python", I never used the "azure-sdk-python". Do we want to mention it at least, or do we officially say we monitor only "azure-sdk-python" ?
There was a problem hiding this comment.
If we have been using "azure" and "python" then we can continue using that or at least tell people about it. I thought it'd be easier if we had a tag but I guess there is no point in introducing additional complexity
There was a problem hiding this comment.
Updated to:
* Check [previous questions](https://stackoverflow.com/questions/tagged/azure+python) or ask new ones on StackOverflow using `azure` and `python` tags.
|
|
||
|
|
||
| ### Client: Stable | ||
| Last stable versions of packages that have been provided for usage with Azure and are production-ready. These libraries provide you with similar functionalities to the Preview ones as they allow you to use and consume existing resources and interact with them, for example: upload a blob. |
There was a problem hiding this comment.
Like you did for preview I would list the 5 top used (storage, etc.) with explicit link to the external repos.
| Last stable versions of packages that have been provided for usage with Azure and are production-ready. These libraries provide you with similar functionalities to the Preview ones as they allow you to use and consume existing resources and interact with them, for example: upload a blob. | ||
|
|
||
| ### Management | ||
| Libraries which enable you to provision specific resources. They are responsible for directly mirroring and consuming Azure service's REST endpoints. The management libraries use the `azure-mgmt-<service name>` convention for their package names. |
There was a problem hiding this comment.
I would list the top 5 with overview of scenarios (compute: VM, network: subnet, etc.)
| You can find service libraries in the `/sdk` directory. | ||
|
|
||
| ### Prerequisites | ||
| The client libraries are supported on Python 2.7 and 3.5.3 or later. |
There was a problem hiding this comment.
We officially kill PyPy support? Or at least a sentence that universal packages will work on PyPy ? (I understand uamqp and subsequent won't for instance)
We test PyPy on DevOps
There was a problem hiding this comment.
Would you expect PyPy to be called out explicitly here? I didn't call out CPython... Btw, the existing README.rst does not call out PyPy explicitly...
There was a problem hiding this comment.
Ok, I get your point. Then we lie a little, if someone asks for azure-servicebus support arguing that we say we support 3.5.3 and later, what is the answer then? Valid bug? Valid feature request? Not gonna happen?
If you suggest this sentence says "Whatever Python implementation that is compatible with 2.7 and 3.5.3 and higher is supported", then that's not actually true :(. I could just mention Jython or IronPython, etc.
There was a problem hiding this comment.
Note: I'm not suggesting blocking your PR for this point, I just feel it deserves discussion and there is possible issue opened by people that we should at least be prepared to answer.
There was a problem hiding this comment.
If it is controversial or not consistent across different libraries then we can remove this section
There was a problem hiding this comment.
I'm comfortable with this statement.
| You can find service libraries in the `/sdk` directory. | ||
|
|
||
| ### Prerequisites | ||
| The client libraries are supported on Python 2.7 and 3.5.3 or later. |
There was a problem hiding this comment.
If it is controversial or not consistent across different libraries then we can remove this section
README.md
Outdated
| ## Need help? | ||
| * For detailed documentation visit our [Azure SDK for Python documentation](aka.ms/python-docs) | ||
| * File an issue via [Github Issues](../../issues) | ||
| * Check [previous questions](https://stackoverflow.com/questions/tagged/azure-sdk-python) or ask new ones on StackOverflow using `azure-sdk-python` tag. |
There was a problem hiding this comment.
If we have been using "azure" and "python" then we can continue using that or at least tell people about it. I thought it'd be easier if we had a tag but I guess there is no point in introducing additional complexity
No description provided.