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
| You can create an Office Add-in by using the Office Add-ins Development Kit or the Yeoman generator in Visual Studio Code. Select the tab for the one you'd like to use and then follow the instructions to create your add-in and test it locally. | ||
|
|
||
| # [Office Add-ins Development Kit](#tab/devkit) | ||
| ## Prerequisites |
There was a problem hiding this comment.
The prerequisite section is same as the one section in (docs/develop/development-kit-overview.md)
| > [!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). | ||
|
|
||
| ## Explore the project |
There was a problem hiding this comment.
The "Explore the project"section is most similar as the one in the yeoman option.
| 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)
|
|
||
| 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?
The articles when NOT be published until the Dev Kit is ready for GA.