Update readme.md with global template #4211
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
We're working toward consistent readmes across all the language repos. This PR implements the necessary changes. Couple interesting points: * I've put a new stack overflow tag in here - azure-sdk-js. The old one (azure-node-sdk) seemed possibly confusing in light of browser support landing in a number of packages. * I've opted NOT to document minimum requirements and getting started steps like configuring typescript - these will likely be library-specific and I don't want stale information.
kaerm
approved these changes
Jul 8, 2019
JonathanGiles
approved these changes
Jul 8, 2019
|
/cc @ramya-rao-a can you review this quick? |
ramya-rao-a
suggested changes
Jul 9, 2019
README.md
Outdated
|
|
||
| - ARM based services (`@azure/arm-<serviceName>`) | ||
| - data plane SDKs like `@azure/batch`, `@azure/graph`, etc. | ||
| This repository contains official JavaScript libraries for Azure services. For documentation go to [Azure SDK for JavaScript documentation](https://aka.ms/js-docs). |
There was a problem hiding this comment.
We have had feedback from existing customers regarding the confusion between the libraries from azure-sdk-for-node repo and this one.
We can benefit from having a line here on how this repo is different from the old one and link to the migration guide.
ramya-rao-a
reviewed
Jul 9, 2019
ramya-rao-a
reviewed
Jul 9, 2019
ramya-rao-a
approved these changes
Jul 9, 2019
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
We're working toward consistent readmes across all the language repos. This PR implements the necessary changes.
Couple interesting points: