Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Enhance npm documentation #282

Closed
nicolehaugen opened this issue Jun 27, 2017 · 1 comment
Closed

Enhance npm documentation #282

nicolehaugen opened this issue Jun 27, 2017 · 1 comment
Milestone

Comments

@nicolehaugen
Copy link
Member

nicolehaugen commented Jun 27, 2017

Consider the following improvements to the package documentation to help appeal to node.js devs:

1.) The "Getting Started" section points the dev to a general purpose walk-through for configuring AI; instead, there is a node.js specific one available that seems like it would be better to point devs to: https://docs.microsoft.com/en-us/azure/application-insights/app-insights-nodejs.

2.) The Node.js MSFT doc mentioned above does a really good job of emphasizing the value props of using AI in the first paragraph - the npm package documentation should do the same.

In particular, since node.js devs looking at this package may likely have their app hosted using a different cloud platform, an important point that the npm package documentation should emphasize is that "AI can be used for Node.js services hosted anywhere...even other public clouds". This helps to make it clear that our technologies are pluggable.

3.) To help with discoverability, the package tags should be revisited - for example, "tracing" and "telemetry" may be other keywords that would be beneficial to include.

@OsvaldoRosado
Copy link
Member

Great observations! Thanks for the feedback!

@AlexBulankou AlexBulankou added this to the 0.23.0 milestone Aug 18, 2017
@OsvaldoRosado OsvaldoRosado modified the milestones: 0.22.0, 0.23.0 Sep 6, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants