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
2 changes: 1 addition & 1 deletion 13/umbraco-cms/extending/health-check/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -279,7 +279,7 @@ Disallow: /umbraco/";

## Custom health check notifications

Health check notifications can be scheduled to run periodically and notify you of the results. Included with Umbraco is a notification method to deliver the results via email. In a similar manner to how it's possible to create your health checks, you can also create custom notification methods. These methods can send the message summarizing the status of the health checks via other means. Again, for further details on implementing this please refer to the [existing notification methods within the core code base](https://github.com/umbraco/Umbraco-CMS/tree/v10/dev/src/Umbraco.Core/HealthChecks/NotificationMethods).
Health check notifications can be scheduled to run periodically and notify you of the results. Included with Umbraco is a notification method to deliver the results via email. In a similar manner to how it's possible to create your health checks, you can also create custom notification methods. These methods can send the message summarizing the status of the health checks via other means. Again, for further details on implementing this, refer to the [existing notification methods within the core code base](https://github.com/umbraco/Umbraco-CMS/tree/v10/dev/src/Umbraco.Core/HealthChecks/NotificationMethods).

Each notification method needs to implement the core interface `IHealthCheckNotificationMethod` and, for ease of creation, can inherit from the base class `NotificationMethodBase`, which itself implements the `IHealthCheckNotificationMethod` interface. The class must also be decorated with an instance of the `HealthCheckNotificationMethod` attribute. There's one method to implement - `SendAsync(HealthCheckResults results)`. This method is responsible for taking the results of the health checks and sending them via the mechanism of your choice.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@

If building a package or adding custom tree actions to your solution, it's important to pick a permission letter that doesn't clash with one of these.

If you have created a package using a custom tree action, please consider providing an update to this documentation page via a PR to the [documentation repository](https://github.com/umbraco/UmbracoDocs), such that other developers can discover and avoid using the same permission letter.
If you have created a package using a custom tree action, consider providing an update to this documentation page via a PR to the [documentation repository](https://github.com/umbraco/UmbracoDocs), such that other developers can discover and avoid using the same permission letter.

Check warning on line 56 in 13/umbraco-cms/extending/section-trees/trees/tree-actions.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐢 [UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). For content inside note or warning blocks, add blank lines around the content. Raw Output: {"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). For content inside note or warning blocks, add blank lines around the content.", "location": {"path": "13/umbraco-cms/extending/section-trees/trees/tree-actions.md", "range": {"start": {"line": 56, "column": 1}}}, "severity": "WARNING"}

| Type | Alias | Letter | Can Be Permission Assigned |
| ------------------------------------------------------------- | ---------------------- | ------ | -------------------------- |
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,7 @@

A Partial View will receive the model of `Umbraco.Core.Models.Blocks.BlockListItem`. This gives you the option to access properties of the Content and Settings section of your Block.

In the following example of a Partial view for a Block Type, please note that the `MyElementTypeAliasOfContent`and `MyElementTypeAliasOfSettings` should correspond with the selected Element Type Alias for the given model in your case.
In the following example of a Partial view for a Block Type, the `MyElementTypeAliasOfContent`and `MyElementTypeAliasOfSettings` should correspond with the selected Element Type Alias for the given model in your case.

Check warning on line 138 in 13/umbraco-cms/fundamentals/backoffice/property-editors/built-in-umbraco-property-editors/block-editor/block-list-editor.md

View workflow job for this annotation

GitHub Actions / runner / vale

[vale] reported by reviewdog 🐢 [UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). For content inside note or warning blocks, add blank lines around the content. Raw Output: {"message": "[UmbracoDocs.SentenceLength] Write shorter sentences (less than 25 words). For content inside note or warning blocks, add blank lines around the content.", "location": {"path": "13/umbraco-cms/fundamentals/backoffice/property-editors/built-in-umbraco-property-editors/block-editor/block-list-editor.md", "range": {"start": {"line": 138, "column": 1}}}, "severity": "WARNING"}

Example:

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ or

With the stylesheet referenced, you will be able to style the template file with the rules and classes defined in the stylesheet.

Your stylesheets can be used in Rich Text Editors (datatype) as well - please see the [Rich Text Editor](../backoffice/property-editors/built-in-umbraco-property-editors/rich-text-editor/#rte-styles) documentation for more information.
Your stylesheets can be used in Rich Text Editors (datatype) as well. See the [Rich Text Editor](../backoffice/property-editors/built-in-umbraco-property-editors/rich-text-editor/#rte-styles) documentation for more information.

{% hint style="info" %}
If your RTE is styled differently on the frontend of the site, the backoffice styling might be getting overwritten by other stylesheets you have included.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -76,7 +76,7 @@ Alternatively, we could replace `unsubscribe()` with `eventsService.unsubscribe(

## Events in Umbraco

Below you'll find a list of events broadcasted by the Umbraco codebase. The list may not be complete, so please help updating the list should you find an event that isn't listed.
Below you'll find a list of events broadcasted by the Umbraco codebase. The list may not be complete, so kindly help updating the list should you find an event that isn't listed.

### Umbraco application

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description: >-
With Umbraco, you can save and preview draft content before going live. The preview feature allows you to visualize how a page will look once it is published, directly from within the backoffice. This is also possible for the Content Delivery API data. You can extend the preview functionality in the backoffice by configuring external preview URLs for client libraries consuming the Content Delivery API.

{% hint style="info" %}
To get familiar with the preview functionality in the Delivery API, please refer to the [Preview concept](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#preview) section.
To get familiar with the preview functionality in the Delivery API, refer to the [Preview concept](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api#preview) section.
{% endhint %}

{% hint style="info" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ In this article, we'll look into how you can work with the `IDeliveryApiProperty

The examples in this article revolve around the fictional `My.Custom.Picker` property editor. This property editor stores the key of a single content item and is backed by a property value converter.

We will not dive into the details of creating a custom property editor for Umbraco in this article. If you need guidance on that, please refer to the [Creating a Property Editor](https://docs.umbraco.com/umbraco-cms/tutorials/creating-a-property-editor) and [Property Value Converters](https://docs.umbraco.com/umbraco-cms/extending/property-editors/property-value-converters) articles.
We will not dive into the details of creating a custom property editor for Umbraco in this article. If you need guidance on that, refer to the [Creating a Property Editor](https://docs.umbraco.com/umbraco-cms/tutorials/creating-a-property-editor) and [Property Value Converters](https://docs.umbraco.com/umbraco-cms/extending/property-editors/property-value-converters) articles.

## Implementation

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: >-

# Extension API for querying

The Delivery API allows you to retrieve multiple items by utilizing the `/umbraco/delivery/api/v2/content` endpoint. With the built-in query parameters, you have the flexibility to get any number of content nodes based on your needs. For a comprehensive list of supported query options, please refer to the [Endpoints](./#endpoints) section.
The Delivery API allows you to retrieve multiple items by utilizing the `/umbraco/delivery/api/v2/content` endpoint. With the built-in query parameters, you have the flexibility to get any number of content nodes based on your needs. For a comprehensive list of supported query options, refer to the [Endpoints](./#endpoints) section.

For the query endpoint, we have created a new Examine index (_DeliveryApiContentIndex_) that facilitates fast retrieval of the desired content. This index ensures quick indexing and searching of data, with the possibility for future extensions.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ description: Using the Media Delivery API.

# Media Delivery API

The Media Delivery API allows for accessing the Umbraco media items in a headless manner. This API applies many of the same concepts as its content counterpart, although with fewer options. If you haven't already, please familiarize yourself with the [Content Delivery API](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api) before reading this article.
The Media Delivery API allows for accessing the Umbraco media items in a headless manner. This API applies many of the same concepts as its content counterpart, although with fewer options. If you haven't already, familiarize yourself with the [Content Delivery API](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api) before reading this article.

{% hint style="info" %}
The Media Delivery API specification is created to mimic that of the Content Delivery API. However, the default implementation of this specification is limited and does not support the entire specification.
Expand Down Expand Up @@ -166,7 +166,7 @@ Returns single or multiple items.
{% swagger-parameter in="query" name="fetch" type="String" required="true" %}
Structural query string option (e.g. `ancestors`, `children`, `descendants`).

**Please note:** The default API implementation only supports `children`.
**Note:** The default API implementation only supports `children`.
{% endswagger-parameter %}

{% swagger-parameter in="query" name="filter" type="String Array" required="false" %}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Using property expansion and limiting to shape the Delivery API out
# Property expansion and limiting

{% hint style="info" %}
This article explains the mechanics of property expansion and limiting in depth. If you haven't already, please read the [Getting started](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api) article first - in particular the "Concepts" section.
This article explains the mechanics of property expansion and limiting in depth. If you haven't already, read the [Getting started](https://docs.umbraco.com/umbraco-cms/reference/content-delivery-api) article first - in particular the "Concepts" section.
{% endhint %}

Property expansion and limiting applies only to select property editors. The following built-in property editors in Umbraco support expansion and limiting:
Expand Down Expand Up @@ -537,7 +537,7 @@ Start-Item: posts
## Working with block-based editors

{% hint style="info" %}
If you are not familiar with block-based editors, please refer to [this article](https://docs.umbraco.com/umbraco-cms/fundamentals/backoffice/property-editors/built-in-umbraco-property-editors/block-editor) for the general concepts of these.
If you are not familiar with block-based editors, refer to [this article](https://docs.umbraco.com/umbraco-cms/fundamentals/backoffice/property-editors/built-in-umbraco-property-editors/block-editor) for the general concepts of these.
{% endhint %}

In the API output, a block has little value without its contained properties. Therefore, the content and settings properties of blocks are always included in the output. However, these properties are not expanded. As such, we can apply expansion and limiting to the contained properties.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ Member authorization in the Delivery API was introduced in version 12.3.
{% endhint %}

{% hint style="info" %}
If you are not familiar with members in Umbraco, please read the [Members](https://docs.umbraco.com/umbraco-cms/fundamentals/data/members) article.
If you are not familiar with members in Umbraco, read the [Members](https://docs.umbraco.com/umbraco-cms/fundamentals/data/members) article.
{% endhint %}

{% hint style="warning" %}
Expand Down Expand Up @@ -358,7 +358,7 @@ Access tokens expire after one hour. Once expired, a new access token must be ob
Refresh tokens provide a means to obtain a new access token without having to go through the authentication flow. A refresh token is issued automatically by the Delivery API when the `offline_access` scope is specified in the authorization request.

{% hint style="info" %}
Refresh tokens are subject to certain limitations and can result in security issues if not applied correctly. All this is beyond the scope of this article to explain in detail. Please familiarize yourself with the inner workings of refresh tokens before applying them in a solution.
Refresh tokens are subject to certain limitations and can result in security issues if not applied correctly. All this is beyond the scope of this article to explain in detail. Familiarize yourself with the inner workings of refresh tokens before applying them in a solution.
{% endhint %}

## Logging out members
Expand Down Expand Up @@ -446,7 +446,7 @@ Remember to use `umbraco-member` as `client_id` when authorizing. `client_secret

The following samples show how to configure an ASP.NET Core client to utilize member authorization in the Delivery API.

To put these samples into context, please refer to the article above.
To put these samples into context, refer to the article above.

### Basic client configuration

Expand Down
2 changes: 1 addition & 1 deletion 13/umbraco-cms/reference/management/models/contenttype.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ return contentType.AllowedTemplates;

Gets a list of `ContentTypes` as `IContentTypeComposition` objects that make up a composition of PropertyGroups and PropertyTypes for the current ContentType.

The ContentTypeComposition provides a mixin-type functionality in that you can compose a ContentType of one or more other ContentTypes in a complex structure. But please be aware that the backoffice does not fully support these complex structures yet.
The ContentTypeComposition provides a mixin-type functionality in that you can compose a ContentType of one or more other ContentTypes in a complex structure. But be aware that the backoffice does not fully support these complex structures yet.

```csharp
// Given a `ContentTypeService` object get ContentType by its Id and return ContentTypeComposition
Expand Down
2 changes: 1 addition & 1 deletion 13/umbraco-cms/reference/management/models/mediatype.md
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@ return mediaType.AllowedContentTypes;

Gets a list of `MediaTypes` as `IContentTypeComposition` objects that make up a composition of PropertyGroups and PropertyTypes for the current MediaType.

The `ContentTypeComposition` provides a mixin-type functionality in that you can compose a MediaType of one or more other MediaTypes in a complex structure. But please keep in mind that the backoffice does not fully support these complex structures yet
The `ContentTypeComposition` provides a mixin-type functionality in that you can compose a MediaType of one or more other MediaTypes in a complex structure. But keep in mind that the backoffice does not fully support these complex structures yet

```csharp
// Given a `MediaTypeService` object get MediaType by its Id and return ContentTypeComposition
Expand Down
2 changes: 1 addition & 1 deletion 13/umbraco-cms/reference/searching/examine/indexing.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,7 +329,7 @@ The index will only update its content when you manually trigger an index rebuil
To update your index when content changes, you can use notification handlers.

{% hint style="info" %}
The following handler class does not automatically update the descendant items of the modified content nodes, such as removing descendants of deleted content. If changes to the parent content item can affect its children or descendant items in your setup, please refer to the [UmbracoContentIndex.PerformDeleteFromIndex() in Umbraco](https://github.com/umbraco/Umbraco-CMS/blob/main/src/Umbraco.Examine.Lucene/UmbracoContentIndex.cs#L124-L153). Such logic should be applied when both removing and reindexing content items of type _product_.
The following handler class does not automatically update the descendant items of the modified content nodes, such as removing descendants of deleted content. If changes to the parent content item can affect its children or descendant items in your setup, refer to the [UmbracoContentIndex.PerformDeleteFromIndex() in Umbraco](https://github.com/umbraco/Umbraco-CMS/blob/main/src/Umbraco.Examine.Lucene/UmbracoContentIndex.cs#L124-L153). Such logic should be applied when both removing and reindexing content items of type _product_.
{% endhint %}

```csharp
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ It is recommended that you work through the subsections in the following order.

## [Getting Started](getting-started.md)

To follow this tutorial please work through this section first.
To follow this tutorial, work through this section first.

## [Creating Your First Document Type](document-types.md)

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ At the end of this guide, we should have a friendly welcoming dashboard displayi
```html
<div class="welcome-dashboard">
<h1>Welcome to Umbraco</h1>
<p>We hope you find the experience of editing your content with Umbraco enjoyable and delightful. If you discover any problems with the site please report them to the support team at <a href="mailto:">support@popularumbracopartner.com</a></p>
<p>We hope you find the experience of editing your content with Umbraco enjoyable and delightful. If you discover any problems with the site, report them to the support team at <a href="mailto:">support@popularumbracopartner.com</a></p>
<p>You can put anything here...</p>
</div>
```
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,5 +18,5 @@ The notification settings apply to the chosen content item as well as any child
{% endhint %}

{% hint style="info" %}
If the notifications option does not appear, the SMTP settings are probably incorrect. In this case please contact the administrator of your website.
If the notifications option does not appear, the SMTP settings are probably incorrect. In this case, contact the administrator of your website.
{% endhint %}
2 changes: 1 addition & 1 deletion 13/umbraco-cms/tutorials/multisite-setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ This tutorial explains how to host multiple sites from one project/installation
When using Baselines on Umbraco Cloud for a multisite solution, you would not need to worry about [Usage](https://docs.umbraco.com/umbraco-cloud/set-up/project-settings/usage) limits, and could see better performance compared to having multiple websites in one project.
{% endhint %}

If you are planning to create a multilingual site, please take a look at the [Multilanguage Setup](multilanguage-setup.md) tutorial instead.
If you are planning to create a multilingual site, take a look at the [Multilanguage Setup](multilanguage-setup.md) tutorial instead.

## Structuring your website

Expand Down
4 changes: 2 additions & 2 deletions 13/umbraco-commerce/changelog-archive/Vendr-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -556,10 +556,10 @@ description: Changelog for the Core Vendr product

## v1.4.0

**Date:** 2020-12-10\
**Date:** 2020-12-10
**Description:** Major breaking changes release

For more details on this release, including a recommended upgrade strategy, please see the [Vendr 1.4.0 RC blog post](https://vendr.net/blog/vendr-1-4-0-release-candidate/).
For more details on this release, including a recommended upgrade strategy, see the [Vendr 1.4.0 RC blog post](https://vendr.net/blog/vendr-1-4-0-release-candidate/).

* Added price adjustments/adjusters.
* Added amount adjustments/adjusters.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@ The following two code samples illustrate how this can be done.

The first handles a content cache refresher, which takes a payload from where the content ID can be extracted. Using that the content can be retrieved in the local Umbraco instance and used as appropriate.

For more details and further examples, please see the [CMS Cache Refresher Notifications documentation](https://docs.umbraco.com/umbraco-cms/reference/notifications/cacherefresher-notifications).
For more details and further examples, see the [CMS Cache Refresher Notifications documentation](https://docs.umbraco.com/umbraco-cms/reference/notifications/cacherefresher-notifications).

```csharp
using Umbraco.Cms.Core.Cache;
Expand Down
2 changes: 1 addition & 1 deletion 13/umbraco-deploy/troubleshooting.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description: The troubleshooting section for Umbraco Deploy

In this troubleshooting section, you can find help to resolve issues that you might run into when using Umbraco Deploy.

If you are unable to find the issue you are having, then please reach out to our friendly support team at contact@umbraco.com.
If you are unable to find the issue you are having, then reach out to our friendly support team at contact@umbraco.com.

## Schema mismatches

Expand Down
Loading
Loading