Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Outlook] (quickstart) update unified manifest quickstart #4341

Merged
merged 10 commits into from May 3, 2024

Conversation

Rick-Kirkham
Copy link
Contributor

@Rick-Kirkham Rick-Kirkham commented Dec 28, 2023

These changes make the following assumptions:

  1. The changes won't be published until GA of unified manifest for Outlook, currently expected in late February.
  2. At the time of GA, The Yo Office option for task pane will also provide a manifest choice.

The quick start has been edited so it will work for either manifest.
The special quick start for the unified manifest, that used TypeScript, has been moved to the "/excludes" folder in case we ever want to use it again. It has been removed from the ToC.

@Rick-Kirkham Rick-Kirkham marked this pull request as draft December 28, 2023 00:12
Copy link
Contributor

Learn Build status updates of commit 9d1adb6:

✅ Validation status: passed

File Status Preview URL Details
docs/images/yo-office-outlook-json-manifest-typescript.png ✅Succeeded View
docs/quickstarts/outlook-quickstart-json-manifest.md ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit 2b4f8cd:

⚠️ Validation status: warnings

File Status Preview URL Details
docs/develop/json-manifest-overview.md ⚠️Warning View Details
docs/develop/unified-manifest-overview.md ⚠️Warning View Details
docs/outlook/index.yml ⚠️Warning View Details
docs/quickstarts/outlook-quickstart-json-manifest.md ⚠️Warning n/a (file deleted or renamed) Details
docs/excludes/outlook-quickstart-json-manifest-typescript.md ✅Succeeded
docs/images/yo-office-outlook-json-manifest-javascript.png ✅Succeeded View
docs/images/yo-office-outlook-json-manifest-typescript.png ✅Succeeded View
docs/images/yo-office-outlook-xml-manifest-javascript.png ✅Succeeded View
docs/quickstarts/outlook-quickstart.md ✅Succeeded View
docs/toc.yml ✅Succeeded View

docs/develop/json-manifest-overview.md

  • Line 108, Column 3: [Warning: file-not-found - See documentation] Invalid file link: '../quickstarts/outlook-quickstart-json-manifest.md'.

docs/develop/unified-manifest-overview.md

  • Line 32, Column 70: [Warning: file-not-found - See documentation] Invalid file link: '../quickstarts/outlook-quickstart-json-manifest.md'.

docs/outlook/index.yml

  • Line 31, Column 18: [Warning: file-not-found - See documentation] Invalid file link: '../quickstarts/outlook-quickstart-json-manifest.md'.

docs/quickstarts/outlook-quickstart-json-manifest.md

  • [Warning: file-not-redirected - See documentation] File docs/quickstarts/outlook-quickstart-json-manifest.md with URL /office/dev/add-ins/quickstarts/outlook-quickstart-json-manifest was deleted without redirection. To avoid broken links, add a redirection.

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:

Copy link
Contributor

Learn Build status updates of commit fbb1ddc:

✅ Validation status: passed

File Status Preview URL Details
.openpublishing.redirection.json ✅Succeeded View
docs/develop/json-manifest-overview.md ✅Succeeded View
docs/excludes/outlook-quickstart-json-manifest-typescript.md ✅Succeeded
docs/images/yo-office-outlook-json-manifest-javascript.png ✅Succeeded View
docs/images/yo-office-outlook-json-manifest-typescript.png ✅Succeeded View
docs/images/yo-office-outlook-xml-manifest-javascript.png ✅Succeeded View
docs/outlook/index.yml ✅Succeeded View
docs/quickstarts/outlook-quickstart.md ✅Succeeded View
docs/quickstarts/outlook-quickstart-json-manifest.md ✅Succeeded n/a (file deleted or renamed)
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

@samantharamon samantharamon left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approving with a question. The other drafts include a link to the unified manifest quick start. Will these PRs be updated before they're merged or will the instructions be updated in a separate PR?

docs/develop/json-manifest-overview.md Outdated Show resolved Hide resolved
@Rick-Kirkham
Copy link
Contributor Author

Approving with a question. The other drafts include a link to the unified manifest quick start. Will these PRs be updated before they're merged or will the instructions be updated in a separate PR?

I'm redoing the PR for the quick starts. Because we're adding support for JavaScript with the unified manifest (that development is probably an email that I scheduled-sent for later this week), we'll have just one quick start and the user will be instructed to choose JavaScript and then their choice of XML or unified manifest. The existing unified manifest quick start is moving the /excludes folder. See this PR: #4341

Rick-Kirkham and others added 2 commits January 10, 2024 15:43
Co-authored-by: Sam Ramon <15154970+samantharamon@users.noreply.github.com>
Copy link
Contributor

Learn Build status updates of commit 8057d19:

✅ Validation status: passed

File Status Preview URL Details
.openpublishing.redirection.json ✅Succeeded View
docs/develop/json-manifest-overview.md ✅Succeeded View
docs/excludes/outlook-quickstart-json-manifest-typescript.md ✅Succeeded
docs/images/yo-office-outlook-json-manifest-javascript.png ✅Succeeded View
docs/images/yo-office-outlook-json-manifest-typescript.png ✅Succeeded View
docs/images/yo-office-outlook-xml-manifest-javascript.png ✅Succeeded View
docs/includes/unified-manifest-value-prop-feedback.md ✅Succeeded View
docs/outlook/index.yml ✅Succeeded View
docs/quickstarts/outlook-quickstart.md ✅Succeeded View
docs/quickstarts/outlook-quickstart-json-manifest.md ✅Succeeded n/a (file deleted or renamed)
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit 9932bc8:

✅ Validation status: passed

File Status Preview URL Details
.openpublishing.redirection.json ✅Succeeded View
docs/develop/json-manifest-overview.md ✅Succeeded View
docs/excludes/outlook-quickstart-json-manifest-typescript.md ✅Succeeded
docs/images/yo-office-outlook-json-manifest-javascript.png ✅Succeeded View
docs/images/yo-office-outlook-json-manifest-typescript.png ✅Succeeded View
docs/images/yo-office-outlook-xml-manifest-javascript.png ✅Succeeded View
docs/includes/unified-manifest-value-prop-feedback.md ✅Succeeded View
docs/outlook/index.yml ✅Succeeded View
docs/quickstarts/outlook-quickstart.md ✅Succeeded View
docs/quickstarts/outlook-quickstart-json-manifest.md ✅Succeeded n/a (file deleted or renamed)
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:


![The prompts and answers for the Yeoman generator when task pane, JavaScript, Outlook, and XML manifest are chosen.](../images/yo-office-outlook-xml-manifest-javascript.png)

![The prompts and answers for the Yeoman generator when task pane, JavaScript, Outlook, and unified manifest are chosen.](../images/yo-office-outlook-json-manifest-javascript.png)

After you complete the wizard, the generator will create the project and install supporting Node components.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I can't leave a comment directly on the affected section, so adding this here.

Lines 61 - 66 ("Explore the project"): Include the file structure of an add-in project that uses the unified manifest (see Explore the project).

Line 68 ("Update the code"): We may need to add a note specifying that this section only applies to projects that use the XML manifest. I have a to-do to incorporate this JS code into the Outlook Yo Office template, but I might not be able to complete the work in time.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I updated the Explore the project section.

The Update the code section applies regardless of the type of manifest that they chose.

Darren and I have already updated the task pane project for JavaScript so that the user can choose either language with either type of manifest. I'm not clear on what your ToDo is, but I don't think it's needed.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Ricky.

Ah, I forgot that the change you and Darren worked on included language selection. Thanks for clearing that up. My task involves adding the JS code in the "Update the code" section of the Outlook quick start to the Outlook Yo Office template, so that the user can run the add-in right after creating it. This would align the Outlook quick start with the other quick starts, such as Excel.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, Ricky.

Ah, I forgot that the change you and Darren worked on included language selection. Thanks for clearing that up. My task involves adding the JS code in the "Update the code" section of the Outlook quick start to the Outlook Yo Office template, so that the user can run the add-in right after creating it. This would align the Outlook quick start with the other quick starts, such as Excel.

OK. I think I get it now. Step 3 of the "Update the code" section would be deleted because that code would be in the project when it is created.

Copy link
Contributor

Learn Build status updates of commit f5d6b48:

✅ Validation status: passed

File Status Preview URL Details
.openpublishing.redirection.json ✅Succeeded View
docs/develop/json-manifest-overview.md ✅Succeeded View
docs/excludes/outlook-quickstart-json-manifest-typescript.md ✅Succeeded
docs/images/yo-office-outlook-json-manifest-javascript.png ✅Succeeded View
docs/images/yo-office-outlook-json-manifest-typescript.png ✅Succeeded View
docs/images/yo-office-outlook-xml-manifest-javascript.png ✅Succeeded View
docs/includes/unified-manifest-value-prop-feedback.md ✅Succeeded View
docs/outlook/index.yml ✅Succeeded View
docs/quickstarts/outlook-quickstart.md ✅Succeeded View
docs/quickstarts/outlook-quickstart-json-manifest.md ✅Succeeded n/a (file deleted or renamed)
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit 30d1f91:

✅ Validation status: passed

File Status Preview URL Details
.openpublishing.redirection.json ✅Succeeded View
docs/develop/json-manifest-overview.md ✅Succeeded View
docs/excludes/outlook-quickstart-json-manifest-typescript.md ✅Succeeded
docs/images/yo-office-outlook-json-manifest-javascript.png ✅Succeeded View
docs/images/yo-office-outlook-json-manifest-typescript.png ✅Succeeded View
docs/images/yo-office-outlook-xml-manifest-javascript.png ✅Succeeded View
docs/includes/unified-manifest-value-prop-feedback.md ✅Succeeded View
docs/outlook/index.yml ✅Succeeded View
docs/quickstarts/outlook-quickstart.md ✅Succeeded View
docs/quickstarts/outlook-quickstart-json-manifest.md ✅Succeeded n/a (file deleted or renamed)
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit 08c038e:

✅ Validation status: passed

File Status Preview URL Details
.openpublishing.redirection.json ✅Succeeded View
docs/develop/json-manifest-overview.md ✅Succeeded View
docs/excludes/outlook-quickstart-json-manifest-typescript.md ✅Succeeded
docs/images/yo-office-outlook-json-manifest-javascript.png ✅Succeeded View
docs/images/yo-office-outlook-json-manifest-typescript.png ✅Succeeded View
docs/images/yo-office-outlook-xml-manifest-javascript.png ✅Succeeded View
docs/includes/unified-manifest-value-prop-feedback.md ✅Succeeded View
docs/outlook/index.yml ✅Succeeded View
docs/quickstarts/outlook-quickstart.md ✅Succeeded View
docs/quickstarts/outlook-quickstart-json-manifest.md ✅Succeeded n/a (file deleted or renamed)
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

Learn Build status updates of commit b0e6c4b:

✅ Validation status: passed

File Status Preview URL Details
.openpublishing.redirection.json ✅Succeeded View
docs/develop/json-manifest-overview.md ✅Succeeded View
docs/excludes/outlook-quickstart-json-manifest-typescript.md ✅Succeeded
docs/images/yo-office-outlook-json-manifest-javascript.png ✅Succeeded View
docs/images/yo-office-outlook-json-manifest-typescript.png ✅Succeeded View
docs/images/yo-office-outlook-xml-manifest-javascript.png ✅Succeeded View
docs/includes/unified-manifest-value-prop-feedback.md ✅Succeeded View
docs/outlook/index.yml ✅Succeeded View
docs/quickstarts/outlook-quickstart.md ✅Succeeded View
docs/quickstarts/outlook-quickstart-json-manifest.md ✅Succeeded n/a (file deleted or renamed)
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@Rick-Kirkham Rick-Kirkham marked this pull request as ready for review May 3, 2024 20:47
Copy link
Contributor

Learn Build status updates of commit 6c30f8d:

✅ Validation status: passed

File Status Preview URL Details
.openpublishing.redirection.json ✅Succeeded View
docs/develop/json-manifest-overview.md ✅Succeeded View
docs/excludes/outlook-quickstart-json-manifest-typescript.md ✅Succeeded
docs/images/yo-office-outlook-json-manifest-javascript.png ✅Succeeded View
docs/images/yo-office-outlook-json-manifest-typescript.png ✅Succeeded View
docs/images/yo-office-outlook-xml-manifest-javascript.png ✅Succeeded View
docs/outlook/index.yml ✅Succeeded View
docs/quickstarts/outlook-quickstart.md ✅Succeeded View
docs/quickstarts/outlook-quickstart-json-manifest.md ✅Succeeded n/a (file deleted or renamed)
docs/toc.yml ✅Succeeded View

For more details, please refer to the build report.

For any questions, please:

@Rick-Kirkham Rick-Kirkham merged commit eec44ad into main May 3, 2024
2 checks passed
@Rick-Kirkham Rick-Kirkham deleted the outlook-json-quickstart branch May 3, 2024 20:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants