Skip to content

Commit ff08a7e

Browse files
authored
Merge pull request #6549 from jemayn/cleanup-package-docs
Cleanup package docs
2 parents e4f889d + ba4e7d4 commit ff08a7e

17 files changed

+16
-343
lines changed

13/umbraco-cms/.gitbook.yaml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,3 +8,4 @@ redirects:
88
tutorials/add-azure-active-directory-authentication: tutorials/add-microsoft-entra-id-authentication.md
99
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
1010
tutorials/editors-manual/working-with-content/rich-text-editor: tutorials/editors-manual/working-with-content.md
11+
extending/packages/types-of-packages: extending/packages/README.md

13/umbraco-cms/SUMMARY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -191,7 +191,6 @@
191191
* [Using Azure Blob Storage for Media and ImageSharp Cache](extending/filesystemproviders/azure-blob-storage.md)
192192
* [Configuring Azure Key Vault](extending/key-vault.md)
193193
* [Packages](extending/packages/README.md)
194-
* [Package Types](extending/packages/types-of-packages.md)
195194
* [Creating a Package](extending/packages/creating-a-package.md)
196195
* [Language file for packages](extending/packages/language-files-for-packages.md)
197196
* [Listing a Package on the Umbraco Marketplace](extending/packages/listing-on-marketplace.md)

13/umbraco-cms/extending/packages/README.md

Lines changed: 3 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ An Umbraco Package can be many things, but is generally characterized by:
1313
- Adding or extending functionality in the Umbraco CMS
1414
- Empowering people to do more and/or do things more efficiently
1515
- Engaging community members in collaboration and sharing
16-
- Solving real life problems
16+
- Solving real-life problems
1717
- Inspiring people on what Umbraco can be made capable of
1818

1919
### Categories of packages
@@ -32,11 +32,11 @@ A package that can be categorized as a Schema Extension will extend the default
3232

3333
#### Management Extensions
3434

35-
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.
35+
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.
3636

3737
#### Starter Kits
3838

39-
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.
39+
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.
4040

4141
#### Content Apps
4242

@@ -46,10 +46,6 @@ Content apps are almost like dashboards for content nodes that are intended to d
4646

4747
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.
4848

49-
## [Types of Packages](types-of-packages.md)
50-
51-
Packages for Umbraco 10 and above are installed as NuGet packages.
52-
5349
## [Creating a Package](creating-a-package.md)
5450

5551
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.

13/umbraco-cms/extending/packages/good-practice-and-defaults.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,7 +42,7 @@ The `/umbraco/Licenses` folder does not exist on a fresh installation of Umbraco
4242

4343
## Operating system considerations
4444

45-
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.
45+
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.
4646

4747
### Case sensitivity
4848

@@ -66,7 +66,7 @@ Some folders within Umbraco will already exist for all installations. If you acc
6666
| Folder | Note |
6767
|-|-|
6868
| /App_Plugins | Uppercase `A` and `P` |
69-
| /App_Plugins/[Ll]ang | Uppercase `L` (in Umbraco 9.3 and higher can be either uppercase `L` or lowercase `l` |
69+
| /App_Plugins/[Ll]ang | Uppercase `L` |
7070
| /Views | Uppercase `V` |
7171
| /umbraco/Licenses | Lowercase `u` and uppercase `L` |
7272
| /config | Lowercase `c` |

13/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md

Lines changed: 1 addition & 43 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,19 @@
11
---
22
description: >-
33
The process of installing and, in turn, uninstalling packages in your Umbraco
4-
CMS website depends on the version and package type.
4+
CMS website.
55
---
66

77
# Installing and Uninstalling Packages
88

99
This article will cover the process of installing as well as uninstalling packages from your Umbraco CMS website.
1010

11-
As the article will cover both NuGet packages and zip file packages, it is important to know the distinction:
12-
13-
* **NuGet packages**: Modern Umbraco (Umbraco 10+) and Legacy Umbraco (Umbraco 8 and earlier versions).
14-
* **Package zip files**: Legacy Umbraco (Umbraco 8 and earlier versions) only.
15-
16-
Learn more about the different types of packages in the [Types of packages](types-of-packages.md) article.
17-
1811
## Installing packages
1912

2013
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.
2114

2215
![Backoffice - Packages section](images/backoffice-packages-section.png)
2316

24-
{% tabs %}
25-
{% tab title="NuGet package" %}
2617
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.
2718

2819
![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
4839
Once the package has been installed, it will show up under the **Packages** section in the backoffice, under **Installed** tab.
4940

5041
![Backoffice - installed packages](../../../../10/umbraco-cms/extending/packages/images/backoffice-installed-packages.png)
51-
{% endtab %}
52-
53-
{% tab title="Package zip file" %}
54-
{% hint style="warning" %}
55-
Package zip files are only available for Umbraco 8 or earlier versions.
56-
{% endhint %}
57-
58-
Once you have downloaded an Umbraco package zip file, you can install it in the Umbraco backoffice by following the steps below:
59-
60-
* Navigate to the **Packages** section.
61-
* Select **Install local** on the top-right side of the page.
62-
* Drag'n drop the package onto the page or use the file explorer to select the package zip file.
63-
* Accept terms of use to confirm the package installation.
64-
65-
The package will be installed and any necessary reboots of the site will be initiated.
66-
67-
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.
68-
69-
* Navigate to the specific package you want to install.
70-
* Click **Install package** in the right-hand side of the page.
71-
* Confirm the installation.
72-
73-
The package will be install and the site will be rebooted.
74-
{% endtab %}
75-
{% endtabs %}
7642

7743
## Uninstalling packages
7844

@@ -94,14 +60,6 @@ To uninstall a package, either run a command or use the NuGet Package Manager in
9460

9561
![Visual Studio - uninstalling via Package Manager](images/uninstalling-via-nuget-package-manager.png)
9662

97-
{% hint style="info" %}
98-
If you are using Umbraco 8 or an earlier version you uninstall the packages directly from the **Packages** section of the Umbraco backoffice.
99-
100-
1. Navigate to the **Installed** tab in the **Packages** section.
101-
2. Click **Uninstall package** next to the package you want to uninstall.
102-
3. Confirm that action by checking **Confirm package uninstall**.
103-
{% endhint %}
104-
10563
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.
10664

10765
![Visual Studio - clean solution](images/vs-cleaning-solution.png)

13/umbraco-cms/extending/packages/types-of-packages.md

Lines changed: 0 additions & 64 deletions
This file was deleted.

14/umbraco-cms/.gitbook.yaml

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,4 +124,5 @@ redirects:
124124
customize-the-backoffice/ui-library: customizing/ui-library.md
125125
customize-the-backoffice/umbraco-package: customizing/umbraco-package.md
126126
customize-the-backoffice/workspaces: customizing/workspaces.md
127-
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
127+
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
128+
extending/packages/types-of-packages: extending/packages/README.md

14/umbraco-cms/SUMMARY.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -233,7 +233,6 @@
233233
* [Using Azure Blob Storage for Media and ImageSharp Cache](extending/filesystemproviders/azure-blob-storage.md)
234234
* [Configuring Azure Key Vault](extending/key-vault.md)
235235
* [Packages](extending/packages/README.md)
236-
* [Package Types](extending/packages/types-of-packages.md)
237236
* [Creating a Package](extending/packages/creating-a-package.md)
238237
* [Language file for packages](extending/packages/language-files-for-packages.md)
239238
* [Listing a Package on the Umbraco Marketplace](extending/packages/listing-on-marketplace.md)

14/umbraco-cms/extending/packages/README.md

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -45,10 +45,6 @@ Workspace Views are almost like dashboards for content nodes that are intended t
4545

4646
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.
4747

48-
## [Types of Packages](types-of-packages.md)
49-
50-
Packages for Umbraco 10 and above are installed as NuGet packages.
51-
5248
## [Creating a Package](creating-a-package.md)
5349

5450
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.

14/umbraco-cms/extending/packages/good-practice-and-defaults.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -46,7 +46,7 @@ The `/umbraco/Licenses` folder does not exist on a fresh installation of Umbraco
4646

4747
## Operating system considerations
4848

49-
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.
49+
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.
5050

5151
### Case sensitivity
5252

@@ -69,7 +69,7 @@ Some folders within Umbraco will already exist for all installations. If you acc
6969
| Folder | Note |
7070
| ---------------------- | ------------------------------------------------------------------------------------- |
7171
| /App\_Plugins | Uppercase `A` and `P` |
72-
| /App\_Plugins/\[Ll]ang | Uppercase `L` (in Umbraco 9.3 and higher can be either uppercase `L` or lowercase `l` |
72+
| /App\_Plugins/\[Ll]ang | Uppercase `L` |
7373
| /Views | Uppercase `V` |
7474
| /umbraco/Licenses | Lowercase `u` and uppercase `L` |
7575
| /config | Lowercase `c` |

0 commit comments

Comments
 (0)