Skip to content

Cleanup package docs #6549

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.

Sign up for GitHub

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

Merged
merged 5 commits into from
Oct 16, 2024
Merged

Cleanup package docs #6549

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
d0b921f
Cleanup v14 docs
jemayn Oct 12, 2024
be775a4
Cleanup v13
jemayn Oct 12, 2024
40371f2
cleanup v15
jemayn Oct 12, 2024
9ebdb4c
Add rewrites and edit menu
jemayn Oct 16, 2024
ba4e7d4
Tiny changes to trigger GitBook checks
sofietoft Oct 16, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions 13/umbraco-cms/.gitbook.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
1 change: 0 additions & 1 deletion 13/umbraco-cms/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 0 additions & 4 deletions 13/umbraco-cms/extending/packages/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions 13/umbraco-cms/extending/packages/good-practice-and-defaults.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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` |
Expand Down
44 changes: 1 addition & 43 deletions 13/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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

Expand All @@ -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)
Expand Down
64 changes: 0 additions & 64 deletions 13/umbraco-cms/extending/packages/types-of-packages.md
View file
Open in desktop
Copy link
Contributor

@sofietoft sofietoft Oct 16, 2024

Choose a reason for hiding this comment

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

When deleting articles, we also need to delete the reference to them in the SUMMARY file.
So, for each time you've deleted a file, remove the reference to that file in the "nearest" SUMMARY file:

13/umbraco-cms/SUMMARY.md
14/umbraco-cms/SUMMARY.md
15/umbraco-cms/SUMMARY.md

If not, GitBook will just create a blank article with a heading 🙈
Also, we should add redirects, just in case. Use the 13/umbraco-cms/.gitbook.yaml file for that! I'm happy to do that as well - just let me know what you prefer 😁

Copy link
Contributor Author

@jemayn jemayn Oct 16, 2024

Choose a reason for hiding this comment

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

Ahh yep, makes sense!

I've done it in 9ebdb4c - I couldn't find it in the v15 summary file but a lot is missing in that one so I assumed you use it to know what's been tested, etc. 🙂

Let me know if anything is still missing!

This file was deleted.

3 changes: 2 additions & 1 deletion 14/umbraco-cms/.gitbook.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
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
1 change: 0 additions & 1 deletion 14/umbraco-cms/SUMMARY.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
4 changes: 0 additions & 4 deletions 14/umbraco-cms/extending/packages/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions 14/umbraco-cms/extending/packages/good-practice-and-defaults.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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` |
Expand Down
44 changes: 1 addition & 43 deletions 14/umbraco-cms/extending/packages/installing-and-uninstalling-packages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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)
Expand All @@ -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

Expand All @@ -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)
Expand Down
Loading
Loading