Skip to content

Commit 30385ea

Browse files
[all hosts] Learn Rebrand (OfficeDev#1407)
1 parent 7b14ac5 commit 30385ea

File tree

65 files changed

+129
-129
lines changed

Some content is hidden

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

65 files changed

+129
-129
lines changed

DocumentationToolingNotes.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -13,29 +13,29 @@ The type definition files on [Definitely Typed](https://github.com/DefinitelyTyp
1313
There are four relevant d.ts files that provide source content for different subsections of the docs.
1414

1515
- [office-js/index.d.ts](https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/master/types/office-js/index.d.ts) (The Release definitions.)
16-
- [Excel (Release)](https://docs.microsoft.com/javascript/api/excel_release)
17-
- [OneNote](https://docs.microsoft.com/javascript/api/onenote)
18-
- [PowerPoint](https://docs.microsoft.com/javascript/api/powerpoint)
19-
- [Visio](https://docs.microsoft.com/javascript/api/visio)
20-
- [Word (Release)](https://docs.microsoft.com/javascript/api/word_release)
21-
- [OfficeExtensions subsection of the Common API](https://docs.microsoft.com/javascript/api/office)
16+
- [Excel (Release)](https://learn.microsoft.com/javascript/api/excel_release)
17+
- [OneNote](https://learn.microsoft.com/javascript/api/onenote)
18+
- [PowerPoint](https://learn.microsoft.com/javascript/api/powerpoint)
19+
- [Visio](https://learn.microsoft.com/javascript/api/visio)
20+
- [Word (Release)](https://learn.microsoft.com/javascript/api/word_release)
21+
- [OfficeExtensions subsection of the Common API](https://learn.microsoft.com/javascript/api/office)
2222
- [office-js-preview/index.d.ts](https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/master/types/office-js-preview/index.d.ts) (The Preview definitions.)
23-
- [Excel (Preview)](https://docs.microsoft.com/javascript/api/excel)
24-
- [Outlook (Preview)](https://docs.microsoft.com/javascript/api/outlook)
25-
- [Word (Preview)](https://docs.microsoft.com/javascript/api/word)
26-
- [Common API](https://docs.microsoft.com/javascript/api/office)
23+
- [Excel (Preview)](https://learn.microsoft.com/javascript/api/excel)
24+
- [Outlook (Preview)](https://learn.microsoft.com/javascript/api/outlook)
25+
- [Word (Preview)](https://learn.microsoft.com/javascript/api/word)
26+
- [Common API](https://learn.microsoft.com/javascript/api/office)
2727
- [custom-functions-runtime/index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/custom-functions-runtime/index.d.ts) (The Excel Custom Functions runtime definitions.)
28-
- [Custom Functions](https://docs.microsoft.com/javascript/api/custom-functions-runtime)
28+
- [Custom Functions](https://learn.microsoft.com/javascript/api/custom-functions-runtime)
2929
- [office-runtime/index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/blob/master/types/office-runtime/index.d.ts) (The office runtime definitions for the Custom Functions platform.)
30-
- [Office Runtime](https://docs.microsoft.com/javascript/api/office-runtime)
30+
- [Office Runtime](https://learn.microsoft.com/javascript/api/office-runtime)
3131

3232
Older versions of the APIs have their own d.ts files. These are preserved when a new API requirement set is released. They can also be generated using the [Version Remover tool](https://github.com/OfficeDev/office-js-docs-reference/blob/master/generate-docs/tools/VersionRemover.ts). These old d.ts files are maintained so that in the event APIs are patched or altered, the original behavior is still documented. This is useful if you have to target an older version of the API.
3333

3434
#### Testing type definition file changes
3535

3636
Any documentation changes for the Office JavaScript API are done by editing the four d.ts files mentioned above. However, you can test a change before submitting a PR to DefinitelyTyped (if you need to, for example, test how your formatting will translate into markdown) by editing the corresponding file in [generate-docs/script-inputs](https://github.com/OfficeDev/office-js-docs-reference/tree/master/generate-docs/script-inputs) and running [GenerateDocs.cmd](https://github.com/OfficeDev/office-js-docs-reference/blob/master/generate-docs/GenerateDocs.cmd). When prompted, select the "Local files" option.
3737

38-
Pushing changes to a remote branch of this repo causes the docs.microsoft.com platform to build a test branch. This branch is rendered on review.docs.microsoft.com, which is only accessible by internal Microsoft personnel. Anyone reviewing your PR will check the review site for accuracy.
38+
Pushing changes to a remote branch of this repo causes the learn.microsoft.com platform to build a test branch. This branch is rendered on review.learn.microsoft.com, which is only accessible by internal Microsoft personnel. Anyone reviewing your PR will check the review site for accuracy.
3939

4040
### Code snippets
4141

@@ -66,7 +66,7 @@ API Extractor converts the d.ts files into JSON data. This tokenizes all the typ
6666

6767
The midprocessor retrieves the code snippets and pairs them with the proper hosts, and cleans up the crosslinking between Outlook and Common API objects.
6868

69-
API Documenter converts the JSON data into .yml files. The .yml files are converted to markdown by the Open Publishing System that publishes our docs to docs.microsoft.com. API Documenter also contains an Office-specific extension that inserts our code snippets.
69+
API Documenter converts the JSON data into .yml files. The .yml files are converted to markdown by the Open Publishing System that publishes our docs to learn.microsoft.com. API Documenter also contains an Office-specific extension that inserts our code snippets.
7070

7171
The postprocessor cleans up the table of contents and moves the .yml files into the [publishing folder](https://github.com/OfficeDev/office-js-docs-reference/tree/master/docs/docs-ref-autogen).
7272

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Office JavaScript API Reference
22

3-
Welcome to the Office JavaScript API Reference documentation repository. For the best experience, we recommend you view this content on the [Microsoft Docs](https://docs.microsoft.com/javascript/api/overview/office) site.
3+
Welcome to the Office JavaScript API Reference documentation repository. For the best experience, we recommend you view this content on the [Microsoft Learn](https://learn.microsoft.com/javascript/api/overview/office) site.
44

55
> **Note**: You can find the documentation source files for Office JavaScript API concepts, quick starts, tutorials, and how-to guides in the [OfficeDev/office-js-docs-pr](https://github.com/OfficeDev/office-js-docs-pr) repository.
66

docs/code-snippets/office-snippets.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1283,7 +1283,7 @@ Office.Document#addHandlerAsync:member(2):
12831283
// For a complete code sample that shows how to use a ResourceSelectionChanged
12841284
// event handler in a Project add-in, see "Create your first task pane add-in
12851285
// for Project 2013 by using a text editor."
1286-
// https://docs.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
1286+
// https://learn.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
12871287
- |-
12881288
// The following code example adds a handler for the TaskSelectionChanged event.
12891289
// When the task selection changes in the document, it gets the GUID of the
@@ -1372,7 +1372,7 @@ Office.Document#addHandlerAsync:member(2):
13721372
// For an example that shows how to use a ViewSelectionChanged event handler in a
13731373
// Project add-in, see "Create your first task pane add-in for Project 2013 by
13741374
// using a text editor."
1375-
// https://docs.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
1375+
// https://learn.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
13761376
- |-
13771377
// The following code example uses addHandlerAsync to add an event handler for the ViewSelectionChanged event.
13781378
// When the active view changes, the handler checks the view type. It enables a button if the view is a resource
@@ -1452,7 +1452,7 @@ Office.Document#addHandlerAsync:member(2):
14521452
14531453
// For a complete code sample that shows how to use a ViewSelectionChanged event handler in a Project add-in,
14541454
// see "Create your first task pane add-in for Project by using a text editor."
1455-
// https://docs.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
1455+
// https://learn.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
14561456
Office.Document#bindings:member:
14571457
- |-
14581458
function displayAllBindings() {

docs/code-snippets/onenote-snippets.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -353,7 +353,7 @@ OneNote.Notebook#getRestApiId:member(1):
353353
// This is only required for SharePoint notebooks. baseUrl will be null for OneDrive notebooks.
354354
// For SharePoint notebooks, the notebook baseUrl should be used to talk to the OneNote REST API
355355
// according to the OneNote Development Blog.
356-
// https://docs.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
356+
// https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
357357
});
358358
OneNote.Notebook#load:member(2):
359359
- |-
@@ -371,7 +371,7 @@ OneNote.Notebook#load:member(2):
371371
console.log("Base url: " + notebook.baseUrl);
372372
// This is only required for SharePoint notebooks, and will be null for OneDrive notebooks.
373373
// This baseUrl should be used to talk to OneNote REST APIs according to the OneNote Development Blog.
374-
// https://docs.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
374+
// https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
375375
});
376376
OneNote.NotebookCollection#getByName:member(1):
377377
- |-
@@ -541,7 +541,7 @@ OneNote.Page#getRestApiId:member(1):
541541
// This is only required for SharePoint notebooks. baseUrl will be null for OneDrive notebooks.
542542
// For SharePoint notebooks, the notebook baseUrl should be used to talk to the OneNote REST API
543543
// according to the OneNote Development Blog.
544-
// https://docs.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
544+
// https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
545545
});
546546
OneNote.Page#insertPageAsSibling:member(2):
547547
- |-
@@ -999,7 +999,7 @@ OneNote.Section#getRestApiId:member(1):
999999
// This is only required for SharePoint notebooks. baseUrl will be null for OneDrive notebooks.
10001000
// For SharePoint notebooks, the notebook baseUrl should be used to talk to the
10011001
// OneNote REST API according to the OneNote Development Blog.
1002-
// https://docs.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
1002+
// https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
10031003
});
10041004
OneNote.Section#load:member(2):
10051005
- |-

docs/code-snippets/outlook-snippets.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -725,7 +725,7 @@ Office.EmailAddressDetails#recipientType:member:
725725
Office.EmailUser:interface:
726726
- |-
727727
// The following example is an excerpt from a larger sample.
728-
// For the full sample, visit https://docs.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
728+
// For the full sample, visit https://learn.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
729729
730730
// Gets instances of the task suggestion entity on the item.
731731
function myGetTaskSuggestions()

docs/code-snippets/word-snippets.yaml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -160,7 +160,7 @@ Word.Body#insertInlinePictureFromBase64:member(1):
160160
});
161161
162162
// Read "Create better add-ins for Word with Office Open XML" for guidance on working with OOXML.
163-
// https://docs.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml
163+
// https://learn.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml
164164
165165
// The Word-Add-in-DocumentAssembly sample shows how you can use this API to assemble a document.
166166
// https://github.com/OfficeDev/Word-Add-in-DocumentAssembly
@@ -485,7 +485,7 @@ Word.ContentControl#insertOoxml:member(1):
485485
});
486486
487487
// Read "Create better add-ins for Word with Office Open XML" for guidance on working with OOXML.
488-
// https://docs.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml
488+
// https://learn.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml
489489
Word.ContentControl#insertParagraph:member(1):
490490
- |-
491491
// Run a batch operation against the Word object model.
@@ -1450,7 +1450,7 @@ Word.Range#insertOoxml:member(1):
14501450
});
14511451
14521452
// Read "Create better add-ins for Word with Office Open XML" for guidance on working with OOXML.
1453-
// https://docs.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml
1453+
// https://learn.microsoft.com/office/dev/add-ins/word/create-better-add-ins-for-word-with-office-open-xml
14541454
Word.Range#insertParagraph:member(1):
14551455
- |-
14561456
// Run a batch operation against the Word object model.

docs/docs-ref-autogen/office/office/office.document.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ methods:
314314
// for Project 2013 by using a text editor."
315315
316316
//
317-
https://docs.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
317+
https://learn.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
318318
319319
```
320320
@@ -427,7 +427,7 @@ methods:
427427
// using a text editor."
428428
429429
//
430-
https://docs.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
430+
https://learn.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
431431
432432
```
433433
@@ -523,7 +523,7 @@ methods:
523523
// see "Create your first task pane add-in for Project by using a text editor."
524524
525525
//
526-
https://docs.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
526+
https://learn.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
527527
528528
```
529529
isPreview: false

docs/docs-ref-autogen/office_release/office/office.document.yml

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -314,7 +314,7 @@ methods:
314314
// for Project 2013 by using a text editor."
315315
316316
//
317-
https://docs.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
317+
https://learn.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
318318
319319
```
320320
@@ -427,7 +427,7 @@ methods:
427427
// using a text editor."
428428
429429
//
430-
https://docs.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
430+
https://learn.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
431431
432432
```
433433
@@ -523,7 +523,7 @@ methods:
523523
// see "Create your first task pane add-in for Project by using a text editor."
524524
525525
//
526-
https://docs.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
526+
https://learn.microsoft.com/office/dev/add-ins/project/create-your-first-task-pane-add-in-for-project-by-using-a-text-editor
527527
528528
```
529529
isPreview: false

docs/docs-ref-autogen/onenote/onenote/onenote.notebook.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -206,7 +206,7 @@ methods:
206206
// This is only required for SharePoint notebooks. baseUrl will be null for OneDrive notebooks.
207207
// For SharePoint notebooks, the notebook baseUrl should be used to talk to the OneNote REST API
208208
// according to the OneNote Development Blog.
209-
// https://docs.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
209+
// https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
210210
});
211211
```
212212
isPreview: false
@@ -273,7 +273,7 @@ methods:
273273
console.log("Base url: " + notebook.baseUrl);
274274
// This is only required for SharePoint notebooks, and will be null for OneDrive notebooks.
275275
// This baseUrl should be used to talk to OneNote REST APIs according to the OneNote Development Blog.
276-
// https://docs.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
276+
// https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
277277
});
278278
```
279279
- name: load(propertyNamesAndPaths)

docs/docs-ref-autogen/onenote/onenote/onenote.page.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ methods:
309309
// This is only required for SharePoint notebooks. baseUrl will be null for OneDrive notebooks.
310310
// For SharePoint notebooks, the notebook baseUrl should be used to talk to the OneNote REST API
311311
// according to the OneNote Development Blog.
312-
// https://docs.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
312+
// https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
313313
});
314314
```
315315
isPreview: false

docs/docs-ref-autogen/onenote/onenote/onenote.section.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -294,7 +294,7 @@ methods:
294294
// This is only required for SharePoint notebooks. baseUrl will be null for OneDrive notebooks.
295295
// For SharePoint notebooks, the notebook baseUrl should be used to talk to the
296296
// OneNote REST API according to the OneNote Development Blog.
297-
// https://docs.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
297+
// https://learn.microsoft.com/archive/blogs/onenotedev/and-sharepoint-makes-three
298298
});
299299
```
300300
isPreview: false

docs/docs-ref-autogen/outlook/outlook/office.emailuser.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ remarks: >-
3030
// The following example is an excerpt from a larger sample.
3131
3232
// For the full sample, visit
33-
https://docs.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
33+
https://learn.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
3434
3535
3636
// Gets instances of the task suggestion entity on the item.

docs/docs-ref-autogen/outlook_1_1/outlook/office.emailuser.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ remarks: >-
3030
// The following example is an excerpt from a larger sample.
3131
3232
// For the full sample, visit
33-
https://docs.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
33+
https://learn.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
3434
3535
3636
// Gets instances of the task suggestion entity on the item.

docs/docs-ref-autogen/outlook_1_10/outlook/office.emailuser.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ remarks: >-
3030
// The following example is an excerpt from a larger sample.
3131
3232
// For the full sample, visit
33-
https://docs.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
33+
https://learn.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
3434
3535
3636
// Gets instances of the task suggestion entity on the item.

docs/docs-ref-autogen/outlook_1_11/outlook/office.emailuser.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ remarks: >-
3030
// The following example is an excerpt from a larger sample.
3131
3232
// For the full sample, visit
33-
https://docs.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
33+
https://learn.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
3434
3535
3636
// Gets instances of the task suggestion entity on the item.

docs/docs-ref-autogen/outlook_1_12/outlook/office.emailuser.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ remarks: >-
3030
// The following example is an excerpt from a larger sample.
3131
3232
// For the full sample, visit
33-
https://docs.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
33+
https://learn.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
3434
3535
3636
// Gets instances of the task suggestion entity on the item.

docs/docs-ref-autogen/outlook_1_2/outlook/office.emailuser.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ remarks: >-
3030
// The following example is an excerpt from a larger sample.
3131
3232
// For the full sample, visit
33-
https://docs.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
33+
https://learn.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
3434
3535
3636
// Gets instances of the task suggestion entity on the item.

docs/docs-ref-autogen/outlook_1_3/outlook/office.emailuser.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ remarks: >-
3030
// The following example is an excerpt from a larger sample.
3131
3232
// For the full sample, visit
33-
https://docs.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
33+
https://learn.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
3434
3535
3636
// Gets instances of the task suggestion entity on the item.

docs/docs-ref-autogen/outlook_1_4/outlook/office.emailuser.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ remarks: >-
3030
// The following example is an excerpt from a larger sample.
3131
3232
// For the full sample, visit
33-
https://docs.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
33+
https://learn.microsoft.com/office/dev/add-ins/outlook/extract-entity-strings-from-an-item.
3434
3535
3636
// Gets instances of the task suggestion entity on the item.

0 commit comments

Comments
 (0)