[All Hosts] (DevX) updating tool articles for WXP with unified manifest #4792
Conversation
|
Learn Build status updates of commit d26742d:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/develop/convert-xml-to-json-manifest.md | View | Details | |
| docs/develop/teams-toolkit-overview.md | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-office-add-in.png | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-office-task-pane-capability.png | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-outlook-add-in.png | ✅Succeeded | n/a (file deleted or renamed) | |
| docs/images/teams-toolkit-create-outlook-task-pane-capability.png | ✅Succeeded | n/a (file deleted or renamed) |
docs/develop/convert-xml-to-json-manifest.md
- Line 77, Column 58: [Warning: file-not-found - See documentation]
Invalid file link: '../testing/test-debug-office-add-ins'.
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 f1190b2: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
|
||
| When you've added the files to the project, add **\<IconUrl\>** and **\<HighResolutionIconUrl\>** (in that order) to the add-in only manifest just below the **\<Description\>** element. The following is an example. | ||
| If your add-in only manifest doesn't already have both **\<IconUrl\>** and **\<HighResolutionIconUrl\>** (in that order) elements, then add them just below the **\<Description\>** element. The values of the **DefaultValue** attribute should be, respectively, the full URLs of a 64x64 pixel image file and a 128x128 pixel image file. The following is an example. |
There was a problem hiding this comment.
Outlook requires these dimensions. However, WXP have required different dimensions (32x32 and 64x64 respectively). Unless that has changed for the JSON manifest?
Co-authored-by: Elizabeth Samuel <[email protected]>
|
Learn Build status updates of commit 0fb4489:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/develop/convert-xml-to-json-manifest.md | View | Details | |
| docs/develop/teams-toolkit-overview.md | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-office-add-in.png | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-office-task-pane-capability.png | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-outlook-add-in.png | ✅Succeeded | n/a (file deleted or renamed) | |
| docs/images/teams-toolkit-create-outlook-task-pane-capability.png | ✅Succeeded | n/a (file deleted or renamed) | |
| docs/includes/unified-manifest-sideload-restrictions-note.md | ✅Succeeded | View | |
| docs/outlook/sideload-outlook-add-ins-for-testing.md | ✅Succeeded | View | |
| docs/testing/sideload-add-in-with-unified-manifest.md | ✅Succeeded | View | |
| docs/testing/sideload-an-office-add-in-on-ipad.md | ✅Succeeded | View | |
| docs/testing/sideload-an-office-add-in-on-mac.md | ✅Succeeded | View | |
| docs/testing/sideload-office-add-ins-for-testing.md | ✅Succeeded | View | |
| docs/toc.yml | ✅Succeeded | View |
docs/develop/convert-xml-to-json-manifest.md
- Line 86, Column 3: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#convert-projects-created-with-the-office-yeoman-generator-aka-yo-office' in 'develop/convert-xml-to-json-manifest.md'. - Line 87, Column 3: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#convert-nodejs-and-npm-projects-that-arent-created-with-yeoman-generator' in 'develop/convert-xml-to-json-manifest.md', did you mean '#convert-nodejs-and-npm-projects-that-werent-created-with-yeoman-generator'? - Line 139, Column 32: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#sideload-add-ins-created-with-the-office-yeoman-generator-yo-office' in 'testing/sideload-add-in-with-unified-manifest.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 53ab7c5:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/develop/convert-xml-to-json-manifest.md | View | Details | |
| docs/develop/teams-toolkit-overview.md | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-office-add-in.png | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-office-task-pane-capability.png | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-outlook-add-in.png | ✅Succeeded | n/a (file deleted or renamed) | |
| docs/images/teams-toolkit-create-outlook-task-pane-capability.png | ✅Succeeded | n/a (file deleted or renamed) | |
| docs/includes/unified-manifest-sideload-restrictions-note.md | ✅Succeeded | View | |
| docs/outlook/sideload-outlook-add-ins-for-testing.md | ✅Succeeded | View | |
| docs/testing/sideload-add-in-with-unified-manifest.md | ✅Succeeded | View | |
| docs/testing/sideload-an-office-add-in-on-ipad.md | ✅Succeeded | View | |
| docs/testing/sideload-an-office-add-in-on-mac.md | ✅Succeeded | View | |
| docs/testing/sideload-office-add-ins-for-testing.md | ✅Succeeded | View | |
| docs/toc.yml | ✅Succeeded | View |
docs/develop/convert-xml-to-json-manifest.md
- Line 92, Column 3: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#convert-projects-created-with-the-office-yeoman-generator-aka-yo-office' in 'develop/convert-xml-to-json-manifest.md'. - Line 145, Column 32: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#sideload-add-ins-created-with-the-office-yeoman-generator-yo-office' in 'testing/sideload-add-in-with-unified-manifest.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 fda1ccf:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/develop/convert-xml-to-json-manifest.md | View | Details | |
| docs/develop/teams-toolkit-overview.md | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-office-add-in.png | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-office-task-pane-capability.png | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-outlook-add-in.png | ✅Succeeded | n/a (file deleted or renamed) | |
| docs/images/teams-toolkit-create-outlook-task-pane-capability.png | ✅Succeeded | n/a (file deleted or renamed) | |
| docs/includes/unified-manifest-sideload-restrictions-note.md | ✅Succeeded | View | |
| docs/outlook/sideload-outlook-add-ins-for-testing.md | ✅Succeeded | View | |
| docs/testing/sideload-add-in-with-unified-manifest.md | ✅Succeeded | View | |
| docs/testing/sideload-an-office-add-in-on-ipad.md | ✅Succeeded | View | |
| docs/testing/sideload-an-office-add-in-on-mac.md | ✅Succeeded | View | |
| docs/testing/sideload-office-add-ins-for-testing.md | ✅Succeeded | View | |
| docs/toc.yml | ✅Succeeded | View |
docs/develop/convert-xml-to-json-manifest.md
- Line 93, Column 3: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#convert-projects-created-with-the-office-yeoman-generator-aka-yo-office' in 'develop/convert-xml-to-json-manifest.md'. - Line 146, Column 32: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#sideload-add-ins-created-with-the-office-yeoman-generator-yo-office' in 'testing/sideload-add-in-with-unified-manifest.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 dd2d094:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/develop/convert-xml-to-json-manifest.md | View | Details | |
| docs/develop/teams-toolkit-overview.md | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-office-add-in.png | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-office-task-pane-capability.png | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-outlook-add-in.png | ✅Succeeded | n/a (file deleted or renamed) | |
| docs/images/teams-toolkit-create-outlook-task-pane-capability.png | ✅Succeeded | n/a (file deleted or renamed) | |
| docs/includes/unified-manifest-sideload-restrictions-note.md | ✅Succeeded | View | |
| docs/outlook/sideload-outlook-add-ins-for-testing.md | ✅Succeeded | View | |
| docs/testing/sideload-add-in-with-unified-manifest.md | ✅Succeeded | View | |
| docs/testing/sideload-an-office-add-in-on-ipad.md | ✅Succeeded | View | |
| docs/testing/sideload-an-office-add-in-on-mac.md | ✅Succeeded | View | |
| docs/testing/sideload-office-add-ins-for-testing.md | ✅Succeeded | View | |
| docs/toc.yml | ✅Succeeded | View |
docs/develop/convert-xml-to-json-manifest.md
- Line 93, Column 3: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#convert-projects-created-with-the-office-yeoman-generator-aka-yo-office' in 'develop/convert-xml-to-json-manifest.md'. - Line 146, Column 32: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#sideload-add-ins-created-with-the-office-yeoman-generator-yo-office' in 'testing/sideload-add-in-with-unified-manifest.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
|
|
||
| ## Conversion tools and options | ||
|
|
||
| There are several ways to carry out the remaining tasks, depending on the IDE and other tools you want to use for your project, and on the tool you used to create the project. | ||
|
|
||
| - [Convert the project with Teams Toolkit](#convert-the-project-with-teams-toolkit) | ||
| - [Projects created with the Office Yeoman Generator (aka "Yo Office")](#projects-created-with-the-office-yeoman-generator-aka-yo-office) | ||
| - [NodeJS and npm projects that aren't created with Yeoman Generator](#nodejs-and-npm-projects-that-arent-created-with-yeoman-generator) | ||
| - [Convert projects created with the Yeoman generator for Office Add-ins (aka "Yo Office")](#convert-projects-created-with-the-office-yeoman-generator-aka-yo-office) |
There was a problem hiding this comment.
make sure to update to the correct bookmark
| 1. To sideload the add-in, run `npm run start:desktop`. This command puts the unified manifest and the two image files into a zip file and sideloads it to the Office application. It also starts the server in a separate NodeJS window to host the add-in files on localhost. | ||
|
|
||
| When you're ready to stop the dev server and uninstall the add-in, run the command `npm run stop`. | ||
| 1. To sideload the add-in, see [Sideload add-ins created with the Yeoman generator for Office Add-ins (Yo Office)](../testing/sideload-add-in-with-unified-manifest.md#sideload-add-ins-created-with-the-office-yeoman-generator-yo-office). |
There was a problem hiding this comment.
make sure to update to the correct bookmark
Co-authored-by: Elizabeth Samuel <[email protected]>
|
Learn Build status updates of commit cb3c0af:
|
| File | Status | Preview URL | Details |
|---|---|---|---|
| docs/develop/convert-xml-to-json-manifest.md | View | Details | |
| docs/develop/teams-toolkit-overview.md | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-office-add-in.png | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-office-task-pane-capability.png | ✅Succeeded | View | |
| docs/images/teams-toolkit-create-outlook-add-in.png | ✅Succeeded | n/a (file deleted or renamed) | |
| docs/images/teams-toolkit-create-outlook-task-pane-capability.png | ✅Succeeded | n/a (file deleted or renamed) | |
| docs/includes/unified-manifest-sideload-restrictions-note.md | ✅Succeeded | View | |
| docs/outlook/sideload-outlook-add-ins-for-testing.md | ✅Succeeded | View | |
| docs/testing/sideload-add-in-with-unified-manifest.md | ✅Succeeded | View | |
| docs/testing/sideload-an-office-add-in-on-ipad.md | ✅Succeeded | View | |
| docs/testing/sideload-an-office-add-in-on-mac.md | ✅Succeeded | View | |
| docs/testing/sideload-office-add-ins-for-testing.md | ✅Succeeded | View | |
| docs/toc.yml | ✅Succeeded | View |
docs/develop/convert-xml-to-json-manifest.md
- Line 93, Column 3: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#convert-projects-created-with-the-office-yeoman-generator-aka-yo-office' in 'develop/convert-xml-to-json-manifest.md'. - Line 94, Column 3: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#convert-nodejs-and-npm-projects-that-werent-created-with-yeoman-generator' in 'develop/convert-xml-to-json-manifest.md'. - Line 146, Column 32: [Warning: bookmark-not-found - See documentation]
Cannot find bookmark '#sideload-add-ins-created-with-the-office-yeoman-generator-yo-office' in 'testing/sideload-add-in-with-unified-manifest.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 c7211b2: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
Learn Build status updates of commit 376a52c: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
|
||
| [!INCLUDE [non-unified manifest clients note](../includes/non-unified-manifest-clients.md)] | ||
|
|
||
| Install the latest version of Teams Toolkit into Visual Studio Code as described in [Install Teams Toolkit](/microsoftteams/platform/toolkit/install-teams-toolkit?tabs=vscode). | ||
|
|
||
| ## Create an Outlook Add-in project | ||
| ## Create an Office Add-in project |
There was a problem hiding this comment.
Should we clarify we are talking about a prerelease version of TTK when WXP public preview? At that time, developers need to install the prerelease version as described in Install Teams Toolkit - Install a prerelease version
There was a problem hiding this comment.
Should we clarify we are talking about a prerelease version of TTK when WXP public preview? At that time, developers need to install the prerelease version as described in Install Teams Toolkit - Install a prerelease version
I added an IMPORTANT note with this information just above the section title.
There was a problem hiding this comment.
The latest snapshot
|
|
||
| :::image type="content" source="../images/teams-toolkit-create-outlook-add-in.png" alt-text="The four options in New Project drop down. The fourth option is called 'Outlook add-in'."::: | ||
| :::image type="content" source="../images/teams-toolkit-create-office-add-in.png" alt-text="The five options in New Project dropdown menu. The fifth option is called 'Office Add-in'."::: |
There was a problem hiding this comment.
| :::image type="content" source="../images/teams-toolkit-create-office-add-in.png" alt-text="The five options in New Project dropdown menu. The fifth option is called 'Office Add-in'."::: | |
| :::image type="content" source="../images/teams-toolkit-create-office-add-in.png" alt-text="The six options in New Project dropdown menu. The sixth option is called 'Office Add-in'."::: |
There was a problem hiding this comment.
I think it was a mistake on my part to use specific numbers. I'll rewrite so that we don't have to keep changing this text whenever the number of options changes.
|
|
||
| 1. In the **App Features Using an Outlook Add-in** drop down, select **Taskpane**. | ||
| 1. In the **App Features Using an Office Add-in** dropdown menu, select **Taskpane** or **Content Add-in**. (For simplicity, the remainder of this article assumes you selected **Taskpane**. For more information about content add-ins, see [Content Office Add-ins](../design/content-add-ins.md).) |
There was a problem hiding this comment.
| 1. In the **App Features Using an Office Add-in** dropdown menu, select **Taskpane** or **Content Add-in**. (For simplicity, the remainder of this article assumes you selected **Taskpane**. For more information about content add-ins, see [Content Office Add-ins](../design/content-add-ins.md).) | |
| 1. In the **App Features Using an Office Add-in** dropdown menu, select **Taskpane**. |
The content add-in will not be supported for public preview. We can add it for GA if the template is ready by then
|
|
||
| 1. In the **Workspace folder** dialog that opens, select the folder where you want to create the project. | ||
| 1. In the **Programming Language** dropdown menu, select either **TypeScript** or **JavaScript**. |
There was a problem hiding this comment.
| 1. In the **Programming Language** dropdown menu, select either **TypeScript** or **JavaScript**. |
Only ts template is supported at public preview, so no options here.
There was a problem hiding this comment.
Only ts template is supported at public preview, so no options here.
I'll make a modified version of your suggested change because we have to take into account that some people will be creating and Outlook add-in and they will have a choice between ts and js.
|
|
||
| 1. In the **Workspace folder** dialog that opens, select the folder where you want to create the project. | ||
| 1. In the **Programming Language** dropdown menu, select either **TypeScript** or **JavaScript**. | ||
| 1. In the **Framework** dropdown menu, select **Default** or **React**. |
There was a problem hiding this comment.
| 1. In the **Framework** dropdown menu, select **Default** or **React**. |
Same as above. only default at public preview
| 1. After the installation completes, verify that you can sideload your add-in from Visual Studio Code. The steps to sideload vary depending on the Office application on which you want to test the add-in. | ||
|
|
||
| ### Sideload in Excel, PowerPoint, or Word | ||
|
|
There was a problem hiding this comment.
We may need a notice for developers that metaOS host doesn't support mac at public preview, so the following guidance only applies to start debugging on win32. For developers that develop on mac, they can only test it as an integrated app in the admin center.
There was a problem hiding this comment.
We may need a notice for developers that metaOS host doesn't support mac at public preview, so the following guidance only applies to start debugging on win32. For developers that develop on mac, they can only test it as an integrated app in the admin center.
added a note with this information
|
|
||
| 1. Select **View** | **Run** in Visual Studio Code. In the **RUN AND DEBUG** dropdown menu, select one of these options: | ||
|
|
||
| - **Excel Desktop (Edge Chromium)** |
There was a problem hiding this comment.
| - **Excel Desktop (Edge Chromium)** | |
| - **Excel Desktop (Edge Chromium)** | |
| - **Outlook Desktop (Edge Chromium)** |
There was a problem hiding this comment.
We shouldn't add Outlook here. These lines appear in a section titled "Sideload in Excel, PowerPoint, and Word". There is a separate section just below this that is about sideloading in Outlook.
| 1. Click the **Show Taskpane** button and a task pane opens. Click the **Perform an action** button and a small notification appears near the top of the message. | ||
| 1. To stop debugging and uninstall the add-in, select **Run** | **Stop Debugging** in Visual Studio Code. | ||
| 1. After the installation completes, verify that you can sideload your add-in from Visual Studio Code. The steps to sideload vary depending on the Office application on which you want to test the add-in. | ||
|
|
There was a problem hiding this comment.
Should we add a section to introduce the "Import an Existing Office Add-in" feature? This feature helps developers to upgrade an existing xml manifest add-in project to the unified manifest and project structure.
The steps will be:
- Select Create a New App.
- In the New Project dropdown menu, select Office Add-in.
- In the App Features Using an Office Add-in dropdown menu, select Import an Existing Office Add-in.
- In the Existing add-in project folder dialog that opens, select the folder of your existing add-in project.
- In the Select import project manifest file dialog that opens, select the manifest of your existing add-in project.
- In the Workspace Folder dialog that opens, select the folder where you want to create the project.
- Give a name to the project (with no spaces) when prompted. Teams Toolkit will create the project with basic files and scaffolding. It will then open the project in a second Visual Studio Code window. Close the original Visual Studio Code window.
There was a problem hiding this comment.
I don't think we should make this change for reasons I explain in a separate email. This information is already in the article about converting an XML manifest project to a JSON manifest project.
|
Learn Build status updates of commit d6e66e0: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
|
Learn Build status updates of commit 9d969bb: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
There was a problem hiding this comment.
@Rick-Kirkham I replace the updated snapshot with the string updates. Here is the updated package to download if more are needed.
docs/images/teams-toolkit-create-office-task-pane-capability.png
Outdated
Show resolved
Hide resolved
In the very last option in the New Project window, we still need to replace the phrase "Office apps" with "Office applications". |
|
Learn Build status updates of commit 7ce6f60: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
@hermanwenhe Would you take this comment and update the new package? Thanks! |
|
Learn Build status updates of commit 134fa4a: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue.
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 2a278f5: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
No description provided.