[All Hosts] (DevX) updating tool articles for WXP with unified manifest #4792
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
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
ElizabethSamuel-MSFT
approved these changes
Sep 13, 2024
|
|
||
| ## 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:
|
Rick-Kirkham
commented
Oct 10, 2024
|
Learn Build status updates of commit 376a52c: ✅ Validation status: passed
For more details, please refer to the build report. For any questions, please:
|
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.