Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
86 changes: 22 additions & 64 deletions 14/umbraco-cms/README.md
Original file line number Diff line number Diff line change
@@ -1,79 +1,37 @@
---
description: This is the documentation for the next major of Umbraco, version 14.
description: Your main resource when building and managing an Umbraco CMS website.
---

# Umbraco 14 (RC) CMS Documentation

{% hint style="danger" %}
This documentation is a work in progress and may undergo further revisions, updates, or amendments. The information contained herein is subject to change without notice.

The new Backoffice for Umbraco CMS is scheduled for release along with Umbraco 14 in May 2024.
{% endhint %}

### Getting started with the Umbraco 14

<table data-view="cards"><thead><tr><th></th><th></th><th></th><th data-hidden data-card-target data-type="content-ref"></th><th data-hidden data-card-cover data-type="files"></th></tr></thead><tbody><tr><td></td><td><a href="fundamentals/setup/"><strong>Getting Started</strong></a></td><td>Are you excited to discover the new Backoffice for Umbraco CMS? Head over to the Setup section to learn how to install and configure v14 Umbraco installation.</td><td><a href="fundamentals/setup/">setup</a></td><td><a href=".gitbook/assets/Documentations Icons_Umbraco_CMS_Install (1).png">Documentations Icons_Umbraco_CMS_Install (1).png</a></td></tr><tr><td></td><td><a href="extending/customize-backoffice/"><strong>Customizing the Backoffice</strong></a></td><td>Want to learn how to set up a package and implement the Backoffice extensions? Let's get started!</td><td><a href="extending/customize-backoffice/">customize-backoffice</a></td><td><a href=".gitbook/assets/Documentations Icons_Umbraco_CMS_Fundamentals_Backoffice (1) (2).png">Documentations Icons_Umbraco_CMS_Fundamentals_Backoffice (1) (2).png</a></td></tr><tr><td></td><td><a href="broken-reference/"><strong>Tutorials</strong></a></td><td>Our step-by-step guides will take you through creating a basic website, creating a custom dashboard todeep diving into the world of Property Editors. Don't wait, start exploring now.</td><td><a href="broken-reference/">broken-reference</a></td><td><a href=".gitbook/assets/Documentations Icons_Umbraco_CMS_Tutorials_the_Starter_Kit (1).png">Documentations Icons_Umbraco_CMS_Tutorials_the_Starter_Kit (1).png</a></td></tr></tbody></table>

### Recommended starting points

1. [Install v14](fundamentals/setup/install/)-RC
# Umbraco CMS Documentation

{% hint style="warning" %}
If you have previously installed the Nightly or pre-release feeds versions you must clear the cache to use the new versions. This can be done by running the following command:

`dotnet nuget locals all --clear`

Then restore your package with `dotnet restore` and run the solution again with `dotnet run`.
This documentation is a work in progress and may undergo further revisions, updates, or amendments. The information contained herein is subject to change without notice.
{% endhint %}

2. [Setup your development Environment](extending/customize-backoffice/development-flow/) followed by [Vite package setup](extending/customize-backoffice/development-flow/vite-package-setup.md)
3. [Creating your first extension](tutorials/creating-a-basic-website/creating-your-first-template-and-content-node.md)
4. [Creating a custom dashboard](tutorials/creating-a-custom-dashboard/)
5. [Creating a property editor](tutorials/creating-a-property-editor/)
6. [Terminology](extending/customize-backoffice/#terminology)
7. [UI Documentation](extending/ui-documentation.md)
8. [Creating a backoffice API](tutorials/creating-a-backoffice-api/)
Umbraco CMS is a flexible and editor-friendly Content Management System (CMS) that allows you to create beautiful and modern websites. Use the latest version of .NET, integrate with your favorite services, and help your customers launch a website tailored to their specific needs.

{% hint style="info" %}
You can also find a list of other resources related to the new backoffice of Umbraco in the [Umbraco v14 "Bellissima" Resources](https://github.com/umbraco/Umbraco.Packages/tree/main/bellissima) article.
{% endhint %}
Learn more about Umbraco CMS and get an overview of the top features on [Umbraco.com](https://umbraco.com/products/umbraco-cms/).

### Breaking Changes
<table data-view="cards"><thead><tr><th></th><th></th><th data-hidden data-card-cover data-type="files"></th><th data-hidden data-card-target data-type="content-ref"></th></tr></thead><tbody><tr><td><strong>Fundamentals</strong></td><td>Learn the basics of working with Umbraco CMS. How to install and setup your first site is also included in this section.</td><td><a href=".gitbook/assets/rocket-hero.png">rocket-hero.png</a></td><td><a href="fundamentals/get-to-know-umbraco.md">get-to-know-umbraco.md</a></td></tr><tr><td><strong>Install Umbraco CMS</strong></td><td>Ready to get started with Umbraco? Head over to the Setup section to learn how to install Umbraco CMS.</td><td><a href=".gitbook/assets/docs-style-hero.png">docs-style-hero.png</a></td><td><a href="fundamentals/setup/install/">install</a></td></tr><tr><td><strong>Tutorials</strong></td><td>Find detailed step-by-step guides on everything from building a site from scratch to implementing a custom maintenance page.</td><td><a href=".gitbook/assets/reversed-heart-hero.png">reversed-heart-hero.png</a></td><td><a href="tutorials/overview.md">overview.md</a></td></tr></tbody></table>

Some breaking changes have been introduced in the Umbraco 14. You can find the list of breaking changes or other changes from v14 in the [Version Specific Upgrades](fundamentals/setup/upgrading/version-specific/) article. In the same article, you can find the breaking changes between each v14 version.
{% embed url="<https://www.youtube-nocookie.com/embed/Yu29dE-0OoI>" %}
Watch this tutorial on how to get started building your first Umbraco CMS website.
{% endembed %}

You can also find a sneak peak of what is upcoming on v14 of the CMS in the [Umbraco Product Update Blog](https://umbraco.com/blog/umbraco-product-update-february-2024/#CMS).
The documentation for Umbraco CMS provides information for experienced Umbraco and .NET developers. It also offers guides and high-level articles for people starting out with the CMS.

### New and Updated articles
{% content-ref url="tutorials/creating-a-basic-website/" %}
[creating-a-basic-website](tutorials/creating-a-basic-website/)
{% endcontent-ref %}

Below you will find a list of new and updated articles for Umbraco 14.
{% content-ref url="reference/configuration/" %}
[configuration](reference/configuration/)
{% endcontent-ref %}

The list will be updated as more articles have been created and updated.
{% content-ref url="fundamentals/setup/requirements.md" %}
[requirements.md](fundamentals/setup/requirements.md)
{% endcontent-ref %}

* **FUNDAMENTALS**:
* **SETUP**
* [Installation](fundamentals/setup/install/)
* Upgrade your project
* [Version specific upgrades](fundamentals/setup/upgrading/version-specific/)
* **BACKOFFICE**:
* [Document Blueprints](fundamentals/backoffice/document-blueprints.md) (previously known as Content Templates)
* **EXTENDING**
* [Customize backoffice](extending/customize-backoffice/)
* [Backoffice setup](extending/backoffice-setup/) (new articles)
* [Dashboards](extending/dashboards.md)
* [Section & Trees](extending/section-trees/)
* [Property Editors](extending/property-editors/)
* [Language files & localization](extending/language-files/)
* [Workspaces](extending/workspaces/)
* [UI Documentation](extending/ui-documentation.md)
* **REFERENCE**:
* [Two-factor Authentication](reference/security/two-factor-authentication.md)
* [Management API](reference/management-api/) (new article)
* [Setup OAuth using Postman](reference/management-api/postman-setup-swagger.md) (new article)
* [Custom Swagger API](reference/custom-swagger-api.md) (new article)
* **TUTORIALS**:
* [Create your first extension](tutorials/creating-your-first-extension.md) (new article)
* [Creating a Custom Dashboard](tutorials/creating-a-custom-dashboard/)
* [Creating a Property Editor](tutorials/creating-a-property-editor/)
* [Creating a backoffice API](tutorials/creating-a-backoffice-api/) (new article)
* [Implementing Custom Error Pages](tutorials/custom-error-page.md)
{% content-ref url="reference/notifications/" %}
[notifications](reference/notifications/)
{% endcontent-ref %}
112 changes: 110 additions & 2 deletions 14/umbraco-cms/fundamentals/backoffice/README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,121 @@
---
description: >-
Learn more about the Umbraco backoffice which is the admin side of your
Umbraco website.
Umbraco website
---

# Backoffice

In this article you can learn more about the common terms and concepts that are used throughout the Umbraco backoffice.

## [Login screen](login.md)

When you go to the backoffice for the first time, you're presented with the login screen.

![Login screen](images/login-backoffice-login.png)

[Read more about the login screen](login.md).

## [Section](sections.md)

A section in Umbraco is where you do specific tasks related to that section. For example Content, Settings and Users. You can navigate between the different sections of the backoffice by clicking the corresponding icon in the section menu.

_The **Section menu** is the horizontal menu located on the top of the backoffice._

<figure><img src="../../../../10/umbraco-cms/fundamentals/backoffice/images/highlight-sections.png" alt=""><figcaption></figcaption></figure>

[Read more about the section menu](sections.md).

## [Tree](../../extending/section-trees/)

A tree is a hierarchical list of items related (and usually restricted) to a specific concept, like for example content or media.

You can expand trees by clicking the down arrow ![](../../../../10/umbraco-cms/fundamentals/backoffice/images/expand-node.png) to the left of the node or by double-clicking the node.

<figure><img src="../../../../10/umbraco-cms/fundamentals/backoffice/images/highlight-tree.png" alt=""><figcaption></figcaption></figure>

[Read more about the Tree](../../extending/section-trees/)

## Node

A node is an item in a tree. Media section items appear as nodes in the Media tree, while pages and content are displayed in the Content tree, and so on.

## [Dashboards](../../extending/dashboards.md)

A dashboard is the main view you are presented with when entering a section within the backoffice. It can be used to show valuable information to the users of the system.

_Default dashboard in the content section_

<figure><img src="../../../../10/umbraco-cms/fundamentals/backoffice/images/highlight-dashboard.png" alt=""><figcaption></figcaption></figure>

[Read more about Dashboards](../../extending/dashboards.md)

## Editor

An editor is what you use to edit different items within the backoffice. There are editors specific to editing stylesheets, there are editors for editing Macros, and so forth.

## [Content](../data/defining-content/)

Content is what you find in the Content section. Each item in the tree is called a **content node**. Each content node in the content tree consists of different fields, and each of them is defined by a Document Type.

[Read more about Content](../data/defining-content/)

## Document Type

Document Types define the types of content nodes that backoffice users can create in the content tree. Each Document Type contains different properties. Each property has a specific Data Type for example text or number.

### Properties

Every Document Type has properties. These are the fields that the content editor is allowed to edit for the content node.

### [Data Type](../data/data-types/)

Each Document Type property has a Data Type that defines the type of input of that property. Data Types reference a Property Editor and are configured in the Umbraco backoffice in the Settings section. A Data Type can be something basic (text string, number, true/false) or more complex (multi-node tree picker, image cropper, etc).

[Read more about Data Types](../data/data-types/)

### [Property Editors](property-editors/)

A property editor is a view used by Data Types to insert content into Umbraco. An example of a property editor is the _Textarea_. It's possible to have many Textarea Data Types with different settings that all use the Textarea property editor.

[Read more about Property Editors](property-editors/)

## [Media](../data/creating-media/)

Media items are used to store assets like images and video within the Media section and can be referenced from your content.

[Read more about Media](../data/creating-media/)

### Media Types

Media Types are similar to Document Types in Umbraco, except they are specifically for media items in the Media section.

Umbraco comes with 3 default Media Types: **File**, **Folder,** and **Image**.

## [Members](../data/members.md)

A member is someone who has access to signup, register, and login into your **public website** and is not to be confused with Users.

[Read more about Members](../data/members.md)

### Member Types

Similar to a Document Type and a Media Type. You are able to define custom properties to store on a member such as Twitter username or website URL.

## [Templates](../design/templates/)

A Template is where you define the HTML markup of your website and also where you output the data from your content nodes.

[Read more about Templates](../design/templates/)

## Packages

A package is the Umbraco term for an add-on or plugin used to extend the core functionalities in Umbraco. The packages can be found on the [Umbraco Marketplace](https://marketplace.umbraco.com/), and the can also be browsed directly in the backoffice of the Umbraco CMS.

## Users

A user is someone who has access to the **Umbraco backoffice** and is not to be confused with Members. When Umbraco has been installed a user will automatically be generated with the login (email) and password entered during installation. Users can be created, edited, and managed in the User section.

## [Document Blueprint/Content templates](document-blueprints.md)

Content Templates provide a blueprint for content nodes based on an existing node.
Document Blueprint provide a blueprint for content nodes based on an existing node.
12 changes: 12 additions & 0 deletions 14/umbraco-cms/fundamentals/setup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,18 @@ Defines the system requirements to run Umbraco.

Umbraco installation steps and guidelines.

## [Upgrade your project](upgrading/README.md)

Covers the steps to upgrade your copy of Umbraco to a newer version.

## [Server setup](server-setup/README.md)

Information about server setup for Umbraco including information about permissions and load balancing.

## [Configuration](../../reference/configuration/README.md)

How to configure your Umbraco installation. Includes information about all of Umbraco's configuration files and options.

## [Installing Nightly Builds](install/installing-nightly-builds.md)

How to install the latest nightly builds.
10 changes: 0 additions & 10 deletions 14/umbraco-cms/fundamentals/setup/install/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,16 +4,6 @@ description: Instructions on installing Umbraco on various platforms using vario

# Installation

{% hint style="warning" %}
This page is a work in progress. It will be updated as the software evolves.

If you have previously installed the Nightly or pre-release feeds versions, you must clear the cache to use the new versions. This can be done by running the following command:

`dotnet nuget locals all --clear`

Then restore your package with `dotnet restore` and run the solution again with `dotnet run`.
{% endhint %}

## Install Umbraco using CLI

The fastest way to get the latest version of Umbraco up and running is using the command line (CLI).
Expand Down
Loading