From d0b921f43f80922c4391c69f8598d7c9ffb768d9 Mon Sep 17 00:00:00 2001 From: Jesper Mayntzhusen Date: Sat, 12 Oct 2024 11:56:55 +0200 Subject: [PATCH 1/5] Cleanup v14 docs --- 14/umbraco-cms/extending/packages/README.md | 4 -- .../packages/good-practice-and-defaults.md | 4 +- .../installing-and-uninstalling-packages.md | 44 +------------ .../extending/packages/types-of-packages.md | 63 ------------------- 4 files changed, 3 insertions(+), 112 deletions(-) delete mode 100644 14/umbraco-cms/extending/packages/types-of-packages.md diff --git a/14/umbraco-cms/extending/packages/README.md b/14/umbraco-cms/extending/packages/README.md index 3cedca25ff2..bb9c6ac7fff 100644 --- a/14/umbraco-cms/extending/packages/README.md +++ b/14/umbraco-cms/extending/packages/README.md @@ -45,10 +45,6 @@ Workspace Views are almost like dashboards for content nodes that are intended t This type of package can be a lot of things, and can include a number of the other package types. They are generally integrating a larger system into Umbraco. A good example could be an e-commerce package such as [Umbraco Commerce](https://docs.umbraco.com/umbraco-commerce), that includes an entire webshop module for Umbraco. -## [Types of Packages](types-of-packages.md) - -Packages for Umbraco 10 and above are installed as NuGet packages. - ## [Creating a Package](creating-a-package.md) This short tutorial will teach you how to create a package in the Umbraco backoffice. It will also give a quick overview of what a generated package will contain. diff --git a/14/umbraco-cms/extending/packages/good-practice-and-defaults.md b/14/umbraco-cms/extending/packages/good-practice-and-defaults.md index 19deeca3ecf..6df4d526d69 100644 --- a/14/umbraco-cms/extending/packages/good-practice-and-defaults.md +++ b/14/umbraco-cms/extending/packages/good-practice-and-defaults.md @@ -46,7 +46,7 @@ The `/umbraco/Licenses` folder does not exist on a fresh installation of Umbraco ## Operating system considerations -Umbraco (version 9 and up) is an ASP.NET Core application and can be run on multiple operating systems (Windows, Linux and macOS). When developing packages there are a few things you should be aware of for your package to run on all possible operating systems. +Umbraco is an .NET application and can be run on multiple operating systems (Windows, Linux and macOS). When developing packages there are a few things you should be aware of for your package to run on all possible operating systems. ### Case sensitivity @@ -69,7 +69,7 @@ Some folders within Umbraco will already exist for all installations. If you acc | Folder | Note | | ---------------------- | ------------------------------------------------------------------------------------- | | /App\_Plugins | Uppercase `A` and `P` | -| /App\_Plugins/\[Ll]ang | Uppercase `L` (in Umbraco 9.3 and higher can be either uppercase `L` or lowercase `l` | +| /App\_Plugins/\[Ll]ang | Uppercase `L` | | /Views | Uppercase `V` | | /umbraco/Licenses | Lowercase `u` and uppercase `L` | | /config | Lowercase `c` | diff --git a/14/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md b/14/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md index bcea06c4500..e132651cd2e 100644 --- a/14/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md +++ b/14/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md @@ -1,28 +1,19 @@ --- description: >- The process of installing and, in turn, uninstalling packages in your Umbraco - CMS website depends on the version and package type. + CMS website. --- # Installing and Uninstalling Packages This article will cover the process of installing as well as uninstalling packages from your Umbraco CMS website. -As the article will cover both NuGet packages and zip file packages, it is important to know the distinction: - -* **NuGet packages**: Modern Umbraco (Umbraco 10+) and Legacy Umbraco (Umbraco 8 and earlier versions). -* **Package zip files**: Legacy Umbraco (Umbraco 8 and earlier versions) only. - -Learn more about the different types of packages in the [Types of packages](types-of-packages.md) article. - ## Installing packages In the Umbraco Backoffice, you will find a **Packages** section that displays the [Umbraco Marketplace](https://marketplace.umbraco.com/). From here you can browse all community-made as well as official Umbraco packages for the Umbraco CMS. ![Backoffice - Packages section](images/backoffice-packages-section.png) -{% tabs %} -{% tab title="NuGet package" %} Navigating to a specific package in the section will present you with an overview of the package, as well as an install snippet for NuGet CLI. ![Backoffice - Starter Kit package](images/backoffice-packages-section-package.png) @@ -48,31 +39,6 @@ The Package Manager has an integrated search function that allows you to find an Once the package has been installed, it will show up under the **Packages** section in the backoffice, under **Installed** tab. ![Backoffice - installed packages](../../../../10/umbraco-cms/extending/packages/images/backoffice-installed-packages.png) -{% endtab %} - -{% tab title="Package zip file" %} -{% hint style="warning" %} -Package zip files are only available for Umbraco 8 or earlier versions. -{% endhint %} - -Once you have downloaded an Umbraco package zip file, you can install it in the Umbraco backoffice by following the steps below: - -* Navigate to the **Packages** section. -* Select **Install local** on the top-right side of the page. -* Drag'n drop the package onto the page or use the file explorer to select the package zip file. -* Accept terms of use to confirm the package installation. - -The package will be installed and any necessary reboots of the site will be initiated. - -You can also install packages directly when browsing the packages in the Umbraco backoffice. This is usually preferred in order to ensure that the package is compatible with the Umbraco CMS version used. - -* Navigate to the specific package you want to install. -* Click **Install package** in the right-hand side of the page. -* Confirm the installation. - -The package will be install and the site will be rebooted. -{% endtab %} -{% endtabs %} ## Uninstalling packages @@ -94,14 +60,6 @@ To uninstall a package, either run a command or use the NuGet Package Manager in ![Visual Studio - uninstalling via Package Manager](images/uninstalling-via-nuget-package-manager.png) -{% hint style="info" %} -If you are using Umbraco 8 or an earlier version you uninstall the packages directly from the **Packages** section of the Umbraco backoffice. - -1. Navigate to the **Installed** tab in the **Packages** section. -2. Click **Uninstall package** next to the package you want to uninstall. -3. Confirm that action by checking **Confirm package uninstall**. -{% endhint %} - It is recommended to clean the solution after removing any package. This can be done by right-clicking the project in Visual Studio and choosing the _Clean_ option, or using the `dotnet clean` command. ![Visual Studio - clean solution](images/vs-cleaning-solution.png) diff --git a/14/umbraco-cms/extending/packages/types-of-packages.md b/14/umbraco-cms/extending/packages/types-of-packages.md deleted file mode 100644 index 6007cb835e5..00000000000 --- a/14/umbraco-cms/extending/packages/types-of-packages.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -description: >- - Depending on which version of Umbraco CMS you are using, we distinguish - between two package types, NuGet packages, and Package ZIP files. ---- - -# Package Types - -There are two main ways to install packages in Umbraco CMS: Package zip files and NuGet packages. - -{% hint style="warning" %} -The zip file package type is only available for Umbraco version 8 and earlier versions. Learn more about it in the [Package zip Files](types-of-packages.md#package-zip-files) section of this article. -{% endhint %} - -When developing a package you need to consider the Umbraco CMS version you're using before determining the package type. - -* Modern Umbraco (Umbraco 10+): Providing a NuGet package is the only option. -* Legacy Umbraco (Umbraco 8 and earlier versions): It is recommended to provide both a zip file and a NuGet package. - -## NuGet Packages - -A NuGet package is a standard way of delivering compiled code and configuration to a .NET project. NuGet packages contain dll-files and other files required for the solution. For more information on NuGet packages see Microsoft's [An introduction to NuGet](https://docs.microsoft.com/en-us/nuget/what-is-nuget) documentation. - -NuGet packages can be installed using via the command line or through Visual Studio using either the [Package Manager Console](https://docs.microsoft.com/en-us/nuget/consume-packages/install-use-packages-powershell) or the [NuGet Package Manager](https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-visual-studio). - -See below, for an example of installing a package using the Package Manager Console in Visual Studio: - -```powershell -PM> Install-Package MyPackage -version 1.2 -``` - -NuGet packages can include any solution files and can be configured to run PowerShell scripts after installation. - -As NuGet packages are installed outside of the Umbraco website they cannot directly manipulate any of the Umbraco settings or content during their installation. - -When adding or changing configuration of Umbraco as part of a NuGet package you need to develop code to run as part of a [Migration](../database.md). The Migration will run the first time the Umbraco site starts after the package is installed, applying the correct configuration. - -## Package zip files - -{% hint style="warning" %} -Zip file packages are only available for Umbraco CMS 8 and earlier versions. - -Refer to the [NuGet Packages](types-of-packages.md#nuget-packages) section above, if your website is using Umbraco 10 or a later version. -{% endhint %} - -A package zip file can be installed directly through the Umbraco backoffice. - -![Zip packages can be installed via the Umbraco backoffice package section](images/backoffice-package-section.png) - -Packages zip files can contain: - -* Content -* Solutions files (`dll`s, `App_Plugins` files, etc) -* Document Types -* Templates -* Stylesheets -* Languages -* Dictionary Items -* Data Types -* Media - -{% hint style="info" %} -To include media in your package, select it in the "Media" section. Additionally, choose it in the "Package Files" section under "Path to file."{% endhint %} From be775a4f1aebde214c1c7c2564987d371d0aa843 Mon Sep 17 00:00:00 2001 From: Jesper Mayntzhusen Date: Sat, 12 Oct 2024 12:04:06 +0200 Subject: [PATCH 2/5] Cleanup v13 --- 13/umbraco-cms/extending/packages/README.md | 4 -- .../packages/good-practice-and-defaults.md | 4 +- .../installing-and-uninstalling-packages.md | 44 +------------ .../extending/packages/types-of-packages.md | 64 ------------------- 4 files changed, 3 insertions(+), 113 deletions(-) delete mode 100644 13/umbraco-cms/extending/packages/types-of-packages.md diff --git a/13/umbraco-cms/extending/packages/README.md b/13/umbraco-cms/extending/packages/README.md index 929f817fe52..1f6f9df9a32 100644 --- a/13/umbraco-cms/extending/packages/README.md +++ b/13/umbraco-cms/extending/packages/README.md @@ -46,10 +46,6 @@ Content apps are almost like dashboards for content nodes that are intended to d This type of package can be a lot of things, and can include a number of the other package types. They are generally integrating a larger system into Umbraco. A good example could be an e-commerce package such as [Umbraco Commerce](https://docs.umbraco.com/umbraco-commerce), that includes an entire webshop module for Umbraco. -## [Types of Packages](types-of-packages.md) - -Packages for Umbraco 10 and above are installed as NuGet packages. - ## [Creating a Package](creating-a-package.md) This short tutorial will teach you how to create a package in the Umbraco backoffice. It will also give a quick overview of what a generated package will contain. diff --git a/13/umbraco-cms/extending/packages/good-practice-and-defaults.md b/13/umbraco-cms/extending/packages/good-practice-and-defaults.md index b7fb3071337..3ebb057e785 100644 --- a/13/umbraco-cms/extending/packages/good-practice-and-defaults.md +++ b/13/umbraco-cms/extending/packages/good-practice-and-defaults.md @@ -42,7 +42,7 @@ The `/umbraco/Licenses` folder does not exist on a fresh installation of Umbraco ## Operating system considerations -Umbraco (version 9 and up) is an ASP.NET Core application and can be run on multiple operating systems (Windows, Linux and macOS). When developing packages there are a few things you should be aware of for your package to run on all possible operating systems. +Umbraco is a .NET application and can be run on multiple operating systems (Windows, Linux and macOS). When developing packages there are a few things you should be aware of for your package to run on all possible operating systems. ### Case sensitivity @@ -66,7 +66,7 @@ Some folders within Umbraco will already exist for all installations. If you acc | Folder | Note | |-|-| | /App_Plugins | Uppercase `A` and `P` | -| /App_Plugins/[Ll]ang | Uppercase `L` (in Umbraco 9.3 and higher can be either uppercase `L` or lowercase `l` | +| /App_Plugins/[Ll]ang | Uppercase `L` | | /Views | Uppercase `V` | | /umbraco/Licenses | Lowercase `u` and uppercase `L` | | /config | Lowercase `c` | diff --git a/13/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md b/13/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md index bcea06c4500..e132651cd2e 100644 --- a/13/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md +++ b/13/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md @@ -1,28 +1,19 @@ --- description: >- The process of installing and, in turn, uninstalling packages in your Umbraco - CMS website depends on the version and package type. + CMS website. --- # Installing and Uninstalling Packages This article will cover the process of installing as well as uninstalling packages from your Umbraco CMS website. -As the article will cover both NuGet packages and zip file packages, it is important to know the distinction: - -* **NuGet packages**: Modern Umbraco (Umbraco 10+) and Legacy Umbraco (Umbraco 8 and earlier versions). -* **Package zip files**: Legacy Umbraco (Umbraco 8 and earlier versions) only. - -Learn more about the different types of packages in the [Types of packages](types-of-packages.md) article. - ## Installing packages In the Umbraco Backoffice, you will find a **Packages** section that displays the [Umbraco Marketplace](https://marketplace.umbraco.com/). From here you can browse all community-made as well as official Umbraco packages for the Umbraco CMS. ![Backoffice - Packages section](images/backoffice-packages-section.png) -{% tabs %} -{% tab title="NuGet package" %} Navigating to a specific package in the section will present you with an overview of the package, as well as an install snippet for NuGet CLI. ![Backoffice - Starter Kit package](images/backoffice-packages-section-package.png) @@ -48,31 +39,6 @@ The Package Manager has an integrated search function that allows you to find an Once the package has been installed, it will show up under the **Packages** section in the backoffice, under **Installed** tab. ![Backoffice - installed packages](../../../../10/umbraco-cms/extending/packages/images/backoffice-installed-packages.png) -{% endtab %} - -{% tab title="Package zip file" %} -{% hint style="warning" %} -Package zip files are only available for Umbraco 8 or earlier versions. -{% endhint %} - -Once you have downloaded an Umbraco package zip file, you can install it in the Umbraco backoffice by following the steps below: - -* Navigate to the **Packages** section. -* Select **Install local** on the top-right side of the page. -* Drag'n drop the package onto the page or use the file explorer to select the package zip file. -* Accept terms of use to confirm the package installation. - -The package will be installed and any necessary reboots of the site will be initiated. - -You can also install packages directly when browsing the packages in the Umbraco backoffice. This is usually preferred in order to ensure that the package is compatible with the Umbraco CMS version used. - -* Navigate to the specific package you want to install. -* Click **Install package** in the right-hand side of the page. -* Confirm the installation. - -The package will be install and the site will be rebooted. -{% endtab %} -{% endtabs %} ## Uninstalling packages @@ -94,14 +60,6 @@ To uninstall a package, either run a command or use the NuGet Package Manager in ![Visual Studio - uninstalling via Package Manager](images/uninstalling-via-nuget-package-manager.png) -{% hint style="info" %} -If you are using Umbraco 8 or an earlier version you uninstall the packages directly from the **Packages** section of the Umbraco backoffice. - -1. Navigate to the **Installed** tab in the **Packages** section. -2. Click **Uninstall package** next to the package you want to uninstall. -3. Confirm that action by checking **Confirm package uninstall**. -{% endhint %} - It is recommended to clean the solution after removing any package. This can be done by right-clicking the project in Visual Studio and choosing the _Clean_ option, or using the `dotnet clean` command. ![Visual Studio - clean solution](images/vs-cleaning-solution.png) diff --git a/13/umbraco-cms/extending/packages/types-of-packages.md b/13/umbraco-cms/extending/packages/types-of-packages.md deleted file mode 100644 index 7c1e8145a36..00000000000 --- a/13/umbraco-cms/extending/packages/types-of-packages.md +++ /dev/null @@ -1,64 +0,0 @@ ---- -description: >- - Depending on which version of Umbraco CMS you are using, we distinguish - between two package types, NuGet packages, and Package ZIP files. ---- - -# Package Types - -There are two main ways to install packages in Umbraco CMS: Package zip files and NuGet packages. - -{% hint style="warning" %} -The zip file package type is only available for Umbraco version 8 and earlier versions. Learn more about it in the [Package zip Files](types-of-packages.md#package-zip-files) section of this article. -{% endhint %} - -When developing a package you need to consider the Umbraco CMS version you're using before determining the package type. - -* Modern Umbraco (Umbraco 10+): Providing a NuGet package is the only option. -* Legacy Umbraco (Umbraco 8 and earlier versions): It is recommended to provide both a zip file and a NuGet package. - -## NuGet Packages - -A NuGet package is a standard way of delivering compiled code and configuration to a .NET project. NuGet packages contain dll-files and other files required for the solution. For more information on NuGet packages see Microsoft's [An introduction to NuGet](https://docs.microsoft.com/en-us/nuget/what-is-nuget) documentation. - -NuGet packages can be installed using via the command line or through Visual Studio using either the [Package Manager Console](https://docs.microsoft.com/en-us/nuget/consume-packages/install-use-packages-powershell) or the [NuGet Package Manager](https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-visual-studio). - -See below, for an example of installing a package using the Package Manager Console in Visual Studio: - -```powershell -PM> Install-Package MyPackage -version 1.2 -``` - -NuGet packages can include any solution files and can be configured to run PowerShell scripts after installation. - -As NuGet packages are installed outside of the Umbraco website they cannot directly manipulate any of the Umbraco settings or content during their installation. - -When adding or changing configuration of Umbraco as part of a NuGet package you need to develop code to run as part of a [Migration](../database.md). The Migration will run the first time the Umbraco site starts after the package is installed, applying the correct configuration. - -## Package zip files - -{% hint style="warning" %} -Zip file packages are only available for Umbraco CMS 8 and earlier versions. - -Refer to the [NuGet Packages](types-of-packages.md#nuget-packages) section above, if your website is using Umbraco 10 or a later version. -{% endhint %} - -A package zip file can be installed directly through the Umbraco backoffice. - -![Zip packages can be installed via the Umbraco backoffice package section](images/backoffice-package-section.png) - -Packages zip files can contain: - -* Content -* Solutions files (`dll`s, `App_Plugins` files, etc) -* Document Types -* Templates -* Stylesheets -* Macros -* Languages -* Dictionary Items -* Data Types -* Media - -{% hint style="info" %} -To include media in your package, select it in the "Media" section. Additionally, choose it in the "Package Files" section under "Path to file."{% endhint %} From 40371f23b78ec3757299dceb94f819adf8f5d7c0 Mon Sep 17 00:00:00 2001 From: Jesper Mayntzhusen Date: Sat, 12 Oct 2024 12:07:03 +0200 Subject: [PATCH 3/5] cleanup v15 --- 15/umbraco-cms/extending/packages/README.md | 4 -- .../packages/good-practice-and-defaults.md | 4 +- .../installing-and-uninstalling-packages.md | 44 +------------ .../extending/packages/types-of-packages.md | 63 ------------------- 4 files changed, 3 insertions(+), 112 deletions(-) delete mode 100644 15/umbraco-cms/extending/packages/types-of-packages.md diff --git a/15/umbraco-cms/extending/packages/README.md b/15/umbraco-cms/extending/packages/README.md index 3cedca25ff2..bb9c6ac7fff 100644 --- a/15/umbraco-cms/extending/packages/README.md +++ b/15/umbraco-cms/extending/packages/README.md @@ -45,10 +45,6 @@ Workspace Views are almost like dashboards for content nodes that are intended t This type of package can be a lot of things, and can include a number of the other package types. They are generally integrating a larger system into Umbraco. A good example could be an e-commerce package such as [Umbraco Commerce](https://docs.umbraco.com/umbraco-commerce), that includes an entire webshop module for Umbraco. -## [Types of Packages](types-of-packages.md) - -Packages for Umbraco 10 and above are installed as NuGet packages. - ## [Creating a Package](creating-a-package.md) This short tutorial will teach you how to create a package in the Umbraco backoffice. It will also give a quick overview of what a generated package will contain. diff --git a/15/umbraco-cms/extending/packages/good-practice-and-defaults.md b/15/umbraco-cms/extending/packages/good-practice-and-defaults.md index f42c25048b6..2ef124b4ef8 100644 --- a/15/umbraco-cms/extending/packages/good-practice-and-defaults.md +++ b/15/umbraco-cms/extending/packages/good-practice-and-defaults.md @@ -46,7 +46,7 @@ The `/umbraco/Licenses` folder does not exist on a fresh installation of Umbraco ## Operating system considerations -Umbraco (version 9 and up) is an ASP.NET Core application and can be run on multiple operating systems (Windows, Linux and macOS). When developing packages there are a few things you should be aware of for your package to run on all possible operating systems. +Umbraco a .NET application and can be run on multiple operating systems (Windows, Linux and macOS). When developing packages there are a few things you should be aware of for your package to run on all possible operating systems. ### Case sensitivity @@ -69,7 +69,7 @@ Some folders within Umbraco will already exist for all installations. If you acc | Folder | Note | | ---------------------- | ------------------------------------------------------------------------------------- | | /App\_Plugins | Uppercase `A` and `P` | -| /App\_Plugins/\[Ll]ang | Uppercase `L` (in Umbraco 9.3 and higher can be either uppercase `L` or lowercase `l` | +| /App\_Plugins/\[Ll]ang | Uppercase `L` | | /Views | Uppercase `V` | | /umbraco/Licenses | Lowercase `u` and uppercase `L` | | /config | Lowercase `c` | diff --git a/15/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md b/15/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md index bcea06c4500..e132651cd2e 100644 --- a/15/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md +++ b/15/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md @@ -1,28 +1,19 @@ --- description: >- The process of installing and, in turn, uninstalling packages in your Umbraco - CMS website depends on the version and package type. + CMS website. --- # Installing and Uninstalling Packages This article will cover the process of installing as well as uninstalling packages from your Umbraco CMS website. -As the article will cover both NuGet packages and zip file packages, it is important to know the distinction: - -* **NuGet packages**: Modern Umbraco (Umbraco 10+) and Legacy Umbraco (Umbraco 8 and earlier versions). -* **Package zip files**: Legacy Umbraco (Umbraco 8 and earlier versions) only. - -Learn more about the different types of packages in the [Types of packages](types-of-packages.md) article. - ## Installing packages In the Umbraco Backoffice, you will find a **Packages** section that displays the [Umbraco Marketplace](https://marketplace.umbraco.com/). From here you can browse all community-made as well as official Umbraco packages for the Umbraco CMS. ![Backoffice - Packages section](images/backoffice-packages-section.png) -{% tabs %} -{% tab title="NuGet package" %} Navigating to a specific package in the section will present you with an overview of the package, as well as an install snippet for NuGet CLI. ![Backoffice - Starter Kit package](images/backoffice-packages-section-package.png) @@ -48,31 +39,6 @@ The Package Manager has an integrated search function that allows you to find an Once the package has been installed, it will show up under the **Packages** section in the backoffice, under **Installed** tab. ![Backoffice - installed packages](../../../../10/umbraco-cms/extending/packages/images/backoffice-installed-packages.png) -{% endtab %} - -{% tab title="Package zip file" %} -{% hint style="warning" %} -Package zip files are only available for Umbraco 8 or earlier versions. -{% endhint %} - -Once you have downloaded an Umbraco package zip file, you can install it in the Umbraco backoffice by following the steps below: - -* Navigate to the **Packages** section. -* Select **Install local** on the top-right side of the page. -* Drag'n drop the package onto the page or use the file explorer to select the package zip file. -* Accept terms of use to confirm the package installation. - -The package will be installed and any necessary reboots of the site will be initiated. - -You can also install packages directly when browsing the packages in the Umbraco backoffice. This is usually preferred in order to ensure that the package is compatible with the Umbraco CMS version used. - -* Navigate to the specific package you want to install. -* Click **Install package** in the right-hand side of the page. -* Confirm the installation. - -The package will be install and the site will be rebooted. -{% endtab %} -{% endtabs %} ## Uninstalling packages @@ -94,14 +60,6 @@ To uninstall a package, either run a command or use the NuGet Package Manager in ![Visual Studio - uninstalling via Package Manager](images/uninstalling-via-nuget-package-manager.png) -{% hint style="info" %} -If you are using Umbraco 8 or an earlier version you uninstall the packages directly from the **Packages** section of the Umbraco backoffice. - -1. Navigate to the **Installed** tab in the **Packages** section. -2. Click **Uninstall package** next to the package you want to uninstall. -3. Confirm that action by checking **Confirm package uninstall**. -{% endhint %} - It is recommended to clean the solution after removing any package. This can be done by right-clicking the project in Visual Studio and choosing the _Clean_ option, or using the `dotnet clean` command. ![Visual Studio - clean solution](images/vs-cleaning-solution.png) diff --git a/15/umbraco-cms/extending/packages/types-of-packages.md b/15/umbraco-cms/extending/packages/types-of-packages.md deleted file mode 100644 index 6007cb835e5..00000000000 --- a/15/umbraco-cms/extending/packages/types-of-packages.md +++ /dev/null @@ -1,63 +0,0 @@ ---- -description: >- - Depending on which version of Umbraco CMS you are using, we distinguish - between two package types, NuGet packages, and Package ZIP files. ---- - -# Package Types - -There are two main ways to install packages in Umbraco CMS: Package zip files and NuGet packages. - -{% hint style="warning" %} -The zip file package type is only available for Umbraco version 8 and earlier versions. Learn more about it in the [Package zip Files](types-of-packages.md#package-zip-files) section of this article. -{% endhint %} - -When developing a package you need to consider the Umbraco CMS version you're using before determining the package type. - -* Modern Umbraco (Umbraco 10+): Providing a NuGet package is the only option. -* Legacy Umbraco (Umbraco 8 and earlier versions): It is recommended to provide both a zip file and a NuGet package. - -## NuGet Packages - -A NuGet package is a standard way of delivering compiled code and configuration to a .NET project. NuGet packages contain dll-files and other files required for the solution. For more information on NuGet packages see Microsoft's [An introduction to NuGet](https://docs.microsoft.com/en-us/nuget/what-is-nuget) documentation. - -NuGet packages can be installed using via the command line or through Visual Studio using either the [Package Manager Console](https://docs.microsoft.com/en-us/nuget/consume-packages/install-use-packages-powershell) or the [NuGet Package Manager](https://learn.microsoft.com/en-us/nuget/consume-packages/install-use-packages-visual-studio). - -See below, for an example of installing a package using the Package Manager Console in Visual Studio: - -```powershell -PM> Install-Package MyPackage -version 1.2 -``` - -NuGet packages can include any solution files and can be configured to run PowerShell scripts after installation. - -As NuGet packages are installed outside of the Umbraco website they cannot directly manipulate any of the Umbraco settings or content during their installation. - -When adding or changing configuration of Umbraco as part of a NuGet package you need to develop code to run as part of a [Migration](../database.md). The Migration will run the first time the Umbraco site starts after the package is installed, applying the correct configuration. - -## Package zip files - -{% hint style="warning" %} -Zip file packages are only available for Umbraco CMS 8 and earlier versions. - -Refer to the [NuGet Packages](types-of-packages.md#nuget-packages) section above, if your website is using Umbraco 10 or a later version. -{% endhint %} - -A package zip file can be installed directly through the Umbraco backoffice. - -![Zip packages can be installed via the Umbraco backoffice package section](images/backoffice-package-section.png) - -Packages zip files can contain: - -* Content -* Solutions files (`dll`s, `App_Plugins` files, etc) -* Document Types -* Templates -* Stylesheets -* Languages -* Dictionary Items -* Data Types -* Media - -{% hint style="info" %} -To include media in your package, select it in the "Media" section. Additionally, choose it in the "Package Files" section under "Path to file."{% endhint %} From 9ebdb4c22c344117804851e26e6ded0421b28301 Mon Sep 17 00:00:00 2001 From: Jesper Mayntzhusen Date: Wed, 16 Oct 2024 09:35:40 +0200 Subject: [PATCH 4/5] Add rewrites and edit menu --- 13/umbraco-cms/.gitbook.yaml | 1 + 13/umbraco-cms/SUMMARY.md | 1 - 14/umbraco-cms/.gitbook.yaml | 3 ++- 14/umbraco-cms/SUMMARY.md | 1 - 15/umbraco-cms/.gitbook.yaml | 1 + 5 files changed, 4 insertions(+), 3 deletions(-) diff --git a/13/umbraco-cms/.gitbook.yaml b/13/umbraco-cms/.gitbook.yaml index 5acdbc0159f..af94e872a1d 100644 --- a/13/umbraco-cms/.gitbook.yaml +++ b/13/umbraco-cms/.gitbook.yaml @@ -8,3 +8,4 @@ redirects: tutorials/add-azure-active-directory-authentication: tutorials/add-microsoft-entra-id-authentication.md fundamentals/backoffice/property-editors/built-in-umbraco-property-editors/nested-content: fundamentals/backoffice/property-editors/built-in-umbraco-property-editors/block-editor/block-list-editor tutorials/editors-manual/working-with-content/rich-text-editor: tutorials/editors-manual/working-with-content.md + extending/packages/types-of-packages: extending/packages/README.md diff --git a/13/umbraco-cms/SUMMARY.md b/13/umbraco-cms/SUMMARY.md index 63969931894..5fc001e92b9 100644 --- a/13/umbraco-cms/SUMMARY.md +++ b/13/umbraco-cms/SUMMARY.md @@ -191,7 +191,6 @@ * [Using Azure Blob Storage for Media and ImageSharp Cache](extending/filesystemproviders/azure-blob-storage.md) * [Configuring Azure Key Vault](extending/key-vault.md) * [Packages](extending/packages/README.md) - * [Package Types](extending/packages/types-of-packages.md) * [Creating a Package](extending/packages/creating-a-package.md) * [Language file for packages](extending/packages/language-files-for-packages.md) * [Listing a Package on the Umbraco Marketplace](extending/packages/listing-on-marketplace.md) diff --git a/14/umbraco-cms/.gitbook.yaml b/14/umbraco-cms/.gitbook.yaml index 839aa8233aa..b7aa016250b 100644 --- a/14/umbraco-cms/.gitbook.yaml +++ b/14/umbraco-cms/.gitbook.yaml @@ -124,4 +124,5 @@ redirects: customize-the-backoffice/ui-library: customizing/ui-library.md customize-the-backoffice/umbraco-package: customizing/umbraco-package.md customize-the-backoffice/workspaces: customizing/workspaces.md - fundamentals/backoffice/property-editors/built-in-umbraco-property-editors/block-editor/build-a-custom-view-for-a-block: tutorials/creating-custom-views-for-blocklist.md \ No newline at end of file + fundamentals/backoffice/property-editors/built-in-umbraco-property-editors/block-editor/build-a-custom-view-for-a-block: tutorials/creating-custom-views-for-blocklist.md + extending/packages/types-of-packages: extending/packages/README.md \ No newline at end of file diff --git a/14/umbraco-cms/SUMMARY.md b/14/umbraco-cms/SUMMARY.md index 76517f46db6..11e533bb15b 100644 --- a/14/umbraco-cms/SUMMARY.md +++ b/14/umbraco-cms/SUMMARY.md @@ -233,7 +233,6 @@ * [Using Azure Blob Storage for Media and ImageSharp Cache](extending/filesystemproviders/azure-blob-storage.md) * [Configuring Azure Key Vault](extending/key-vault.md) * [Packages](extending/packages/README.md) - * [Package Types](extending/packages/types-of-packages.md) * [Creating a Package](extending/packages/creating-a-package.md) * [Language file for packages](extending/packages/language-files-for-packages.md) * [Listing a Package on the Umbraco Marketplace](extending/packages/listing-on-marketplace.md) diff --git a/15/umbraco-cms/.gitbook.yaml b/15/umbraco-cms/.gitbook.yaml index 16658e92984..094bb545459 100644 --- a/15/umbraco-cms/.gitbook.yaml +++ b/15/umbraco-cms/.gitbook.yaml @@ -103,3 +103,4 @@ redirects: fundamentals/backoffice/infinite-editing: fundamentals/backoffice/sidebar.md extending/backoffice-tours: extending/README.md tutorials/creating-a-backoffice-tour: tutorials/overview.md + extending/packages/types-of-packages: extending/packages/README.md From ba4e7d45f42f76f96ecddf8216513b06d8800445 Mon Sep 17 00:00:00 2001 From: sofietoft Date: Wed, 16 Oct 2024 10:09:07 +0200 Subject: [PATCH 5/5] Tiny changes to trigger GitBook checks --- 13/umbraco-cms/extending/packages/README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/13/umbraco-cms/extending/packages/README.md b/13/umbraco-cms/extending/packages/README.md index 1f6f9df9a32..0b555b7abc0 100644 --- a/13/umbraco-cms/extending/packages/README.md +++ b/13/umbraco-cms/extending/packages/README.md @@ -13,7 +13,7 @@ An Umbraco Package can be many things, but is generally characterized by: - Adding or extending functionality in the Umbraco CMS - Empowering people to do more and/or do things more efficiently - Engaging community members in collaboration and sharing -- Solving real life problems +- Solving real-life problems - Inspiring people on what Umbraco can be made capable of ### Categories of packages @@ -32,11 +32,11 @@ A package that can be categorized as a Schema Extension will extend the default #### Management Extensions -A Management Extension package helps you manage your site, and provides information to the users. Management extensions typically contain custom sections or dashboards to facilitate site management. [Diplo God Mode](https://marketplace.umbraco.com/package/diplo.godmode) is an example of a comprehensive management extension package with additional tools and information. +A Management Extension package helps you manage your site and provides information to the users. Management extensions typically contain custom sections or dashboards to facilitate site management. [Diplo God Mode](https://marketplace.umbraco.com/package/diplo.godmode) is an example of a comprehensive management extension package with additional tools and information. #### Starter Kits -Starter kits are, as the name suggests, a package that helps you set up a starter version of whatever you want to build. Most starter kit packages are for starting a website, and include schema like Document Types and Templates as well as content nodes and media. There are also some specialized starter kits, for example for creating a blog. Umbraco HQ has released their [own starter kit](https://www.nuget.org/packages/Umbraco.TheStarterKit), that creates a small site with the most commonly used features. +Starter kits are, as the name suggests, a package that helps you set up a starter version of whatever you want to build. Most starter kit packages are for starting a website, and include schema like Document Types and Templates as well as content nodes and media. There are also some specialized starter kits, for example for creating a blog. Umbraco HQ has released their [own starter kit](https://www.nuget.org/packages/Umbraco.TheStarterKit), which creates a small site with the most commonly used features. #### Content Apps