Skip to content

Update Add-ons documentation (Submit your app) #5465

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

Draft
wants to merge 13 commits into
base: docs
Choose a base branch
from

Conversation

luislera
Copy link

Changes included

  • Updated price and availability section
  • Merged subsections to improve readability
  • Rephased some content to make it clearer
  • Updated TOC

Copy link
Contributor

@luislera : Thanks for your contribution! The author(s) and reviewer(s) have been notified to review your proposed change.

Copy link
Contributor

Learn Build status updates of commit 7648bef:

⚠️ Validation status: warnings

File Status Preview URL Details
hub/apps/publish/publish-your-app/add-on/create-app-store-listing.md ⚠️Warning Details
hub/apps/publish/publish-your-app/add-on/resolve-submission-errors.md ⚠️Warning Details
hub/apps/publish/publish-your-app/add-on/schedule-pricing-changes.md ⚠️Warning Details
hub/apps/publish/publish-your-app/add-on/add-and-edit-store-listing-info.md ✅Succeeded n/a (file deleted or renamed)
hub/apps/publish/publish-your-app/add-on/app-certification-process.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/create-app-submission.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/enter-app-properties.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/manage-submission-options.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/market-selection.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/price-and-availability.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/product-declarations.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/publish-update-to-your-app-on-store.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/reserve-your-apps-name.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/support-info.md ✅Succeeded n/a (file deleted or renamed)
hub/apps/publish/publish-your-app/add-on/visibility-options.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/what-are-add-ons.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/write-great-app-description.md ✅Succeeded
hub/apps/publish/publish-your-app/msix/images/msix-set-app-pricing-other-types.png ✅Succeeded
hub/apps/publish/toc.yml ✅Succeeded

hub/apps/publish/publish-your-app/add-on/create-app-store-listing.md

  • Line 26, Column 1: [Warning: multiple-h1s - See documentation] Multiple H1s(H1 'Add and edit Store listing info for add-on') are not allowed. You can only have one top-level heading.

hub/apps/publish/publish-your-app/add-on/resolve-submission-errors.md

  • Line 50, Column 13: [Warning: file-not-found - See documentation] Invalid file link: './support-info.md'.

hub/apps/publish/publish-your-app/add-on/schedule-pricing-changes.md

  • Line 13, Column 307: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#override-base-price-for-specific-markets' in 'apps/publish/publish-your-app/add-on/schedule-pricing-changes.md'.
  • Line 17, Column 1: [Suggestion: duplicate-alt-text - See documentation] Alt text 'A screenshot of the Pricing and availability section showing how to set app pricing.' is duplicated. Within an article, alt text must be unique.
  • Line 26, Column 1: [Suggestion: duplicate-alt-text - See documentation] Alt text 'A screenshot of the Pricing and availability section showing how to set app pricing.' is duplicated. Within an article, alt text must be unique.

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 21896be:

✅ Validation status: passed

File Status Preview URL Details
hub/apps/publish/publish-your-app/add-on/add-and-edit-store-listing-info.md ✅Succeeded n/a (file deleted or renamed)
hub/apps/publish/publish-your-app/add-on/app-certification-process.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/create-app-store-listing.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/create-app-submission.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/enter-app-properties.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/manage-submission-options.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/market-selection.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/price-and-availability.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/product-declarations.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/publish-update-to-your-app-on-store.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/reserve-your-apps-name.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/resolve-submission-errors.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/schedule-pricing-changes.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/support-info.md ✅Succeeded n/a (file deleted or renamed)
hub/apps/publish/publish-your-app/add-on/visibility-options.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/what-are-add-ons.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/write-great-app-description.md ✅Succeeded
hub/apps/publish/publish-your-app/msix/images/msix-set-app-pricing-other-types.png ✅Succeeded
hub/apps/publish/toc.yml ✅Succeeded

For more details, please refer to the build report.

For any questions, please:

Copy link
Contributor

PRMerger Results

Issue Description
Added File(s) This PR contains added files. New files require human review.
Deleted File(s) This PR deletes Markdown or YAML files owned by another author, or json file(s). The pull request must contain a comment from the pull request author confirming that all the file deletions are intentional before the pull request can be merged.
Yaml File(s) This PR includes changes to .yml file(s) owned by another author.
Changed Files This PR contains more than 10 changed files.
File Change Percent This PR contains file(s) with more than 30% file change.
Image File This PR added or updated an image file(s).

Copy link
Contributor

@IpsitaChoudhary IpsitaChoudhary left a comment

Choose a reason for hiding this comment

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

Please check the rest of the feedback shared in Teams and see if they are applicable for add-ons


You must provide a description, up to 200 characters. This information will be displayed to customers along with the title.

### Icon
Copy link
Contributor

Choose a reason for hiding this comment

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

I like that we have added this. Why have we excluded the other parameters like what's new, etc.?

Copy link
Author

Choose a reason for hiding this comment

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

The only fields available for updating store listings are the following:
image

What do you mean with parameters like what's new, etc.?

| **Icon** | Optional (.png, 300x300 pixels) |

When you've finished entering this info, click **Submit to the Store**. In most cases, the certification process takes about an hour. After that, your add-on will be published to the Store and ready for customers to purchase.

> [!NOTE]
> The add-on must also be implemented in your app's code. For more info, see [In-app purchases and trials](/windows/uwp/monetize/in-app-purchases-and-trials).

## Set your add-on product type and product ID

An add-on must be associated with an app that you've created in Partner Center (even if you haven't submitted it yet). You can find the button to Create a new add-on on your app's Overview page or on its Add-ons page.
Copy link
Contributor

Choose a reason for hiding this comment

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

Why have we removed this?

Copy link
Author

Choose a reason for hiding this comment

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

The same content is included at the beginning of this document

image

Is that ok to remove the duplicated text?

@@ -47,7 +47,7 @@ Review this list to help avoid issues that frequently prevent apps from getting

- [Provide any necessary info](./manage-submission-options.md#notes-for-certification) required to use your app, such as the user name and password for a test account if your app requires users to log in to a service, or any steps required to access hidden or locked features.

- Include a [privacy policy URL](./support-info.md#privacy-policy-url) if your app requires one; for example, if your app accesses any kind of personal information in any way or is otherwise required by law. To help determine if your app requires a privacy policy, review the [App Developer Agreement](https://go.microsoft.com/fwlink/?linkid=528905) and the [Microsoft Store Policies](../../store-policies.md).
- Include a [privacy policy URL](./enter-app-properties.md#privacy-policy-url) if your app requires one; for example, if your app accesses any kind of personal information in any way or is otherwise required by law. To help determine if your app requires a privacy policy, review the [App Developer Agreement](https://go.microsoft.com/fwlink/?linkid=528905) and the [Microsoft Store Policies](../../store-policies.md).

- Make sure that your app's description clearly represents what your app does. For help, see our guidance on [writing a great app description](./write-great-app-description.md).
Copy link
Contributor

Choose a reason for hiding this comment

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

Can we refer to Write a great app description in best practices section?

Copy link
Author

Choose a reason for hiding this comment

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

I've added the link to best practices section.

Copy link
Contributor

Choose a reason for hiding this comment

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

Where is the content from this file added?

Copy link
Author

Choose a reason for hiding this comment

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

It was included in the Add properties section. We made this change to ensure the documentation matches the order of the Add-on properties fields, providing a more consistent and user-friendly experience.

image

Copy link
Contributor

Choose a reason for hiding this comment

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

Should we have one article on great app description in best practices section. Anything that applies to add-ons can be mentioned separately on the page?

Copy link
Author

Choose a reason for hiding this comment

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

As far as we checked, the content of this section is the same as the one added in best practices section. Should we remove this document?

Copy link
Contributor

Learn Build status updates of commit d948534:

✅ Validation status: passed

File Status Preview URL Details
hub/apps/publish/best-practices/best-practices.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/add-and-edit-store-listing-info.md ✅Succeeded n/a (file deleted or renamed)
hub/apps/publish/publish-your-app/add-on/app-certification-process.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/create-app-store-listing.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/create-app-submission.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/enter-app-properties.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/manage-submission-options.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/market-selection.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/price-and-availability.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/product-declarations.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/publish-update-to-your-app-on-store.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/reserve-your-apps-name.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/resolve-submission-errors.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/schedule-pricing-changes.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/support-info.md ✅Succeeded n/a (file deleted or renamed)
hub/apps/publish/publish-your-app/add-on/visibility-options.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/what-are-add-ons.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/write-great-app-description.md ✅Succeeded
hub/apps/publish/publish-your-app/msix/images/msix-set-app-pricing-other-types.png ✅Succeeded
hub/apps/publish/toc.yml ✅Succeeded

For more details, please refer to the build report.

Copy link
Contributor

PRMerger Results

Issue Description
Added File(s) This PR contains added files. New files require human review.
Deleted File(s) This PR deletes Markdown or YAML files owned by another author, or json file(s). The pull request must contain a comment from the pull request author confirming that all the file deletions are intentional before the pull request can be merged.
Yaml File(s) This PR includes changes to .yml file(s) owned by another author.
Changed Files This PR contains more than 10 changed files.
File Change Percent This PR contains file(s) with more than 30% file change.
Image File This PR added or updated an image file(s).

Copy link
Contributor

Learn Build status updates of commit 3992774:

✅ Validation status: passed

File Status Preview URL Details
hub/apps/publish/best-practices/best-practices.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/add-and-edit-store-listing-info.md ✅Succeeded n/a (file deleted or renamed)
hub/apps/publish/publish-your-app/add-on/app-certification-process.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/create-app-store-listing.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/create-app-submission.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/enter-app-properties.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/manage-submission-options.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/market-selection.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/price-and-availability.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/product-declarations.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/publish-update-to-your-app-on-store.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/reserve-your-apps-name.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/resolve-submission-errors.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/schedule-pricing-changes.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/support-info.md ✅Succeeded n/a (file deleted or renamed)
hub/apps/publish/publish-your-app/add-on/visibility-options.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/what-are-add-ons.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/write-great-app-description.md ✅Succeeded
hub/apps/publish/publish-your-app/msix/images/msix-set-app-pricing-other-types.png ✅Succeeded
hub/apps/publish/toc.yml ✅Succeeded

For more details, please refer to the build report.

Copy link
Contributor

PRMerger Results

Issue Description
Added File(s) This PR contains added files. New files require human review.
Deleted File(s) This PR deletes Markdown or YAML files owned by another author, or json file(s). The pull request must contain a comment from the pull request author confirming that all the file deletions are intentional before the pull request can be merged.
Yaml File(s) This PR includes changes to .yml file(s) owned by another author.
Changed Files This PR contains more than 10 changed files.
File Change Percent This PR contains file(s) with more than 30% file change.
Image File This PR added or updated an image file(s).

Copy link
Contributor

Learn Build status updates of commit cc98816:

⚠️ Validation status: warnings

File Status Preview URL Details
hub/apps/publish/publish-your-app/add-on/app-certification-process.md ⚠️Warning Details
hub/apps/publish/publish-your-app/add-on/manage-submission-options.md ⚠️Warning Details
hub/apps/publish/publish-your-app/add-on/price-and-availability.md ⚠️Warning Details
hub/apps/publish/publish-your-app/add-on/visibility-options.md ⚠️Warning Details
hub/apps/publish/best-practices/best-practices.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/add-and-edit-store-listing-info.md ✅Succeeded n/a (file deleted or renamed)
hub/apps/publish/publish-your-app/add-on/configure-release-schedule.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/create-app-store-listing.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/create-app-submission.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/enter-app-properties.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/market-selection.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/product-declarations.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/publish-update-to-your-app-on-store.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/reserve-your-apps-name.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/resolve-submission-errors.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/schedule-pricing-changes.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/support-info.md ✅Succeeded n/a (file deleted or renamed)
hub/apps/publish/publish-your-app/add-on/what-are-add-ons.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/write-great-app-description.md ✅Succeeded
hub/apps/publish/publish-your-app/msix/images/msix-set-app-pricing-other-types.png ✅Succeeded
hub/apps/publish/toc.yml ✅Succeeded

hub/apps/publish/publish-your-app/add-on/app-certification-process.md

  • Line 32, Column 99: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#configure-precise-release-scheduling' in 'apps/publish/publish-your-app/add-on/schedule-pricing-changes.md'.

hub/apps/publish/publish-your-app/add-on/manage-submission-options.md

  • Line 15, Column 117: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#configure-precise-release-scheduling' in 'apps/publish/publish-your-app/add-on/schedule-pricing-changes.md'.
  • Line 19, Column 283: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#configure-precise-release-scheduling' in 'apps/publish/publish-your-app/add-on/schedule-pricing-changes.md'.

hub/apps/publish/publish-your-app/add-on/price-and-availability.md

  • Line 36, Column 20: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#configure-precise-release-scheduling' in 'apps/publish/publish-your-app/add-on/schedule-pricing-changes.md'.

hub/apps/publish/publish-your-app/add-on/visibility-options.md

  • Line 36, Column 249: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#configure-precise-release-scheduling' in 'apps/publish/publish-your-app/add-on/schedule-pricing-changes.md'.
  • Line 46, Column 24: [Warning: bookmark-not-found - See documentation] Cannot find bookmark '#configure-precise-release-scheduling' in 'apps/publish/publish-your-app/add-on/schedule-pricing-changes.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.

Copy link
Contributor

Learn Build status updates of commit 2386472:

✅ Validation status: passed

File Status Preview URL Details
hub/apps/publish/best-practices/best-practices.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/add-and-edit-store-listing-info.md ✅Succeeded n/a (file deleted or renamed)
hub/apps/publish/publish-your-app/add-on/app-certification-process.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/configure-release-schedule.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/create-app-store-listing.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/create-app-submission.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/enter-app-properties.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/manage-submission-options.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/market-selection.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/price-and-availability.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/product-declarations.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/publish-update-to-your-app-on-store.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/reserve-your-apps-name.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/resolve-submission-errors.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/schedule-pricing-changes.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/support-info.md ✅Succeeded n/a (file deleted or renamed)
hub/apps/publish/publish-your-app/add-on/visibility-options.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/what-are-add-ons.md ✅Succeeded
hub/apps/publish/publish-your-app/add-on/write-great-app-description.md ✅Succeeded
hub/apps/publish/publish-your-app/msix/images/msix-set-app-pricing-other-types.png ✅Succeeded
hub/apps/publish/toc.yml ✅Succeeded

For more details, please refer to the build report.

Copy link
Contributor

PRMerger Results

Issue Description
Added File(s) This PR contains added files. New files require human review.
Deleted File(s) This PR deletes Markdown or YAML files owned by another author, or json file(s). The pull request must contain a comment from the pull request author confirming that all the file deletions are intentional before the pull request can be merged.
Yaml File(s) This PR includes changes to .yml file(s) owned by another author.
Changed Files This PR contains more than 10 changed files.
File Change Percent This PR contains file(s) with more than 30% file change.
Image File This PR added or updated an image file(s).

learn-build-service-prod bot added a commit that referenced this pull request Jun 6, 2025
…c_temp

For protected branch, push strategy should use PR and merge to target branch method to work around git push error
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants