Merge pull request #3269 from MicrosoftDocs/v-bhuvana

Add v1.1 info in "Using REST API for updating Add-ons"
MicrosoftDocs · Sep 24, 2024 · e73dc72 · e73dc72
2 parents 64c8b40 + d8dd8b8
commit e73dc72
Show file tree

Hide file tree

Showing 14 changed files with 572 additions and 177 deletions.
diff --git a/...soft-edge/extensions-chromium/developer-guide/alternate-distribution-options.md b/...soft-edge/extensions-chromium/developer-guide/alternate-distribution-options.md
@@ -9,33 +9,40 @@ ms.subservice: extensions
 ms.date: 05/05/2023
 ---
 # Alternative ways to distribute an extension
+<!-- alts:
+# Use alternative installation methods 
+per https://developer.chrome.com/docs/extensions/how-to/distribute/install-extensions
+-->
 
 Generally, extensions are distributed through the Microsoft Edge Add-ons website. There are some scenarios where developers may need to distribute extensions using alternate methods. For example:
 
 1. The extension is associated with other software, and it should be installed together with the rest of the bundled software.
 
 1. Network administrators want to distribute an extension throughout their organization.
 
-Extensions that aren't loaded from the Edge Add-ons store are referred to as externally installed extensions. The following are alternate methods of distributing externally installed extensions:
+Extensions that aren't loaded from the Edge Add-ons store are referred to as _externally installed extensions_. The following are alternate methods of distributing externally installed extensions:
 
-*  Use the Windows registry (Windows only).
-*  Use a preferences JSON file (macOS and Linux).
+* Use the Windows registry (Windows only).
+* Use a preferences JSON file (macOS and Linux).
 
 These approaches are described below.
 
+See also:
+* [Set an externally installed extension to automatically update](../publish/auto-update.md)
+
 
 <!-- ====================================================================== -->
-## Before you begin
+## Gather initial information
 
-Make sure that you publish your extension in the Microsoft Edge Add-ons website, or package a `.crx` file and ensure that it installs successfully on your computer.  If you install the `.crx` file using the `update_url`, make sure you can go to your extension at that URL.
+Make sure that you publish your extension in the Microsoft Edge Add-ons website<!-- todo: but Intro says: "Generally, extensions are distributed through the Microsoft Edge Add-ons website. There are some scenarios where developers may need to distribute extensions using alternate methods." -->, or package a `.crx` file and ensure that it installs successfully on your computer.  If you install the `.crx` file using the `update_url`, make sure you can go to your extension at that URL.
 
 Also, make sure that you have the following information:
 
-*  The file path of the `.crx` file, or the `update_url` of your extension.
+* The file path of the `.crx` file, or the `update_url` of your extension.
 
-*  The version of your extension.  The version information is available in your manifest file, or in Microsoft Edge at `edge://extensions` after you load the packed extension.
+* The version of your extension.  The version information is available in your manifest file, or in Microsoft Edge at `edge://extensions` after you load the packed extension.
 
-*  The ID of your extension.  The ID information is available in Microsoft Edge at `edge://extensions` after you load the packed extension.
+* The ID of your extension.  The ID information is available in Microsoft Edge at `edge://extensions` after you load the packed extension.
 
 The following examples use `1.0` as the version, and `aaaaaaaabbbbbbbbccccccccdddddddd` for the ID.
 
@@ -45,24 +52,23 @@ The following examples use `1.0` as the version, and `aaaaaaaabbbbbbbbccccccccdd
 
 To distribute your extension using the Windows registry:
 
-1. Find or create the following key in the registry:
-   *  32-bit Windows: `HKEY_LOCAL_MACHINE\Software\Microsoft\Edge\Extensions`
-   *  64-bit Windows: `HKEY_LOCAL_MACHINE\Software\Wow6432Node\Microsoft\Edge\Extensions`
+1.  Find or create the following key in the registry:
+    *   32-bit Windows: `HKEY_LOCAL_MACHINE\Software\Microsoft\Edge\Extensions`
+    *   64-bit Windows: `HKEY_LOCAL_MACHINE\Software\Wow6432Node\Microsoft\Edge\Extensions`
 
-1. Create a new key, or folder, under **Extensions** with the same name as the ID of your extension. For example, create the key with the name `aaaaaaaabbbbbbbbccccccccdddddddd`.
+1.  Create a new key, or folder, under **Extensions** with the same name as the ID of your extension. For example, create the key with the name `aaaaaaaabbbbbbbbccccccccdddddddd`.
 
-1. In the **Extensions** key, create the `update_url` property, and set the value to `https://edge.microsoft.com/extensionwebstorebase/v1/crx`.  The `update_url` property points to the `.crx` file of your extension in the Microsoft Edge Add-ons website.
+1.  In the **Extensions** key, create the `update_url` property, and set the value to `https://edge.microsoft.com/extensionwebstorebase/v1/crx`.  The `update_url` property points to the `.crx` file of your extension in the Microsoft Edge Add-ons website.
 
-   ```json
-   {
-       "update_url": "https://edge.microsoft.com/extensionwebstorebase/v1/crx"
-   }
-   ```
+    ```json
+    {
+        "update_url": "https://edge.microsoft.com/extensionwebstorebase/v1/crx"
+    }
+    ```
 
-   > [!NOTE]
-   > If you want to install an extension from the Chrome Web Store, set the value of `update_url` to `https://clients2.google.com/service/update2/crx`.
+    If you want to install an extension from the Chrome Web Store, set the value of `update_url` to `https://clients2.google.com/service/update2/crx`.
 
-1. In Microsoft Edge, go to `edge://extensions`, and then verify that your extension is listed.
+1.  In Microsoft Edge, go to `edge://extensions`, and then verify that your extension is listed.
 
 
 <!-- ====================================================================== -->
@@ -78,62 +84,62 @@ To distribute your extension by using a preferences JSON file:
 
 1. Depending on your operating system, save the JSON file to one of the following folders:
 
-    *  **macOS**
-        *  User-specific: `~USERNAME/Library/Application Support/Microsoft Edge/External Extensions/`
-        *  For all users: `/Library/Application Support/Microsoft/Edge/External Extensions/`
+   *  **macOS**
+      * User-specific: `~USERNAME/Library/Application Support/Microsoft Edge/External Extensions/`
+      * For all users: `/Library/Application Support/Microsoft/Edge/External Extensions/`
 
-        To prevent unauthorized users from installing extensions for all users, make sure your extension preferences file is read-only.
+      To prevent unauthorized users from installing extensions for all users, make sure your extension preferences file is read-only.
 
-        Also make sure that the following conditions are met:
+      Also make sure that the following conditions are met:
 
-        *  Every directory in the path is owned by the user root.
-        *  Every directory in the path is assigned to the `admin` or `wheel` group.
-        *  Every directory in the path isn't `world` writable.
-        *  The path must be free of symbolic links.
+      * Every directory in the path is owned by the user root.
+      * Every directory in the path is assigned to the `admin` or `wheel` group.
+      * Every directory in the path isn't `world` writable.
+      * The path must be free of symbolic links.
 
-    *  **Linux**
-        *  User-specific: `~/.config/microsoft-edge/External Extensions/`
-        *  For all users: `/usr/share/microsoft-edge/extensions/`
+   *  **Linux**
+      * User-specific: `~/.config/microsoft-edge/External Extensions/`
+      * For all users: `/usr/share/microsoft-edge/extensions/`
 
 1. Depending on your scenario, copy the appropriate code that follows, into your preferences JSON file.
 
-    *  Applies to Linux only.  If you install from a file, specify the location and version in `external_crx` and `external_version`:
+   *  Applies to Linux only.  If you install from a file, specify the location and version in `external_crx` and `external_version`:
 
-        ```json
-        {
-            "external_crx": "/home/share/extension.crx",
-            "external_version": "1.0"
-        }
-        ```
+      ```json
+      {
+         "external_crx": "/home/share/extension.crx",
+         "external_version": "1.0"
+      }
+      ```
 
-    *  Applies to macOS and Linux.  If you install from an `update_url`, specify the update URL in `external_update_url`.
+   *  Applies to macOS and Linux.  If you install from an `update_url`, specify the update URL in `external_update_url`.
 
-       Copy the following code into your preferences JSON file when installing from local `.crx` files on Linux only:
+      Copy the following code into your preferences JSON file when installing from local `.crx` files on Linux only:
 
-       ```json
-       {
-           "external_update_url": "http://myhost.com/mytestextension/updates.xml"
-       }
-       ```
+      ```json
+      {
+         "external_update_url": "http://myhost.com/mytestextension/updates.xml"
+      }
+      ```
 
-    *  Copy the following code to your preferences JSON file when installing from the Microsoft Edge Add-ons website on macOS and Linux:
+   *  Copy the following code to your preferences JSON file when installing from the Microsoft Edge Add-ons website on macOS and Linux:
 
-       ```json
-       {
-           "external_update_url": "https://edge.microsoft.com/extensionwebstorebase/v1/crx"
-       }
-       ```
+      ```json
+      {
+         "external_update_url": "https://edge.microsoft.com/extensionwebstorebase/v1/crx"
+      }
+      ```
 
 1. To install extensions for specific locales, list the supported locales, in `supported_locales`.
 
    You can specify parent locales, to install your extension for all language locales that use that parent.  For example, when using the parent locale `en`, your extension installs for all English locales, such as `en-US`, `en-GB`, and so on.  When users change their locale in their browser, externally installed extensions are uninstalled.  To install your extension for _any_ locale, don't use `supported_locales`.
 
-    ```json
-    {
-        "external_update_url": "https://edge.microsoft.com/extensionwebstorebase/v1/crx",
-        "supported_locales": [ "en", "fr", "de" ]
-    }
-    ```
+   ```json
+   {
+      "external_update_url": "https://edge.microsoft.com/extensionwebstorebase/v1/crx",
+      "supported_locales": [ "en", "fr", "de" ]
+   }
+   ```
 
 1. Verify that your extension is installed in Microsoft Edge, by going to `edge://extensions`.
 
@@ -147,8 +153,8 @@ To update your extension to a new version, update the `version` string in the ex
 
 You may need to uninstall externally installed extensions, which were installed as part of a bundle of software that was previously installed on the machine.  To uninstall your extension, remove your preferences JSON file or remove the key from the registry.
 
-
 See also:
+* [Set an externally installed extension to automatically update](../publish/auto-update.md)
 * [Manifest file format for extensions](../getting-started/manifest-format.md)
 
 
@@ -160,6 +166,24 @@ The policies for `ExtensionInstallForcelist`, block list, and `ExtensionSettings
 If the `BlockExternalExtensions` policy is set to `Not Configured` or `Disabled`, that doesn't have any effect.  If the `BlockExternalExtensions` policy is set to `Enabled`, external extension installation (by third party software) is prevented.
 
 
+<!-- ====================================================================== -->
+## See also
+<!-- all links in article -->
+
+* [Set an externally installed extension to automatically update](../publish/auto-update.md)
+* [Manifest file format for extensions](../getting-started/manifest-format.md)
+
+Microsoft Edge Enterprise docs:
+* [Microsoft Edge - Policies](/deployedge/microsoft-edge-policies)
+   * [ExtensionInstallForcelist](/deployedge/microsoft-edge-policies#extensioninstallforcelist)
+   * [ExtensionInstallSources](/deployedge/microsoft-edge-policies#extensioninstallsources)
+   * [ExtensionSettings](/deployedge/microsoft-edge-policies#extensionsettings)
+   * [BlockExternalExtensions](/deployedge/microsoft-edge-policies#blockexternalextensions)
+
+Chrome Extensions docs:
+* [Use alternative installation methods](https://developer.chrome.com/docs/extensions/how-to/distribute/install-extensions)<!-- todo: maybe remove link after update present article.  = [here] link below -->
+
+
 <!-- ====================================================================== -->
 > [!NOTE]
 > Portions of this page are modifications based on work created and [shared by Google](https://developers.google.com/terms/site-policies) and used according to terms described in the [Creative Commons Attribution 4.0 International License](https://creativecommons.org/licenses/by/4.0).  The original page is found [here](https://developer.chrome.com/docs/extensions/how-to/distribute/install-extensions).

diff --git a/microsoft-edge/extensions-chromium/developer-guide/api-support.md b/microsoft-edge/extensions-chromium/developer-guide/api-support.md
@@ -133,4 +133,4 @@ This work is licensed under a [Creative Commons Attribution 4.0 International Li
 
 * [Chrome Extensions API reference for Manifest V2](https://developer.chrome.com/docs/extensions/mv2/reference/)
 * [Chrome Extensions API reference for Manifest V3](https://developer.chrome.com/docs/extensions/reference/api/)
-* [Using the Microsoft Edge Add-ons REST API](../publish/api/using-addons-api.md) - to update an extension at the Microsoft Edge Add-ons website.
+* [Using the REST API for updating Microsoft Edge Add-ons](../publish/api/using-addons-api.md) - to update an extension at the Microsoft Edge Add-ons website.
diff --git a/microsoft-edge/extensions-chromium/getting-started/part1-simple-extension.md b/microsoft-edge/extensions-chromium/getting-started/part1-simple-extension.md
@@ -16,11 +16,7 @@ The goal for this tutorial is to build a Microsoft Edge extension, starting with
 *   Adding icons.
 *   Opening a default pop-up dialog.
 
-
-<!-- ====================================================================== -->
-## Before you begin
-
-To test out the completed extension that you are building in this tutorial, download the source code from [MicrosoftEdge-Extensions repo > extension-getting-started-part1](https://github.com/microsoft/MicrosoftEdge-Extensions/tree/main/Extension%20samples/extension-getting-started-part1/part1). The source code has been updated from Manifest V2 to Manifest V3.
+If you want to test out the completed extension that you are building in this tutorial, download the source code from [MicrosoftEdge-Extensions repo > extension-getting-started-part1](https://github.com/microsoft/MicrosoftEdge-Extensions/tree/main/Extension%20samples/extension-getting-started-part1/part1). The source code has been updated from Manifest V2 to Manifest V3.
 
 
 <!-- ====================================================================== -->

diff --git a/microsoft-edge/extensions-chromium/landing/index.yml b/microsoft-edge/extensions-chromium/landing/index.yml
@@ -177,15 +177,15 @@ landingContent:
           - text: Update a Microsoft Edge extension
             url: ../publish/update-extension.md
 
-          - text: Set an extension to automatically update
+          - text: Set an externally installed extension to automatically update
             url: ../publish/auto-update.md
 
-          - text: Using the Microsoft Edge Add-ons REST API
+          - text: Using the REST API for updating Microsoft Edge Add-ons
             url: ../publish/api/using-addons-api.md
 
       - linkListType: reference
         links:
-          - text: REST API Reference for Microsoft Edge Add-ons
+          - text: REST API Reference for updating Microsoft Edge Add-ons
             url: ../publish/api/addons-api-reference.md
 
 # =============================================================================