Merge pull request #7576 from umbraco/merge-v16-changes-to-v17

Cherry pick changes from v16 to v17

Author: eshanrnh

17/umbraco-cms/.gitbook.yaml

@@ -148,4 +148,5 @@ redirects:
     fundamentals/backoffice/property-editors/built-in-umbraco-property-editors/date: fundamentals/backoffice/property-editors/built-in-umbraco-property-editors/date-time-editor/README.md
     customizing/extending-overview/extension-types/workspaces/workspace-action-menu-item: customizing/extending-overview/extension-types/workspaces/workspace-action-menu-items.md
     customizing/extending-overview/extension-types/workspaces/workspace-footer-app: customizing/extending-overview/extension-types/workspaces/workspace-footer-apps.md
+    customizing/extending-overview/extension-kind: customizing/extending-overview/extension-types/kind.md
 

17/umbraco-cms/SUMMARY.md

@@ -160,9 +160,9 @@
   * [Vite Package Setup](customizing/development-flow/vite-package-setup.md)
 * [Extensions Overview](customizing/extending-overview/README.md)
   * [Extension Registry](customizing/extending-overview/extension-registry/README.md)
+    * [Extension Manifest Introduction](customizing/extending-overview/extension-registry/extension-manifest.md)
     * [Register an Extension](customizing/extending-overview/extension-registry/register-extensions.md)
-    * [Extension Manifest](customizing/extending-overview/extension-registry/extension-manifest.md)
-    * [Replace, Exclude or Unregister](customizing/extending-overview/extension-registry/replace-exclude-or-unregister.md)
+    * [Replace, Exclude, or Unregister](customizing/extending-overview/extension-registry/replace-exclude-or-unregister.md)
   * [Extension Types](customizing/extending-overview/extension-types/README.md)
     * [App Entry Point](customizing/extending-overview/extension-types/app-entry-point.md)
     * [Backoffice Entry Point](customizing/extending-overview/extension-types/backoffice-entry-point.md)
@@ -197,7 +197,6 @@
       * [Workspace Views](customizing/extending-overview/extension-types/workspaces/workspace-views.md)
     * [Collections](customizing/extending-overview/extension-types/collections/README.md)
       * [Collection View](customizing/extending-overview/extension-types/collections/collection-view.md)
-  * [Extension Kind](customizing/extending-overview/extension-kind.md)
   * [Extension Conditions](customizing/extending-overview/extension-conditions.md)
   * [Custom Extension types](customizing/extending-overview/custom-extension-type.md)
 * [Foundation](customizing/foundation/README.md)

17/umbraco-cms/customizing/extending-overview/extension-kind.md

@@ -4,19 +4,23 @@ description: >-
 ---
 
 # Extension Registry
-The Umbraco backoffice is built with extensibility in mind. The backoffice without extensions is more or less a blank canvas that is build out using extensions. These extensions dictate how the backoffice functions and looks. All visual elements in an Umbraco installation, like the sections, menus, trees and buttons, are extensions. But extensions also dictate behaviour and the editing experience. So everything in the backoffice is governed (and extendable) by extensions.
+
+The Umbraco backoffice is built with extensibility in mind. The backoffice without extensions is more or less a blank canvas that is built out using extensions. These extensions dictate how the backoffice functions and looks. All visual elements in an Umbraco installation, like the sections, menus, trees, and buttons, are extensions. But extensions also dictate behavior and the editing experience. So everything in the backoffice is governed (and extendable) by extensions.
 
 {% hint style="info" %}
 You can see which extensions are registered in the backoffice by going to Settings > Extensions Insights.
 {% endhint %}
 
-All extensions are registered in the extension registry. The registry can be manipulated at any time, meaning you can add or remove extensions at runtime. You as a developer have the same possibilities as an Umbraco HQ developer, which means what HQ can do, you can do. This also means that you can change almost everything that is by default present in Umbraco. 
+All extensions are registered in the extension registry. The registry can be manipulated at any time, meaning you can add or remove extensions at runtime. You, as a developer, have the same possibilities as an Umbraco HQ developer, which means that what HQ can do, you can do. This also means that you can change almost everything that is by default present in Umbraco.
+
+## [Introduction to Extension Manifest](extension-manifest.md)
 
-## [Introduction to a Extension Manifest](extension-manifest.md)
-An Extension Manifest is a declaration of what you want to register in the Umbraco backoffice. This articles handles the layout and requirements of an Extension Manifest.
+An Extension Manifest is a declaration of what you want to register in the Umbraco backoffice. This article handles the layout and requirements of an Extension Manifest.
 
-## [Register an extension](extension-registry.md)
-This article handles how to register an extension using an umbraco-package.json file.
+## [Register an Extension](extension-registry.md)
+
+This article handles how to register an extension using an `umbraco-package.json` file.
 
 ## [Change an existing extension](replace-exclude-or-unregister.md)
+
 Once you understand how to declare your own, you may want to replace or remove existing ones.

17/umbraco-cms/customizing/extending-overview/extension-registry/README.md

@@ -3,19 +3,24 @@ description: Learn about the different methods for declaring an Extension Manife
 ---
 
 # Extension Manifest
+
 This page explains what an Extension Manifest for a Umbraco backoffice extension is. It outlines the manifest structure, required fields, and optional features used across types.
 
 ## What is an Extension Manifest?
+
 Umbraco reads the extension manifest to register the extension in the Extension Registry.
 Each extension is of a certain type and this determines the required fields of the manifest and its available capabilities.
 An Extension Manifest declares a single backoffice extension along with its configuration.
 
 ## Extension Manifest Format
+
 Some extensions need extra assets, such as a JavaScript file with a Web Component.
 
 The abilities of the extensions rely on the specific extension type. The type sets the scene for what the extension can do and what it needs to be utilized. Some extension types can be made purely via the manifest, like a section or menu item. Other types require files, like a JavaScript file containing a Web Component, like a custom property editor.
 An Extension Manifest has a strict format where some properties are required and some depend on the Extension Type. An Extension Manifest can be written as a JavaScript or JSON object. You can learn more about this when [registering an extension](register-extensions.md).
-### Required Manifest properties
+
+### Required Manifest Properties
+
 A minimal Extension Manifest looks like this:
 
 ```json
@@ -32,12 +37,13 @@ These fields are all required and have the following meaning:
 * `alias` — Unique identifier for this manifest. Prefix it with something that makes your extension unique. For example: _FictiveCompany.MyProject.Dashboard.Overview_.
 * `name` — Representational name of this manifest. This name does not need to be unique, but this can be beneficial when debugging extensions. This name also shows up in the Extensions Insights in the backoffice of Umbraco. For example: _My Fictive Company Overview Dashboard_.
 
-### Additional Manifest properties
+### Additional Manifest Properties
+
 Most extension types support the use of the following generic features for their Manifest:
 
 * `weight` - Define a weight to determine the importance or visual order of this extension. A higher weight gives a more prominent position. For instance, for a dashboard it determines its order between other dashboards.
 * `overwrites` - If you want to omit an existing extension, then define one or more Extension Aliases that this extension should omit when presented. Read more in [Replace, Exclude or Unregister extensions](replace-exclude-or-unregister.md).
-* `conditions` - Define one or more conditions that must pass for the extension to become available. For instance, don't show a section if you don't have the proper rights. Read more in [Extension Conditions](../extension-conditions.md). 
+* `conditions` - Define one or more conditions that must pass for the extension to become available. For instance, don't show a section if you don't have the proper rights. Read more in [Extension Conditions](../extension-conditions.md).
 * `kind` - Some extension types can reference a predefined `kind`. By specifying a `kind`, the manifest inherits the `kind`'s properties. This allows for reuse of predefined settings. See [Extension Kind](../extension-kind.md).
 * `meta` - Many Extension Types require additional information declared as part of a `meta` field. It depends on the Extension Type what is required. For instance label and icon of a menu item.
 

17/umbraco-cms/customizing/extending-overview/extension-registry/extension-manifest.md

@@ -5,10 +5,12 @@ description: >-
 ---
 
 
-# Register Extensions
+# Register an Extension
+
 Making extensions to either an Umbraco project or a package requires an umbraco-package.json file. This JSON file is the starting point for any extension.
 
 ## Umbraco-package.json
+
 To get extensions registered in Umbraco, you need to have an `umbraco-package.json` file. This file must be located in or in a subfolder of either the `App_Plugins` folder or the `wwwroot` folder. It's recommended to place the file in `App_Plugins/#YOUR_EXTENSION_NAME#/umbraco-package.json`, or in `wwwroot/App_Plugins/#YOUR_EXTENSION_NAME#/umbraco-package.json` for packages and Razor Class Libraries. Umbraco scans for these files on boot and reads the [`Extension Manifests`](extension-manifest.md) that are present in the file to register the extensions.
 
 {% hint style="info" %}
@@ -32,7 +34,6 @@ Extensions can also work outside of the context of a package.
 ```
 {% endcode %}
 
-
 When writing the Umbraco Package Manifest, you can use the JSON schema located in the root of your Umbraco project. This file is called `umbraco-package-schema.json`.
 
 {% code title="umbraco-package.json" %}
@@ -47,13 +48,11 @@ When writing the Umbraco Package Manifest, you can use the JSON schema located i
 ```
 {% endcode %}
 
-
 There are two additional, optional properties that can be useful:
 
 * `id` - a unique identifier of the package. If you are creating a NuGet package, use this value as the id.
 * `version` - the version of the package that is displayed in the backoffice in the overview of installed packages. This is also used for package migrations.
 
-
 This is an example of a full `umbraco-package.json` that registers two localization extensions:
 
 ```json
@@ -85,22 +84,24 @@ This is an example of a full `umbraco-package.json` that registers two localizat
 }
 ```
 
-
 ## Advanced Registration
+
 ### The Bundle Approach
+
 Instead of registering each manifest in the `umbraco-package.json`, you can have multiple manifests and build them into a bundle. You then register this bundle in a single `bundle` extension. In larger projects with a lot of extensions, this allows you to keep your `umbraco-package.json` file cleaner. Read more in the [bundle approach](../extension-types/bundle.md).
 
 ### The Entry Point Approach
+
 The Entry Point is an extension that executes a method on startup. You can use this for different tasks, such as performing initial configuration and registering other Extension Manifests. Read more in [the entry point approach](../extension-types/backoffice-entry-point.md).
 
-### Registration with JavaScript on the Fly
-In some cases, extensions are not static and cannot be registered in the umbraco-package.json or in a bundle.  Here are some examples of these cases:
+### Registration with JavaScript
 
-- your manifest might be defined based on information from the server
-- you might generate the manifests server side based on data in the database. 
+In some cases, extensions are not static and cannot be registered in the `umbraco-package.json` or in a bundle. Here are some examples of these cases:
 
-In cases such as these, you need to register extensions on the fly.
+* Manifest might be defined based on information from the server.
+* Might generate the manifests server side based on data in the database.
 
+In cases such as these, you need to register extensions.
 
 The following example shows how to register an Extension Manifest via JavaScript/TypeScript code:
 
@@ -116,5 +117,4 @@ const manifest = {
 umbExtensionsRegistry.register(manifest);
 ```
 
-
 When and where you execute this code depends on your situation. In many cases, it makes sense to execute this on boot, using the [entry point approach](../extension-types/backoffice-entry-point.md).

17/umbraco-cms/customizing/extending-overview/extension-registry/register-extensions.md

@@ -5,17 +5,15 @@ description: >-
 ---
 
 
-# Replace, Exclude or Unregister
-Besides adding extensions to Umbraco, sometimes you want to change what is already there. You can replace extensions with your own and exclude or unregister extensions.
+# Replace, Exclude, or Unregister
 
+Besides adding extensions to Umbraco, sometimes you want to change what is already there. You can replace extensions with your own and exclude or unregister extensions.
 
 ## Replace
+
 You can replace an existing extension by another one.
 You can do this by defining the `overwrites` property in your [Extension Manifest](extension-manifest.md) with one Extension Alias. For multiple `overwrites` you can provide the Extension Aliases that need to be replaced as an array.
 
-
-
-
 This example overrides the `save and preview` button with an external "preview" button (single overwrite):
 
 ```typescript
@@ -28,7 +26,6 @@ const manifest = {
 };
 ```
 
-
 This example overrides both the `save and preview` button as well as the `save` button with an external "preview" button (multiple overwrite):
 
 ```typescript
@@ -41,19 +38,16 @@ const manifest = {
 };
 ```
 
-
 If your extension has conditions, the overwritten extensions will only be hidden when your extension is displayed. This means that the overwrites only have an effect if all the conditions are permitted and the extensions are displayed at the same spot.
 
-
 ## Exclude
-When you exclude an extension, the extension will never be displayed. This allows you to permanently hide, for example, a menu or a button. This does not unregister the extension, but rather flags it as excluded. This also means that no one else can register an extension with the same alias as the excluded extension.
 
+When you exclude an extension, the extension will never be displayed. This allows you to permanently hide, for example, a menu or a button. This does not unregister the extension, but rather flags it as excluded. This also means that no one else can register an extension with the same alias as the excluded extension.
 
 {% hint style="warning" %}
 Currently, it is not possible to un-exclude extensions once excluded.
 {% endhint %}
 
-
 The following JavaScript code hides the `Save and Preview` button from the Document Workspace.
 
 ```typescript
@@ -64,8 +58,8 @@ UmbExtensionRegistry.exclude('Umb.WorkspaceAction.Document.SaveAndPreview');
 
 When and where you execute this code depends on your situation. In many cases, it makes sense to execute this on boot, using the [entry point approach](../extension-types/backoffice-entry-point.md).
 
-
 ## Unregister
+
 You can also choose to unregister an extension. You should only use this on extensions you registered yourself and have control over. Otherwise, you might try to remove an extension before it is registered. A use case for this, is if you temporarily registered an extension and you want to remove it again.
 
 In other cases, you can use the `overwrites` or `exclude` option. The difference with the `exclude` approach is that unregistering removes the extension from the Extension Registry. This allows you to re-register extensions with the same alias.
@@ -76,7 +70,4 @@ import { umbExtensionsRegistry } from '@umbraco-cms/backoffice/extension-registr
 umbExtensionsRegistry.unregister('My.WorkspaceAction.AutoFillWithUnicorns');
 ```
 
-
 When and where you execute this code depends on your situation. In many cases, it makes sense to execute this on boot, using the [entry point approach](../extension-types/backoffice-entry-point.md).
-
-