Skip to content

Commit

Permalink
Merge branch 'main' into v813/media-picker-3
Browse files Browse the repository at this point in the history
  • Loading branch information
sofietoft authored May 19, 2021
2 parents c517063 + f3228b0 commit 0c2b7aa
Show file tree
Hide file tree
Showing 226 changed files with 8,965 additions and 1,026 deletions.
16 changes: 10 additions & 6 deletions Add-ons/The-Licensing-model/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@ Even though we use the same licensing model for Umbraco Forms and Umbraco Courie
- The license allows for an unlimited number of forms
- The license also includes `localhost` as a valid domain

In the case the you run multiple sites within one Umbraco installation, e.g. you have multiple domains pointing at the same installation, you have the option to purchase and add **additional domains** to your license.
In the case you run multiple sites within one Umbraco installation, e.g. you have multiple domains pointing at the same installation, you have the option to purchase and add **additional domains** to your license.

Additional domains can be purchased from your account on [Umbraco.com](https://umbraco.com) for 129 €. Each additional domain includes 1 live domain and 2 development / testing domains.

Expand All @@ -55,12 +55,16 @@ That this is an add-on domain for existing licenses. Refunds will not be given f

### Umbraco Deploy

- A single license covers the installation and use of Umbraco Deploy in 1 production domain, as well as 2 development domains
- The production domain includes all subdomains (e.g. `*.domain.tld`), as well as the `.local` extension (e.g. `domain.tld.local`)
- The development domains works with or without the `www` subdomain
- The license also includes `localhost` as a valid domain
Deploy license:

A single licence covers one Umbraco solution, including all domains hosted by the solution,
all production environments (if load-balancing) and all non-production environments.

To clarify on the above:

- You only need one license when you have a solution covering multiple domains- e.g. www.mysite.com and www.mysite.dk - load balanced in production over multiple servers running from the same database, managed from the same back-office instance, and with any number of non-production environments (staging, qa, etc.)

For the Umbraco Deploy license you do not need to purchase additional domains if you are running multiple sites within the same Umbraco installation.
- You need two licences If you have a web presence that consists of two separate websites hosted on different domains or sub-domains - e.g. www.mysite.com and shop.mysite.com - with each of these managed as a separate Umbraco installation using their own database and back-office in production.

:::note
The license for Umbraco Deploy comes with a recurring yearly fee. Learn more about this and pricing on [Umbraco.com](https://umbraco.com/products/umbraco-deploy/).
Expand Down
370 changes: 370 additions & 0 deletions Add-ons/Umbraco-Deploy/Extending/index.md

Large diffs are not rendered by default.

14 changes: 13 additions & 1 deletion Add-ons/Umbraco-Deploy/Installing-Deploy/Existing-site/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ The next step to get Umbraco Deploy up and running is to set up a repository and
2. Clone down the repository to your local machine.
3. Create a new Visual Studio project in the repository folder.
4. Install Umbraco CMS through NuGet - `Install-Package UmbracoCms`.
5. use the copy of your production Database when setting up the database for the emppty project.
5. Use the copy of your production Database when setting up the database for the emppty project.
6. Add the `/Views` folder as well as the folders holding your css files and scripts.
7. Commit the files so they are ready to be pushed up once you have set up the build server.
8. Run the project.
Expand Down Expand Up @@ -76,6 +76,10 @@ To be able to use Umbraco Forms with Umbraco Deploy, you need to install the ``
Umbraco Deploy supports Forms version 8.5 and up.
:::

:::note
In order to deploy content based on certain rich core and community property editors - including Nested Content, Multi URL Picker and Block List Editor - there is one further NuGet package to install: ```UmbracoDeploy.Contrib```.
:::

Once the installation has finished you might notice a new file in your `/config` folder called `UmbracoDeploy.config`. This files tells the deployment engine where to deploy to. It knows which environment you’re currently on (for example local or staging) and it will choose the next environment in the list to deploy to.

When Umbraco Deploy has been installed, to be able to use it in the project you will need to add the following `appSetting` to the `web.config` of the project:
Expand Down Expand Up @@ -149,6 +153,14 @@ The `type` value is for informational purposes in the backoffice but in most cas

The URLs for each environment needs to be accessible by the other environments over **HTTPS**.

When you have set up your environments in the `UmbracoDeploy.Config` to make sure that Umbraco Deploy knows which environment you are on, the following `AppSetting` needs to be set on the different environments:

```xml
<add key="Umbraco.Deploy.EnvironmentName" value="YourEnvironmentHere" />
```

The value needs to be the environment type that has been set in the `UmbracoDeploy.config` for the specific environment you have for Umbraco Deploy.

:::note
You're free to update the `name` attribute to make it clearer in the interface where you're deploying to. So, if you want to name “Development” something like “The everything-goes area” then you can do that and it will be shown when deploying to that environment.
:::
Expand Down
12 changes: 11 additions & 1 deletion Add-ons/Umbraco-Deploy/Installing-Deploy/New-site/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -71,6 +71,10 @@ To be able to use Umbraco Forms with Umbraco Deploy, you need to install the ``
Umbraco Deploy supports Forms version 8.5 and up.
:::

:::note
In order to deploy content based on certain rich core and community property editors - including Nested Content, Multi URL Picker and Block List Editor - there is one further NuGet package to install: ```UmbracoDeploy.Contrib```.
:::

Once the installation has finished you might notice a new file in your `/config` folder called `UmbracoDeploy.config`. This files tells the deployment engine where to deploy to. It knows which environment you’re currently on (for example local or staging) and it will choose the next environment in the list to deploy to.

When Umbraco Deploy has been installed, to be able to use it in the project you will need to add the following `appSetting` to the `web.config` of the project:
Expand Down Expand Up @@ -144,7 +148,13 @@ The `type` value is for informational purposes in the backoffice but in most cas

The URLs for each environment needs to be accessible by the other environments over **HTTPS**.

:::note
When you have set up your environments in the `UmbracoDeploy.Config` the following `AppSetting` needs to be set on the different environments that you have set up with Umbraco Deploy:

```xml
<add key="Umbraco.Deploy.EnvironmentName" value="TheEnvironmentTypeHere" />
```

:::note
You're free to update the `name` attribute to make it clearer in the interface where you're deploying to. So, if you want to name “Development” something like “The everything-goes area” then you can do that and it will be shown when deploying to that environment.
:::

Expand Down
4 changes: 4 additions & 0 deletions Add-ons/Umbraco-Deploy/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,10 @@ The deployment process explained for Umbraco Deploy.

How you can Upgrade Umbraco Deploy.

## [Extending](Extending)

Details how Umbraco Deploy can be extended for the purposes of deploying data related to custom data and property editors.

## [Troubleshooting](Troubleshooting)

Tips on finding, identifying and resolving issues with Umbraco Deploy.
Expand Down
3 changes: 3 additions & 0 deletions Add-ons/UmbracoForms/Developer/Configuration/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -106,3 +106,6 @@ This setting needs to be a `True` or `False` value and will allow you to toggle

### DefaultMessageOnSubmit
This allows you to configure what text is displayed when a form is submitted and is not being redirected to a different content node.

### DefaultStoreRecordsLocally
This setting needs to be a `True` or `False` value and will allow you to toggle if form submission data will be stored in the Umbraco Forms database tables. By default this is set to `True`.
6 changes: 0 additions & 6 deletions Add-ons/UmbracoForms/Developer/Extending/Adding-a-Type.md
Original file line number Diff line number Diff line change
Expand Up @@ -78,12 +78,6 @@ For all types that use the provider model, settings work this way. By adding the

## Validate type settings with ValidateSettings()

:::warning
Currently, there is a bug with using this specific code snippet.

The bug has been reported, and you can follow the process here: [UmbracoForms.Issues](https://github.com/umbraco/Umbraco.Forms.Issues/issues/433). As long as the issue is open, this code snippet below will not be triggered when applied to your application.
:::

The ValidateSettings() method which can be found on all types supporting dynamic settings, is used for making sure the data entered by the user is valid and works with the type.

```csharp
Expand Down
22 changes: 12 additions & 10 deletions Add-ons/UmbracoForms/Developer/Healthchecks/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,13 @@ meta.Title: "Healthchecks"
In this article, you will find information about Umbraco Forms-related health checks that can be run from the Umbraco backoffice to ensure that your installation is running seamlessly.

Read the [Health Check](../../../Extending/Health-Check) article to learn more about the feature in general.

## Database Integrity Health Check

Running this health check will verify whether the database tables for the Umbraco Forms installation are all set up correctly with the proper data integrity checks.

In this section, you can learn more about the background for adding this check, as well as how to use and understand the results.

### Background

With version 8.7, a health check was introduced to confirm the Umbraco Forms database tables are all set up with the expected data integrity checks - i.e. primary keys, foreign keys and unique constraints.
Expand All @@ -23,7 +25,7 @@ There remains the possibility though that not all will be in place for a particu

In particular, prior to version 8.7, there were a number of tables that weren't defined as strictly as they should be in this area. So we've added some primary key, foreign key and unique constraints with this version. If you've been running a version prior to this and are upgrading, these schema updates will be applied automatically _unless_ there is existing data in the tables that prevent them from being added.

There shouldn't be - but without these constraints in place it's always possible for an application bug to exist that allows for example the creation of duplicate records, or the ophaning of records, that aren't correct. Of course, this is the reason for the constraints to exist, and why we want to ensure they are in place.
There shouldn't be - but without these constraints in place it's always possible for an application bug to exist that allows for example the creation of duplicate records, or the ophaning of records, that aren't correct. This is the reason for the constraints to exist, and why we want to ensure they are in place.

### Running The Health Check

Expand All @@ -47,10 +49,10 @@ As well as in the log files, such issues will be visible via the health check an

To support this, we provide the following SQL scripts:

- Apply database integrity schema changes for 8.7.0 - [8.7.0-apply-keys-and-indexes.sql](scripts/8.7.0-apply-keys-and-indexes.sql)
- Apply database integrity schema changes for 8.7.0 (forms in database tables) - [8.7.0-apply-keys-and-indexes-forms-in-db.sql](scripts/8.7.0-apply-keys-and-indexes-forms-in-db.sql)
- Apply database integrity schema changes for 8.7.0 - [8.7.0-apply-keys-and-indexes](scripts/Apply-keys.md)
- Apply database integrity schema changes for 8.7.0 (forms in database tables) - [8.7.0-apply-keys-and-indexes-forms-in-db](scripts/Forms-in-the-database-apply-keys.md)

The first of these provides the SQL statements required to apply the schema updates for 8.7.0 to the common Umbraco Forms tables. The second applies just to those tables used for when forms are stored in the database, and hence only need to be applied if that option is configured.
The first of these provides the SQL statements required to apply the schema updates for 8.7.0 to the common Umbraco Forms tables. The second applies to those tables used for when forms are stored in the database, and hence only need to be applied if that option is configured.

:::note
Before running any scripts or queries, please be sure to have a database backup in place.
Expand All @@ -60,7 +62,7 @@ To take an example, let's say that via the health check results you can see that

If you look in the SQL script you'll see that in order to apply this directly to the database, you would need to run the following SQL statement:

```
```sql
-- Adds unique constraint to UFForms.
ALTER TABLE dbo.UFForms
ADD CONSTRAINT UK_UFForms_Key UNIQUE NONCLUSTERED
Expand All @@ -72,15 +74,15 @@ GO

If you run it though, you'll see the reason why the migration that ran when Umbraco Forms was upgraded couldn't apply the change:

```
```sql
The CREATE UNIQUE INDEX statement terminated because a duplicate key was found for the object name 'dbo.UFForms' and the index name 'UK_UFForms_Key'. The duplicate key value is (...).
```

The constraint can't be applied if there are existing duplicate values, so first they need to be found and removed.

To find duplicate values in the 'Key' field in this table you can run the following SQL statement:

```
```sql
SELECT [Key]
FROM UFForms
GROUP BY [Key]
Expand All @@ -91,7 +93,7 @@ Running the statement above will list out the 'Key' fields that are duplicated i

To see the full details of the duplicate records, you can use this query:

```
```sql
SELECT *
FROM UFForms
WHERE [Key] IN (SELECT [Key]
Expand All @@ -111,5 +113,5 @@ If for any reason you wish to revert the changes - perhaps when testing these up

To support this, we provide the following SQL scripts:

- Revert database integrity schema changes for 8.7.0 - [8.7.0-apply-keys-and-indexes_revert.sql](scripts/8.7.0-apply-keys-and-indexes_revert.sql)
- Revert database integrity schema changes for 8.7.0 (forms in database tables) - [8.7.0-apply-keys-and-indexes-forms-in-db_revert.sql](scripts/8.7.0-apply-keys-and-indexes-forms-in-db_revert.sql)
- Revert database integrity schema changes for 8.7.0 - [8.7.0-apply-keys-and-indexes_revert](scripts/Apply-keys.md#revert-application-of-keys-and-indexes)
- Revert database integrity schema changes for 8.7.0 (forms in database tables) - [8.7.0-apply-keys-and-indexes-forms-in-db_revert](scripts/Forms-in-the-database-apply-keys.md#reverting-the-application-of-keys-and-indexes)

This file was deleted.

This file was deleted.

Loading

0 comments on commit 0c2b7aa

Please sign in to comment.