README update for packages #771
Conversation
| @@ -1,11 +1,193 @@ | |||
| # `@microsoft/msgraph-sdk` | |||
| # Microsoft Graph SDK for Typescript | |||
There was a problem hiding this comment.
This is a copy of the root README
There was a problem hiding this comment.
I'd advise against keeping a duplicate copy - it increases the likelihood of them getting out of sync. If you do decide to keep it, all the notes I made on the root README apply ;)
There was a problem hiding this comment.
primary reason is because we will not be able to get the documentation in npm if we do not have a README, @baywet what are your thoughts, should we keep this one?
There was a problem hiding this comment.
@jasonjoh the problem we're trying to solve is that the package page on npm is empty. https://www.npmjs.com/package/@microsoft/msgraph-sdk-users
We could alternative maintain a template, at a central location and have a script that copies the file before npm pack.
There are some small replacements that are needed but that should be manageable. Thoughts?
There was a problem hiding this comment.
@baywet I like the idea of having a template, we can copy the README from the root directory to the package msgraph-sdk but the rest of the packages can have slightly different README files, similar to the admin package
| @@ -1,11 +1,80 @@ | |||
| # `@microsoft/msgraph-sdk-admin` | |||
There was a problem hiding this comment.
Should be duplicated in all the subfolders
| @@ -1,11 +1,193 @@ | |||
| # `@microsoft/msgraph-sdk` | |||
| # Microsoft Graph SDK for Typescript | |||
There was a problem hiding this comment.
I'd advise against keeping a duplicate copy - it increases the likelihood of them getting out of sync. If you do decide to keep it, all the notes I made on the root README apply ;)
packages/msgraph-sdk-admin/README.md
Outdated
| const requestAdapter = new GraphRequestAdapter(authProvider); | ||
|
|
||
| // Create a GraphServiceClient | ||
| const graphServiceClient = createGraphServiceClient(requestAdapter); |
There was a problem hiding this comment.
I'd have expected this to demonstrate using the admin client instead in case they use this package directly.
Same thing for the import
| @@ -1,11 +1,193 @@ | |||
| # `@microsoft/msgraph-sdk` | |||
| # Microsoft Graph SDK for Typescript | |||
There was a problem hiding this comment.
@jasonjoh the problem we're trying to solve is that the package page on npm is empty. https://www.npmjs.com/package/@microsoft/msgraph-sdk-users
We could alternative maintain a template, at a central location and have a script that copies the file before npm pack.
There are some small replacements that are needed but that should be manageable. Thoughts?
rkodev
force-pushed
the
feat/adds-readme
branch
from
dd0e70e to
1d1f0ef
Compare
Closes #485
Draft README update for nested packages