Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
9313e06
corrrects some spelling and filename errors in `source-code.md` in v1…
liamlaverty Jan 17, 2024
1fe4cee
Typo corrections in Umb Heartcore directory
liamlaverty Jan 17, 2024
b3701e9
Umbraco Cloud typo corrections
liamlaverty Jan 17, 2024
3691603
new backoffice typo corrections
liamlaverty Jan 17, 2024
7ac4681
typo fixes in Generic documentation
liamlaverty Jan 17, 2024
5bb4952
typo fixes in `workflow-settings` v10, 12, 13
liamlaverty Jan 17, 2024
1332172
typo fixes in `umbraco-ui\upgrade` v10, 12, 13
liamlaverty Jan 17, 2024
29349d1
typo fixes in `global-filters` v10, 12, 13
liamlaverty Jan 17, 2024
93e731d
typo fixes in `filterable-properties` v10, 12, 13
liamlaverty Jan 17, 2024
2bf85b3
typo fixes in `collections\the-basics` v10, 12, 13
liamlaverty Jan 17, 2024
93fd5ad
typo fixes in `ui-builder\actions\basics` v10, 12, 13
liamlaverty Jan 17, 2024
579f969
typo fixes in `actions\action-visibility` v10, 12, 13
liamlaverty Jan 17, 2024
645dae2
typo fixes in `magic-strings` v10, 12, 13
liamlaverty Jan 17, 2024
1473355
typo fixes in `changelog-archive` v10, 12, 13
liamlaverty Jan 17, 2024
61dd00b
removes spurious 'actually' to pass Vale
liamlaverty Jan 17, 2024
f7b83f5
rewrites some sections to bring word count below 25 words
liamlaverty Jan 17, 2024
9e5e181
Update umbraco-cloud/getting-started/migrate-existing-site/README.md
alina-tincas Jan 29, 2024
ffde63e
Update umbraco-cloud/getting-started/the-umbraco-cloud-portal/README.md
alina-tincas Jan 29, 2024
41e544d
Update umbraco-cloud/security.md
alina-tincas Jan 29, 2024
be0bf21
Update umbraco-heartcore/getting-started/backoffice-users-and-api-key…
alina-tincas Jan 29, 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
10 changes: 5 additions & 5 deletions 10/umbraco-cms/fundamentals/code/source-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,15 +63,15 @@ appsettings-schema.json
## Umbraco CMS .NETCore
##

# Dont commit Umbraco TEMP folder containing Examine Indexes, NuCache etc
# Don't commit Umbraco TEMP folder containing Examine Indexes, NuCache etc
**/umbraco/Data/TEMP/

# Dont commit files that are generated and cached from the default ImageSharp location
# Don't commit files that are generated and cached from the default ImageSharp location
**/umbraco/mediacache/

# Umbraco backoffice language files
# Nuget package Umbraco.Cms.StaticAssets will copy them in during dotnet build
# Customize langguage files in /config/lang/{language}.user.xml
# Customize language files in /config/lang/{language}.user.xml
**/umbraco/config/lang/

# JSON Schema file for appsettings
Expand Down Expand Up @@ -213,9 +213,9 @@ Any supporting custom code for your application should be in version control, eg

#### Config

Your site's `apsettings.json` and `appsettings.Development.json` files contain the configuration for your Umbraco site.
Your site's `appsettings.json` and `appsettings.Development.json` files contain the configuration for your Umbraco site.

In general, it is recommended to add these to source control. When you do this, be sure that the file(s) doesn't contain any secrets, like API keys and connection strings. These can be added as needed, but ommitted from any commits made to source control.
In general, it is recommended to add these to source control. When you do this, be sure that the file(s) doesn't contain any secrets, like API keys and connection strings. These can be added as needed, but omitted from any commits made to source control.

#### DocumentType - Backoffice Structure Changes

Expand Down
2 changes: 1 addition & 1 deletion 10/umbraco-forms/developer/magic-strings.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Umbraco Forms ships with the following filters:
| Format a date | `date` | format string | `[#field \| date: dd-MM-yyyy HH:mm]` |
| HTML encode a string | `html` | | `[#field \| html]` |

The format strings used for fomrmatting dates and numbers are the standard or custom .NET [date](https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings) and [numeric](https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings) format strings respectively.
The format strings used for formatting dates and numbers are the standard or custom .NET [date](https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings) and [numeric](https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings) format strings respectively.

Further magic string format functions can be [created in code](extending/adding-a-magic-string-format-function.md) for use in forms.

Expand Down
4 changes: 2 additions & 2 deletions 10/umbraco-ui-builder/actions/action-visibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ description: Controlling the visibility of actions in Umbraco UI Builder, the ba

# Action Visibility

By default actions are not visible in the UI and you must expressly define when and where an action should display. This can be achived in two ways, either on the action definition itself or at the point of registration on the collections config.
By default actions are not visible in the UI and you must expressly define when and where an action should display. This can be achieved in two ways, either on the action definition itself or at the point of registration on the collections config.

## Controlling the default action visibility

To define the default visbility of an action at the action level you can do this by overriding the `IsVisible` method of the `Action<>` base class.
To define the default visibility of an action at the action level you can do this by overriding the `IsVisible` method of the `Action<>` base class.

````csharp
// Example
Expand Down
6 changes: 3 additions & 3 deletions 10/umbraco-ui-builder/actions/the-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public class MyAction : Action<MyBulkdActionSettings, ActionResult>
{
settingsConfig.AddFielset("General", fieldsetConfig => fieldsetConfig
.AddField(s => s.RecipientName).SetLabel("Recipient Name")
.AddField(s => s.ReceipientEmail).SetLabel("Recipient Email"))
.AddField(s => s.RecipientEmail).SetLabel("Recipient Email"))
}

public override ActionResult Execute(string collectionAlias, object[] entityIds, MyActionSettings settings)
Expand All @@ -78,8 +78,8 @@ public class MyAction : Action<MyBulkdActionSettings, ActionResult>

public class MyActionSettings
{
public string ReceipientName { get; set; }
public string ReceipientEmail { get; set; }
public string RecipientName { get; set; }
public string RecipientEmail { get; set; }
}
````

Expand Down
2 changes: 1 addition & 1 deletion 10/umbraco-ui-builder/changelog-archive/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ description: Changelog for Konstrukt, the backoffice UI builder for Umbraco.

- Added marketplace updates.
- Update the Konstrukt type finder to use a non-obsolete constructor.
- Updated to use `IComposer` instead of `IUserCompser` as the latter has been removed in v11.
- Updated to use `IComposer` instead of `IUserComposer` as the latter has been removed in v11.
- Fixed parent ID not being passed to create dialog for associated entities.
- Removed settings section restriction on the licensing info endpoint as it would cause errors when the licensing banner is shown in other sections.

Expand Down
4 changes: 2 additions & 2 deletions 10/umbraco-ui-builder/collections/the-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ collectionConfig.SetIconColor("blue");

Within Umbraco, it is expected that an entity has a name property. So we need to let Umbraco UI Builder know which property to use for the name. If the entity doesn't have a name property, then it needs to know how to construct a name from an entity's other properties. We do this by using either the `SetNameProperty` or `SetNameFormat` methods on a `Collection` config builder instance.

### **SetNameProperty(Lambda nameProperytyExpression) : CollectionConfigBuilder&lt;TEntityType&gt;**
### **SetNameProperty(Lambda namePropertyExpression) : CollectionConfigBuilder&lt;TEntityType&gt;**

Sets which property of your entity to use as the name property. Property must be of type `string`. By defining a property as the name property, its value will be used as the label for the entity in trees and list views. It will also be editable in the header region of the editor interface. The property will also automatically be added to the searchable properties collection and be used for the default sort property.

Expand Down Expand Up @@ -124,7 +124,7 @@ By default, in Umbraco UI Builder any entity that is deleted via the Umbraco UI

### **SetDeletedProperty(Lambda deletedPropertyExpression) : CollectionConfigBuilder&lt;TEntityType&gt;**

Sets which property of our entity to use as the deleted property flag. Property must be of type `boolean` or `int`. When a deleted property is set, any delete actions will set the deleted flag instead of actualy deleting the entity. For `boolean` based properties, deleted entities will have a value of `True` when deleted. For `int` based properties, deleted entities will have a UTC Unix timestamp value of the date the entity was deleted. In addition, any fetch actions will also pre-filter out any deleted entities.
Sets which property of our entity to use as the deleted property flag. Property must be of type `boolean` or `int`. When a deleted property is set, any delete actions will set the deleted flag instead of deleting the entity. For `boolean` based properties, deleted entities will have a value of `True` when deleted. For `int` based properties, deleted entities will have a UTC Unix timestamp value of the date the entity was deleted. In addition, any fetch actions will also pre-filter out any deleted entities.

````csharp
// Example
Expand Down
2 changes: 1 addition & 1 deletion 10/umbraco-ui-builder/filtering/filterable-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ filterConfig.SetOptions(new Dictionary<string, string> {

## Defining options with custom compare clauses for a filterable property

### **AddOption(object key, string label, Lambda compareExpresion) : FilterablePropertyConfigBuilder&lt;TEntityType, TValueType&gt;**
### **AddOption(object key, string label, Lambda compareExpression) : FilterablePropertyConfigBuilder&lt;TEntityType, TValueType&gt;**

````csharp
// Example
Expand Down
2 changes: 1 addition & 1 deletion 10/umbraco-ui-builder/filtering/global-filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If you want to work with a subset of data within a given collection then this is

Applying a global filter is controlled via the [collections](../collections/overview.md) configuration.

### **SetFilter(Lambda whereClauseExression) : CollectionConfigBuilder&lt;TEntityType&gt;**
### **SetFilter(Lambda whereClauseExpression) : CollectionConfigBuilder&lt;TEntityType&gt;**

Sets the filter **where clause** expression. Expression must be a `boolean` expression.

Expand Down
2 changes: 1 addition & 1 deletion 10/umbraco-ui-builder/upgrading/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ If you are using one or more of the below sub-packages, they also need to be upg
| Umbraco.UIBuilder.Core | Core UI Builder functionality that doesn't require any infrastructure-specific dependencies |
| Umbraco.UIBuilder.Infrastructure | Infrastructure-specific project containing implementations of core UI Builder functionality |
| Umbraco.UIBuilder.Web | The core UI Builder logic that requires a web context |
| Umbraco.UIBuilder.Web.StaticAssets | The static asstes for the UI Builder presentation layer |
| Umbraco.UIBuilder.Web.StaticAssets | The static assets for the UI Builder presentation layer |
| Umbraco.UIBuilder.Startup | The main logic for registering UI Builder with Umbraco |
| Umbraco.UIBuilder | The main UI Builder package |
2 changes: 1 addition & 1 deletion 10/umbraco-workflow/workflow-section/workflow-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ You can configure the **General** Settings from the **Workflow** section in the
* **Implicit** - All steps where the original Change Author is _not_ a member of the group must be completed. Steps where the original Change Author is a member of the approving group will be completed automatically and noted in the workflow history as not required.
* **Exclude** - Similar to Explicit. All steps must be completed but the original Change Author is not included in the notifications or shown in the dashboard tasks.
* **Approval threshold** - Sets the global approval threshold to One, Most or All:
* **One** - Pending task requires approval from any member of the assigned approval group. This is the default behaviour for all installations (trial and licensed).
* **One** - Pending task requires approval from any member of the assigned approval group. This is the default behavior for all installations (trial and licensed).
* **Most** - Pending task requires an absolute majority of group members. For example, a group with three members requires two approvals and a group with four members requires three approvals.
* **All** - Pending task requires approval from all group members.
* **Rejection resets approvals** - When true, and the approval threshold is Most or All, rejecting a task resets the previous approvals for the workflow stage.
Expand Down
4 changes: 2 additions & 2 deletions 12/umbraco-cms/fundamentals/code/source-control.md
Original file line number Diff line number Diff line change
Expand Up @@ -139,9 +139,9 @@ Any supporting custom code for your application should be in version control, eg

#### Config

Your site's `apsettings.json` and `appsettings.Development.json` files contain the configuration for your Umbraco site.
Your site's `appsettings.json` and `appsettings.Development.json` files contain the configuration for your Umbraco site.

In general, it is recommended to add these to source control. When you do this, be sure that the file(s) doesn't contain any secrets, like API keys and connection strings. These can be added as needed, but ommitted from any commits made to source control.
In general, it is recommended to add these to source control. When you do this, be sure that the file(s) doesn't contain any secrets, like API keys and connection strings. These can be added as needed, but omitted from any commits made to source control.

#### DocumentType - Backoffice Structure Changes

Expand Down
2 changes: 1 addition & 1 deletion 12/umbraco-forms/developer/magic-strings.md
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,7 @@ Umbraco Forms ships with the following filters:
| Format a date | `date` | format string | `[#field \| date: dd-MM-yyyy HH:mm]` |
| HTML encode a string | `html` | | `[#field \| html]` |

The format strings used for fomrmatting dates and numbers are the standard or custom .NET [date](https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings) and [numeric](https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings) format strings respectively.
The format strings used for formatting dates and numbers are the standard or custom .NET [date](https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-date-and-time-format-strings) and [numeric](https://docs.microsoft.com/en-us/dotnet/standard/base-types/standard-numeric-format-strings) format strings respectively.

Further magic string format functions can be [created in code](extending/adding-a-magic-string-format-function.md) for use in forms.

Expand Down
4 changes: 2 additions & 2 deletions 12/umbraco-ui-builder/actions/action-visibility.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ description: Controlling the visibility of actions in Umbraco UI Builder, the ba

# Action Visibility

By default actions are not visible in the UI and you must expressly define when and where an action should display. This can be achived in two ways, either on the action definition itself or at the point of registration on the collections config.
By default actions are not visible in the UI and you must expressly define when and where an action should display. This can be achieved in two ways, either on the action definition itself or at the point of registration on the collections config.

## Controlling the default action visibility

To define the default visbility of an action at the action level you can do this by overriding the `IsVisible` method of the `Action<>` base class.
To define the default visibility of an action at the action level you can do this by overriding the `IsVisible` method of the `Action<>` base class.

````csharp
// Example
Expand Down
6 changes: 3 additions & 3 deletions 12/umbraco-ui-builder/actions/the-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -67,7 +67,7 @@ public class MyAction : Action<MyBulkdActionSettings, ActionResult>
{
settingsConfig.AddFielset("General", fieldsetConfig => fieldsetConfig
.AddField(s => s.RecipientName).SetLabel("Recipient Name")
.AddField(s => s.ReceipientEmail).SetLabel("Recipient Email"))
.AddField(s => s.RecipientEmail).SetLabel("Recipient Email"))
}

public override ActionResult Execute(string collectionAlias, object[] entityIds, MyActionSettings settings)
Expand All @@ -78,8 +78,8 @@ public class MyAction : Action<MyBulkdActionSettings, ActionResult>

public class MyActionSettings
{
public string ReceipientName { get; set; }
public string ReceipientEmail { get; set; }
public string RecipientName { get; set; }
public string RecipientEmail { get; set; }
}
````

Expand Down
2 changes: 1 addition & 1 deletion 12/umbraco-ui-builder/changelog-archive/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ description: Changelog for Konstrukt, the backoffice UI builder for Umbraco.

- Added marketplace updates.
- Update the Konstrukt type finder to use a non-obsolete constructor.
- Updated to use `IComposer` instead of `IUserCompser` as the latter has been removed in v11.
- Updated to use `IComposer` instead of `IUserComposer` as the latter has been removed in v11.
- Fixed parent ID not being passed to create dialog for associated entities.
- Removed settings section restriction on the licensing info endpoint as it would cause errors when the licensing banner is shown in other sections.

Expand Down
4 changes: 2 additions & 2 deletions 12/umbraco-ui-builder/collections/the-basics.md
Original file line number Diff line number Diff line change
Expand Up @@ -60,7 +60,7 @@ collectionConfig.SetIconColor("blue");

Within Umbraco, it is expected that an entity has a name property. So we need to let Umbraco UI Builder know which property to use for the name. If the entity doesn't have a name property, then it needs to know how to construct a name from an entity's other properties. We do this by using either the `SetNameProperty` or `SetNameFormat` methods on a `Collection` config builder instance.

### **SetNameProperty(Lambda nameProperytyExpression) : CollectionConfigBuilder&lt;TEntityType&gt;**
### **SetNameProperty(Lambda namePropertyExpression) : CollectionConfigBuilder&lt;TEntityType&gt;**

Sets which property of your entity to use as the name property. Property must be of type `string`. By defining a property as the name property, its value will be used as the label for the entity in trees and list views. It will also be editable in the header region of the editor interface. The property will also automatically be added to the searchable properties collection and be used for the default sort property.

Expand Down Expand Up @@ -124,7 +124,7 @@ By default, in Umbraco UI Builder any entity that is deleted via the Umbraco UI

### **SetDeletedProperty(Lambda deletedPropertyExpression) : CollectionConfigBuilder&lt;TEntityType&gt;**

Sets which property of our entity to use as the deleted property flag. Property must be of type `boolean` or `int`. When a deleted property is set, any delete actions will set the deleted flag instead of actualy deleting the entity. For `boolean` based properties, deleted entities will have a value of `True` when deleted. For `int` based properties, deleted entities will have a UTC Unix timestamp value of the date the entity was deleted. In addition, any fetch actions will also pre-filter out any deleted entities.
Sets which property of our entity to use as the deleted property flag. Property must be of type `boolean` or `int`. When a deleted property is set, any delete actions will set the deleted flag instead of deleting the entity. For `boolean` based properties, deleted entities will have a value of `True` when deleted. For `int` based properties, deleted entities will have a UTC Unix timestamp value of the date the entity was deleted. In addition, any fetch actions will also pre-filter out any deleted entities.

````csharp
// Example
Expand Down
2 changes: 1 addition & 1 deletion 12/umbraco-ui-builder/filtering/filterable-properties.md
Original file line number Diff line number Diff line change
Expand Up @@ -55,7 +55,7 @@ filterConfig.SetOptions(new Dictionary<string, string> {

## Defining options with custom compare clauses for a filterable property

### **AddOption(object key, string label, Lambda compareExpresion) : FilterablePropertyConfigBuilder&lt;TEntityType, TValueType&gt;**
### **AddOption(object key, string label, Lambda compareExpression) : FilterablePropertyConfigBuilder&lt;TEntityType, TValueType&gt;**

````csharp
// Example
Expand Down
2 changes: 1 addition & 1 deletion 12/umbraco-ui-builder/filtering/global-filters.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ If you want to work with a subset of data within a given collection then this is

Applying a global filter is controlled via the [collections](../collections/overview.md) configuration.

### **SetFilter(Lambda whereClauseExression) : CollectionConfigBuilder&lt;TEntityType&gt;**
### **SetFilter(Lambda whereClauseExpression) : CollectionConfigBuilder&lt;TEntityType&gt;**

Sets the filter **where clause** expression. Expression must be a `boolean` expression.

Expand Down
2 changes: 1 addition & 1 deletion 12/umbraco-ui-builder/upgrading/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,6 @@ If you are using one or more of the below sub-packages, they also need to be upg
| Umbraco.UIBuilder.Core | Core UI Builder functionality that doesn't require any infrastructure-specific dependencies |
| Umbraco.UIBuilder.Infrastructure | Infrastructure-specific project containing implementations of core UI Builder functionality |
| Umbraco.UIBuilder.Web | The core UI Builder logic that requires a web context |
| Umbraco.UIBuilder.Web.StaticAssets | The static asstes for the UI Builder presentation layer |
| Umbraco.UIBuilder.Web.StaticAssets | The static assets for the UI Builder presentation layer |
| Umbraco.UIBuilder.Startup | The main logic for registering UI Builder with Umbraco |
| Umbraco.UIBuilder | The main UI Builder package |
Loading