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

[All Hosts] (manifest) reorg the manifest part of the TOC #4727

Open
wants to merge 9 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from 5 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion docs/includes/manifest-guidance.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
> [!TIP]
> If you'll be testing your add-in across multiple environments (for example, in development, staging, demo, etc.), we recommend that you maintain a different manifest file for each environment. In each manifest file, you can:
>
> - Specify the URLs that correspond to the environment.
> - Customize metadata values like `DisplayName` and labels within `Resources` to indicate the environment, so that end users will be able to identify a sideloaded add-in's corresponding environment.
> - Customize metadata values so that end users are able to identify a sideloaded add-in's corresponding environment. For example:
>
> - In the unified manifest for Microsoft 365, customize the "name" property of the add-in and the "label" properties for various UI controls to indicate the environment.
> - In the add-in only manifest, customize the `DisplayName` element and and labels within the `Resources` element to indicate the environment.
>
> - Customize the custom functions `namespace` to indicate the environment, if your add-in defines custom functions.
>
> By following this guidance, you'll streamline the testing process and avoid issues that would otherwise occur when an add-in is simultaneously sideloaded for multiple environments.
38 changes: 21 additions & 17 deletions docs/toc.yml
Original file line number Diff line number Diff line change
Expand Up @@ -116,23 +116,27 @@ items:
items:
- name: Overview
href: develop/add-in-manifests.md
- name: Office Add-ins with the add-in only manifest
href: develop/xml-manifest-overview.md
- name: Office Add-ins with the unified manifest for Microsoft 365
href: develop/unified-manifest-overview.md
- name: Compare the add-in only manifest with the unified manifest for Microsoft 365
href: develop/json-manifest-overview.md
- name: Convert an add-in to use the unified manifest for Microsoft 365
href: develop/convert-xml-to-json-manifest.md
- name: Add-in only manifest reference
href: reference/manifest-reference.md
- name: Extended overrides
href: develop/extended-overrides.md
- name: Find the proper order of manifest elements
href: develop/manifest-element-ordering.md
- name: Update API and manifest version
href: develop/update-your-javascript-api-for-office-and-manifest-schema-version.md
displayName: manifest
- name: Unified manifest for Microsoft 365
items:
- name: Office Add-ins with the unified manifest for Microsoft 365
href: develop/unified-manifest-overview.md
- name: Compare the add-in only manifest with the unified manifest for Microsoft 365
href: develop/json-manifest-overview.md
- name: Convert an add-in to use the unified manifest for Microsoft 365
href: develop/convert-xml-to-json-manifest.md
- name: Add-in only manifest
items:
- name: Office Add-ins with the add-in only manifest
href: develop/xml-manifest-overview.md
- name: Add-in only manifest reference
href: reference/manifest-reference.md
- name: Extended overrides
href: develop/extended-overrides.md
- name: Find the proper order of manifest elements
href: develop/manifest-element-ordering.md
- name: Update API and manifest version
href: develop/update-your-javascript-api-for-office-and-manifest-schema-version.md
displayName: manifest
Rick-Kirkham marked this conversation as resolved.
Show resolved Hide resolved
- name: Privacy, security, and storage
items:
- name: Overview of add-in privacy and security
Expand Down