Skip to content

Commit ff2456a

Browse files
authored
README update for packages (#771)
* Draft readme copy for packages * fix grammar * update readme * Update nested readme * Adds copy-readme * Fix copy readme * Execute build pwsh * Delete README.md * change README.md * update readme template
1 parent 9d2a7fb commit ff2456a

74 files changed

Lines changed: 244 additions & 770 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

.github/workflows/build.yml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,9 @@ jobs:
7676
with:
7777
node-version: 22
7878
registry-url: https://registry.npmjs.org/
79+
- name: Copy README.md to packages
80+
shell: pwsh
81+
run: ./script/copy-readme.ps1
7982
- run: npm ci
8083
- run: npm run build
8184
- run: npx lerna publish from-package --no-push --yes

.gitignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
11
node_modules/
22
lib/
33
*.log
4-
*.tgz
4+
*.tgz
5+
6+
*.idea/

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
# Microsoft Graph SDK for Typescript
22

3-
Get started with the Microsoft Graph SDK for Typescript by integrating the [Microsoft Graph API](https://docs.microsoft.com/graph/overview) into your Typescript application!
3+
Get started with the Microsoft Graph SDK for Typescript by integrating the [Microsoft Graph API](https://learn.microsoft.com/graph/overview) into your Typescript application!
4+
5+
> [!NOTE]
6+
> The Microsoft Graph Typescript SDK is currently in Pre-Release. This SDK allows you to build applications using the [v1.0](https://learn.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs, use our [beta SDK](https://github.com/microsoftgraph/msgraph-beta-sdk-typescript) instead.
47
5-
> **Note:** this SDK allows you to build applications using the [v1.0](https://docs.microsoft.com/graph/use-the-api#version) of Microsoft Graph. If you want to try the latest Microsoft Graph APIs.
6-
>
7-
> **Note:** the Microsoft Graph Typescript SDK is currently in Pre-Release.
88

99
## 1. Installation
1010

@@ -23,14 +23,14 @@ npm install @microsoft/msgraph-sdk-users
2323
2424
### 2.1 Register your application
2525

26-
Register your application by following the steps at [Register your app with the Microsoft Identity Platform](https://docs.microsoft.com/graph/auth-register-app-v2).
26+
Register your application by following the steps at [Register your app with the Microsoft Identity Platform](https://learn.microsoft.com/graph/auth-register-app-v2).
2727

2828
### 2.2 Create an AuthenticationProvider object
2929

3030
An instance of the **GraphServiceClient** class handles building client. To create a new instance of this class, you need to provide an instance of **AuthenticationProvider**, which can authenticate requests to Microsoft Graph.
3131

3232
<!-- TODO restore that and remove the snippets below once the SDK hits GA and the public documentation has been updated -->
33-
<!-- For an example of how to get an authentication provider, see [choose a Microsoft Graph authentication provider](https://docs.microsoft.com/graph/sdks/choose-authentication-providers?tabs=typescript). -->
33+
<!-- For an example of how to get an authentication provider, see [choose a Microsoft Graph authentication provider](https://learn.microsoft.com/graph/sdks/choose-authentication-providers?tabs=typescript). -->
3434

3535
#### 2.2.1 Authorization Code Provider
3636

@@ -149,7 +149,7 @@ const graphServiceClient = createGraphServiceClient(requestAdapter);
149149

150150
## 3. Make requests against the service
151151

152-
After you have a **GraphServiceClient** that is authenticated, you can begin making calls against the service. The requests against the service look like our [REST API](https://docs.microsoft.com/graph/api/overview?view=graph-rest-1.0).
152+
After you have a **GraphServiceClient** that is authenticated, you can begin making calls against the service. The requests against the service look like our [REST API](https://learn.microsoft.com/graph/api/overview?view=graph-rest-1.0).
153153

154154
### 3.1 Get user's detailed information
155155

@@ -169,9 +169,9 @@ const jane = await graphServiceClient.users.byUserId("jane@contoso.com").get();
169169

170170
For more detailed documentation, see:
171171

172-
* [Overview](https://docs.microsoft.com/graph/overview)
173-
* [Collections](https://docs.microsoft.com/graph/sdks/paging)
174-
* [Making requests](https://docs.microsoft.com/graph/sdks/create-requests)
172+
* [Overview](https://learn.microsoft.com/graph/overview)
173+
* [Collections](https://learn.microsoft.com/graph/sdks/paging)
174+
* [Making requests](https://learn.microsoft.com/graph/sdks/create-requests)
175175
* [Known issues](https://github.com/MicrosoftGraph/msgraph-sdk-typescript/issues)
176176
* [Contributions](https://github.com/microsoftgraph/msgraph-sdk-typescript/blob/main/CONTRIBUTING.md)
177177

packages/msgraph-sdk-admin/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

packages/msgraph-sdk-agreementAcceptances/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

packages/msgraph-sdk-agreements/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

packages/msgraph-sdk-appCatalogs/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

packages/msgraph-sdk-applicationTemplates/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

packages/msgraph-sdk-applications/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

packages/msgraph-sdk-auditLogs/README.md

Lines changed: 0 additions & 11 deletions
This file was deleted.

0 commit comments

Comments
 (0)