Update the W/X quickstart articles when the Dev Kit GA #4902
Conversation
|
Learn Build status updates of commit f1761ba:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/quickstarts/excel-quickstart-jquery.md | View | Details | |
| docs/quickstarts/word-quickstart-yo.md | View | Details | |
| docs/images/office-add-ins-development-kit-samplepage-excelquickstart.png | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-wordquickstart.png | ✅Succeeded | View |
docs/quickstarts/excel-quickstart-jquery.md
- Line 35, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 35, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
docs/quickstarts/word-quickstart-yo.md
- Line 35, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 35, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
There was a problem hiding this comment.
Hi @AlexJerabek , I start a initial proposal on the documentation update to prepare for the Dev Kit GA. Please feel free to let me know your thoughts! Thanks ;)
There was a problem hiding this comment.
The snapshoots are now placeholders. Need to update with the new sample naming
| 1. The ./src/taskpane/taskpane.css file contains the CSS that's applied to content in the task pane. | ||
| 1. The ./src/taskpane/taskpane.js file contains the Office JavaScript API code that facilitates interaction between the task pane and the Office client application. | ||
|
|
||
| ## Try it out |
There was a problem hiding this comment.
"Try it out", "Stop testing", "Troubleshooting" are same as the ones in (docs/develop/development-kit-overview.md)
There was a problem hiding this comment.
Same suggestion for an include file. This prevents content from being different in two places if we miss something in an update.
There was a problem hiding this comment.
Is there a reason we didn't include the headers in the include files? I think you could make this whole thing one include file.
|
|
||
| Click the following button to create an add-in project using the Office Add-ins Development Kit for Visual Studio Code. A page that contains the project decription will open in Visual Studio Code. | ||
|
|
||
| <button type="button">[Create an add-in in Visual Studio Code](vscode://msoffice.microsoft-office-add-in-debugger/open-specific-sample?sample-id=Excel-HelloWorld-TaskPane-JS)</button> |
There was a problem hiding this comment.
I imagine a clickable button to link to the sample page in VSC. Can we achieve that in MS Learn site?
There was a problem hiding this comment.
I think this is the best way to do that: https://review.learn.microsoft.com/en-us/help/platform/markdown-reference?branch=main#next-step-action. I've added the markdown as a suggestion.
|
|
||
| Click the following button to create an add-in project using the Office Add-ins Development Kit for Visual Studio Code. A page that contains the project decription will open in Visual Studio Code. | ||
|
|
||
| <button type="button">[Create an add-in in Visual Studio Code](vscode://msoffice.microsoft-office-add-in-debugger/open-specific-sample?sample-id=Excel-HelloWorld-TaskPane-JS)</button> |
There was a problem hiding this comment.
I think this is the best way to do that: https://review.learn.microsoft.com/en-us/help/platform/markdown-reference?branch=main#next-step-action. I've added the markdown as a suggestion.
| <img src="../images/office-add-ins-development-kit-samplepage-excelquickstart.png" alt="Screenshot shows the sample page in Visual Studio Code"/> | ||
|
|
||
| In the prompted page, select **Create** to create the add-in project. In the **Workspace folder** dialog that opens, select the folder where you want to create the project. |
There was a problem hiding this comment.
I'd move the screenshot so it follow the "Create" instruction. In the screenshot, surround the Create button with a red box to highlight where it is in the UI.
|
|
||
| <button type="button">[Create an add-in in Visual Studio Code](vscode://msoffice.microsoft-office-add-in-debugger/open-specific-sample?sample-id=Word-HelloWorld-TaskPane-JS)</button> | ||
|
|
||
| <img src="../images/office-add-ins-development-kit-samplepage-wordquickstart.png" alt="Screenshot shows the sample page in Visual Studio Code"/> |
There was a problem hiding this comment.
Same suggestion as with Excel for a different screenshot.
|
Thanks for putting this together @MingjiaLiu1995! When are we planning to launch the Dev Kit for GA? |
Thanks for the review comments Alex! The only GA dependency is completing merging all the existing samples. Herman submitted the last sample repo today(Thursday), so I guess we can target some day in the next 1~2 weeks if there is no other concern? Btw, who would be the dev kit contact during your oof? I'll address all these comments tomorrow(Friday), so hopefully only small adjustment and review are needed after. (And wish you have a great vacation!) |
|
Learn Build status updates of commit 0151746:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/quickstarts/excel-quickstart-jquery.md | View | Details | |
| docs/quickstarts/word-quickstart-yo.md | View | Details | |
| docs/images/office-add-ins-development-kit-samplepage-excelquickstart.png | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-wordquickstart.png | ✅Succeeded | View |
docs/quickstarts/excel-quickstart-jquery.md
- Line 35, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 35, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
docs/quickstarts/word-quickstart-yo.md
- Line 35, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 35, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
Co-authored-by: Alex Jerabek <[email protected]>
Co-authored-by: Alex Jerabek <[email protected]>
Co-authored-by: Alex Jerabek <[email protected]>
|
Learn Build status updates of commit 9468361:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/quickstarts/excel-quickstart-jquery.md | View | Details | |
| docs/quickstarts/word-quickstart-yo.md | View | Details | |
| docs/images/office-add-ins-development-kit-samplepage-excelquickstart.png | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-wordquickstart.png | ✅Succeeded | View |
docs/quickstarts/excel-quickstart-jquery.md
- Line 33, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 33, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
docs/quickstarts/word-quickstart-yo.md
- Line 35, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 35, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
Co-authored-by: Alex Jerabek <[email protected]>
|
Learn Build status updates of commit 4d2e785:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/quickstarts/excel-quickstart-jquery.md | View | Details | |
| docs/quickstarts/word-quickstart-yo.md | View | Details | |
| docs/images/office-add-ins-development-kit-samplepage-excelquickstart.png | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-wordquickstart.png | ✅Succeeded | View |
docs/quickstarts/excel-quickstart-jquery.md
- Line 33, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 33, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
docs/quickstarts/word-quickstart-yo.md
- Line 35, Column 179: [Warning: file-not-found - See documentation]
Invalid file link: '../development-kit-overview.md'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit d540a61:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/quickstarts/excel-quickstart-jquery.md | View | Details | |
| docs/quickstarts/word-quickstart-yo.md | View | Details | |
| docs/images/office-add-ins-development-kit-samplepage-excelquickstart.png | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-wordquickstart.png | ✅Succeeded | View |
docs/quickstarts/excel-quickstart-jquery.md
- Line 33, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 33, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
docs/quickstarts/word-quickstart-yo.md
- Line 35, Column 179: [Warning: file-not-found - See documentation]
Invalid file link: '../development-kit-overview.md'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit c935e3a:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/quickstarts/excel-quickstart-jquery.md | View | Details | |
| docs/quickstarts/word-quickstart-yo.md | View | Details | |
| docs/images/office-add-ins-development-kit-samplepage-excelquickstart.png | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-wordquickstart.png | ✅Succeeded | View | |
| docs/includes/devkit-prerequisites | ✅Succeeded |
docs/quickstarts/excel-quickstart-jquery.md
- Line 33, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 33, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
docs/quickstarts/word-quickstart-yo.md
- Line 35, Column 179: [Warning: file-not-found - See documentation]
Invalid file link: '../development-kit-overview.md'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit baf9b8c: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
docs/quickstarts/excel-quickstart-jquery.md
docs/quickstarts/word-quickstart-yo.md
For more details, please refer to the build report. Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
|
Learn Build status updates of commit 9349148:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/quickstarts/excel-quickstart-jquery.md | View | Details | |
| docs/quickstarts/word-quickstart-yo.md | View | Details | |
| docs/images/office-add-ins-development-kit-samplepage-excelquickstart.png | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-wordquickstart.png | ✅Succeeded | View | |
| docs/includes/dev-kit-prerequisites | ✅Succeeded |
docs/quickstarts/excel-quickstart-jquery.md
- Line 31, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 31, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
docs/quickstarts/word-quickstart-yo.md
- Line 35, Column 179: [Warning: file-not-found - See documentation]
Invalid file link: '../development-kit-overview.md'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit 2d1bf91:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/quickstarts/excel-quickstart-jquery.md | View | Details | |
| docs/quickstarts/word-quickstart-yo.md | View | Details | |
| docs/images/office-add-ins-development-kit-samplepage-excelquickstart.png | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-wordquickstart.png | ✅Succeeded | View | |
| docs/includes/dev-kit-prerequisites.md | ✅Succeeded | View |
docs/quickstarts/excel-quickstart-jquery.md
- Line 31, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 31, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
docs/quickstarts/word-quickstart-yo.md
- Line 35, Column 179: [Warning: file-not-found - See documentation]
Invalid file link: '../development-kit-overview.md'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit ecc441a:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/quickstarts/excel-quickstart-jquery.md | View | Details | |
| docs/quickstarts/word-quickstart-yo.md | View | Details | |
| docs/images/office-add-ins-development-kit-samplepage-excelquickstart.png | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-wordquickstart.png | ✅Succeeded | View | |
| docs/includes/dev-kit-prerequisites.md | ✅Succeeded | View |
docs/quickstarts/excel-quickstart-jquery.md
- Line 31, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 31, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
docs/quickstarts/word-quickstart-yo.md
- Line 35, Column 179: [Warning: file-not-found - See documentation]
Invalid file link: '../development-kit-overview.md'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
Co-authored-by: Alex Jerabek <[email protected]>
Co-authored-by: Alex Jerabek <[email protected]>
Co-authored-by: Alex Jerabek <[email protected]>
|
Learn Build status updates of commit 53e225b:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/quickstarts/excel-quickstart-jquery.md | View | Details | |
| docs/quickstarts/word-quickstart-yo.md | View | Details | |
| docs/images/office-add-ins-development-kit-samplepage-excelquickstart.png | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-wordquickstart.png | ✅Succeeded | View | |
| docs/includes/dev-kit-prerequisites.md | ✅Succeeded | View |
docs/quickstarts/excel-quickstart-jquery.md
- Line 32, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 32, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
docs/quickstarts/word-quickstart-yo.md
- Line 33, Column 179: [Warning: file-not-found - See documentation]
Invalid file link: '../development-kit-overview.md'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit e09e338:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/quickstarts/excel-quickstart-jquery.md | View | Details | |
| docs/quickstarts/word-quickstart-yo.md | View | Details | |
| docs/images/office-add-ins-development-kit-samplepage-excelquickstart.png | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-wordquickstart.png | ✅Succeeded | View | |
| docs/includes/dev-kit-prerequisites.md | ✅Succeeded | View |
docs/quickstarts/excel-quickstart-jquery.md
- Line 32, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 32, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
docs/quickstarts/word-quickstart-yo.md
- Line 34, Column 179: [Warning: file-not-found - See documentation]
Invalid file link: '../development-kit-overview.md'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit 4f3ef68:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/quickstarts/excel-quickstart-jquery.md | View | Details | |
| docs/quickstarts/word-quickstart-yo.md | View | Details | |
| docs/develop/development-kit-overview.md | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-excelquickstart.png | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-wordquickstart.png | ✅Succeeded | View | |
| docs/includes/dev-kit-prerequisites.md | ✅Succeeded | View | |
| docs/includes/dev-kit-start-debugging.md | ✅Succeeded | View | |
| docs/includes/dev-kit-stop-debugging.md | ✅Succeeded | View | |
| docs/includes/dev-kit-troubleshooting.md | ✅Succeeded | View | |
| docs/includes/devkit-project-components-taskpane.md | ✅Succeeded | View |
docs/quickstarts/excel-quickstart-jquery.md
- Line 32, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 32, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
docs/quickstarts/word-quickstart-yo.md
- Line 32, Column 179: [Warning: file-not-found - See documentation]
Invalid file link: '../development-kit-overview.md'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
Learn Build status updates of commit f6e6f13:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/quickstarts/excel-quickstart-jquery.md | View | Details | |
| docs/quickstarts/word-quickstart-yo.md | View | Details | |
| docs/develop/development-kit-overview.md | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-excelquickstart.png | ✅Succeeded | View | |
| docs/images/office-add-ins-development-kit-samplepage-wordquickstart.png | ✅Succeeded | View | |
| docs/includes/dev-kit-prerequisites.md | ✅Succeeded | View | |
| docs/includes/dev-kit-start-debugging.md | ✅Succeeded | View | |
| docs/includes/dev-kit-stop-debugging.md | ✅Succeeded | View | |
| docs/includes/dev-kit-troubleshooting.md | ✅Succeeded | View | |
| docs/includes/devkit-project-components-taskpane.md | ✅Succeeded | View |
docs/quickstarts/excel-quickstart-jquery.md
- Line 32, Column 113: [Warning: hard-coded-locale - See documentation]
Link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' contains locale code 'en-us'. For localizability, remove 'en-us' from links to most Microsoft sites. - Line 32, Column 113: [Suggestion: docs-link-absolute - See documentation]
Absolute link 'https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode' will be broken in isolated environments. Replace with a relative link.
docs/quickstarts/word-quickstart-yo.md
- Line 32, Column 179: [Warning: file-not-found - See documentation]
Invalid file link: '../development-kit-overview.md'.
For more details, please refer to the build report.
Note: Your PR may contain errors or warnings or suggestions unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them.
For any questions, please:
- Try searching the learn.microsoft.com contributor guides
- Post your question in the Learn support channel
|
@AlexJerabek I have addressed all the previous comments. Let me know if there are more. Thanks! |
| Office Add-ins Development Kit will create the project. It will then open the project *in a second Visual Studio Code window*. Close the original Visual Studio Code window. | ||
|
|
||
| > [!NOTE] | ||
| > You will receive prompts to install the Office Add-ins Development Kit extension if you haven't. You can also [install the Office Add-ins Development Kit manually](https://learn.microsoft.com/en-us/office/dev/add-ins/develop/development-kit-overview?tabs=vscode). |
There was a problem hiding this comment.
@MingjiaLiu1995, looks like this comment was missed. That should resolve the build warnings (which needs to happen before this PR can be checked in)
| 1. The ./manifest.xml or manifest.json file in the root directory of the project defines the settings and capabilities of the add-in. | ||
| 1. The ./src/taskpane/taskpane.html file contains the HTML markup for the task pane. | ||
| 1. The ./src/taskpane/taskpane.css file contains the CSS that's applied to content in the task pane. | ||
| 1. The ./src/taskpane/taskpane.js file contains the Office JavaScript API code that facilitates interaction between the task pane and the Office client application. |
There was a problem hiding this comment.
File names should be in bold
| 1. The ./manifest.xml or manifest.json file in the root directory of the project defines the settings and capabilities of the add-in. | |
| 1. The ./src/taskpane/taskpane.html file contains the HTML markup for the task pane. | |
| 1. The ./src/taskpane/taskpane.css file contains the CSS that's applied to content in the task pane. | |
| 1. The ./src/taskpane/taskpane.js file contains the Office JavaScript API code that facilitates interaction between the task pane and the Office client application. | |
| 1. The **./manifest.xml** or **./manifest.json** file in the root directory of the project defines the settings and capabilities of the add-in. | |
| 1. The **./src/taskpane/taskpane.html** file contains the HTML markup for the task pane. | |
| 1. The **./src/taskpane/taskpane.css** file contains the CSS that's applied to content in the task pane. | |
| 1. The **./src/taskpane/taskpane.js** file contains the Office JavaScript API code that facilitates interaction between the task pane and the Office client application. |
|
|
||
| In the prompted page, select **Create** to create the add-in project. In the **Workspace folder** dialog that opens, select the folder where you want to create the project. | ||
|
|
||
| <img src="../images/office-add-ins-development-kit-samplepage-excelquickstart.png" alt="Screenshot shows the sample page in Visual Studio Code"/> |
There was a problem hiding this comment.
Favor the Learn image markdown syntax
| <img src="../images/office-add-ins-development-kit-samplepage-excelquickstart.png" alt="Screenshot shows the sample page in Visual Studio Code"/> | |
| :::image type="content" source="../images/office-add-ins-development-kit-samplepage-excelquickstart.png" alt-text="The Development Kit sample gallery in Visual Studio Code"::: |
| 1. The ./src/taskpane/taskpane.css file contains the CSS that's applied to content in the task pane. | ||
| 1. The ./src/taskpane/taskpane.js file contains the Office JavaScript API code that facilitates interaction between the task pane and the Office client application. | ||
|
|
||
| ## Try it out |
There was a problem hiding this comment.
Is there a reason we didn't include the headers in the include files? I think you could make this whole thing one include file.
|
|
||
|
|
|
|
||
|
|
|
|
||
| In the prompted page, select **Create** to create the add-in project. In the **Workspace folder** dialog that opens, select the folder where you want to create the project. | ||
|
|
||
| <img src="../images/office-add-ins-development-kit-samplepage-wordquickstart.png" alt="Screenshot shows the sample page in Visual Studio Code"/> |
There was a problem hiding this comment.
| <img src="../images/office-add-ins-development-kit-samplepage-wordquickstart.png" alt="Screenshot shows the sample page in Visual Studio Code"/> | |
| :::image type="content" source="../images/office-add-ins-development-kit-samplepage-wordquickstart.png" alt-text="The Development Kit sample gallery in Visual Studio Code"::: |
The articles when NOT be published until the Dev Kit is ready for GA.