Merge pull request #167 from leekelleher/dev/v2.x

Preparing v2.2.0 release
leekelleher · Oct 5, 2021 · f62d093 · f62d093
2 parents f7e8436 + b52c2ff
commit f62d093
Show file tree

Hide file tree

Showing 78 changed files with 1,318 additions and 161 deletions.
diff --git a/.github/IDEAS.md b/.github/IDEAS.md
@@ -55,7 +55,8 @@ Remove hard-coded English labels, move them to the language XML file.
 ## Support for Umbraco Deploy?
 
 - Implement artifact dependency logic for `IValueConnector`, `IDataTypeConfigurationConnector`?
-
+- Implement uSync's `ISyncMapper.GetDependencies`?
+  https://github.com/KevinJump/uSyncDataSync.Example/blob/deeedfe8180c2d9e4eb6e57ad6bb1cd6814bebe7/uSync.Example.DataSync/Mappers/ExampleDataMapper.cs#L93
 
 ## Deprecation considerations
 

diff --git a/.github/ISSUE_TEMPLATE/ISSUE_BUG_REPORT.md b/.github/ISSUE_TEMPLATE/ISSUE_BUG_REPORT.md
diff --git a/.github/ISSUE_TEMPLATE/ISSUE_FEATURE_REQUEST.md b/.github/ISSUE_TEMPLATE/ISSUE_FEATURE_REQUEST.md
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml
@@ -0,0 +1,71 @@
+name: "Bug report"
+description: "File a bug report to help us improve."
+labels: "bug-report"
+assignees:
+  - leekelleher
+body:
+- type: markdown
+  attributes:
+    value: |
+      **Note: for support questions, please use the [Umbraco Community forum](https://our.umbraco.com)**. This repository's issues are reserved for bug reports and feature requests.
+- type: input
+  id: "contentmentVersion"
+  attributes:
+    label: "Which Contentment version are you using?"
+    description: "If you are unsure, we'll assume it's the latest version."
+  validations:
+    required: true
+- type: input
+  id: "umbracoVersion"
+  attributes:
+    label: "Which Umbraco version are you using? For example: 8.14.1 - don't just write v8"
+    description: "Use the help icon in the Umbraco backoffice to find the version you're using."
+  validations:
+    required: true
+- type: textarea
+  id: "summary"
+  attributes:
+    label: "Bug summary"
+    description: "Write a summary of the bug."
+    description: "Remember that you can format code and logs nicely with the `<>` button"
+    placeholder: >
+      Try to pinpoint it as much as possible.
+      
+      Try to state the actual problem, and not just what you think the solution might be.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: "Steps to reproduce"
+    id: "reproduction"
+    description: "How can we reproduce the problem on a clean Contentment + Umbraco install?"
+    placeholder: >
+      Please include any links, screenshots, stack-traces, etc.
+  validations:
+    required: true
+- type: textarea
+  attributes:
+    label: "Expected result / actual result"
+    id: "result"
+    description: "What did you expect that would happen on your Umbraco site and what is the actual result of the above steps?"
+    placeholder: >
+      Describe the intended/desired outcome after you did the steps mentioned.
+      
+      Describe the behaviour of the bug
+- type: checkboxes
+  id: umbracoModelsBuilder
+  attributes:
+    label: Do you have Umbraco ModelsBuilder enabled?
+    description: "Select only if applicable."
+    options:
+      - label: Yes, it is enabled.
+- type: dropdown
+  id: browsers
+  attributes:
+    label: What browsers are you seeing the problem on?
+    multiple: true
+    options:
+      - Firefox
+      - Chrome
+      - Safari
+      - Microsoft Edge
diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml
@@ -1,7 +1,10 @@
 blank_issues_enabled: false
 contact_links:
+  - name: Features and ideas
+    url: https://github.com/leekelleher/umbraco-contentment/discussions/new?category=ideas
+    about: Suggest an idea for this project
   - name: Umbraco Community forum
-    url: https://our.umbraco.com/
+    url: https://our.umbraco.com/packages/backoffice-extensions/contentment/contentment-feedback/
     about: "For community (free) support questions, please use the Umbraco Community forum."
   - name: "Commericial support"
     url: https://umbrellainc.co.uk/

diff --git a/.github/README.md b/.github/README.md
@@ -6,7 +6,7 @@
 
 ### What is it?
 
-This is a collection of Umbraco components that I have developed for use on my own **Umbraco 8** implementation projects.
+This is a collection of Umbraco components that I have developed for use on my own **Umbraco** implementation projects.
 
 Some components may be innovative, others may be a reimagining of existing components, property-editors, features and other community packages.
 
@@ -31,6 +31,7 @@ Let's take a look inside...
 - [Notes](../docs/editors/notes.md) - a read-only label to display rich-text instructional messages for content editors.
 - [Number Input](../docs/editors/number-input.md) - a numeric editor, with sizing configurations.
 - [Render Macro](../docs/editors/render-macro.md) - a read-only label dynamically generated from an Umbraco Macro.
+- [Templated Label](../docs/editors/templated-label.md) - a display label, ideal for showing data from 3rd-party systems.
 - [Text Input](../docs/editors/text-input.md) - a textstring editor, configurable with HTML5 options.
 
 #### Telemetry
@@ -43,23 +44,26 @@ Downloads are available on the [releases page](https://github.com/leekelleher/um
 
 #### Installation
 
-> *Note:* Contentment v2.x has been developed against **Umbraco v8.14.0** and will support that version and above.
-> If you are using **Umbraco v8.6.1 (or above)**, you can continue to use Contentment v1.x.
+_**Please note...**_
 
-Contentment can be installed from either Our Umbraco or NuGet package repositories, or build manually from the source-code:
+- v3.x has been developed against **Umbraco v9.0-RC001** and will support that version and above.
+- v2.x has been developed against **Umbraco v8.14.0** and will support that and future Umbraco v8.x releases.
+- v1.x has been developed against **Umbraco v8.6.1**, it will still work on current Umbraco v8.x releases.
 
-##### Our Umbraco package repository
-
-To install from Our Umbraco, please download the package from:
-
-> <https://our.umbraco.com/packages/backoffice-extensions/contentment/>
+With Contentment v3.x (Umbraco v9.0 / .NET 5), you can only install a package from the [NuGet package repository](https://www.nuget.org/packages/Our.Umbraco.Community.Contentment). For previous Contentment versions, the package can be installed from either [Our Umbraco](https://our.umbraco.com/packages/backoffice-extensions/contentment/) or NuGet package repositories, or build manually from the source-code:
 
 ##### NuGet package repository
 
 To [install from NuGet](https://www.nuget.org/packages/Our.Umbraco.Community.Contentment), you can run the following command from within Visual Studio:
 
     PM> Install-Package Our.Umbraco.Community.Contentment
 
+##### Our Umbraco package repository
+
+For Contentment v1.x and v2.x, you can install from Our Umbraco, please download the package from:
+
+> <https://our.umbraco.com/packages/backoffice-extensions/contentment/>
+
 #### Known issues
 
 - **Data List**
@@ -131,7 +135,7 @@ For more information about the Mozilla Public License, please visit: <https://ww
 - [Lee Kelleher](https://leekelleher.com) - ([GitHub](https://github.com/leekelleher), [Twitter](https://twitter.com/leekelleher))
 
 <details>
-<summary>Current development effort: <b>1010+ hours</b> (between 2019-03-13 to 2021-06-08)</summary>
+<summary>Current development effort: <b>1050+ hours</b> (between 2019-03-13 to 2021-07-09)</summary>
 
 _To give you an idea of how much human developer time/effort has been put into making this package._
 

diff --git a/.github/ROADMAP.md b/.github/ROADMAP.md
@@ -58,22 +58,25 @@ Property Editors are:
 
 ### v2.2
 
+- [Templated Label](https://github.com/leekelleher/umbraco-contentment/discussions/100)
+
+### v2.3
+
 - [Data List: Groups](https://github.com/leekelleher/umbraco-contentment/discussions/90)
 
 
 ## v3
 
 ### v3.0
 
-- A breaking-change release of latest v2.x features that compiles against Umbraco CMS v9.0 (.NET 5). _**Currently under development,** [see my developer's journal for the latest updates](https://github.com/leekelleher/umbraco-contentment/discussions/105)._
+- A breaking-change release of latest v2.x features that compiles against Umbraco CMS v9.0 (.NET 5).
 
 
 ## Future feature releases
 
 _Who knows?!_ `¯\_(ツ)_/¯`
 
 - Cascading Dropdown List _(uses API endpoints to populate the dropdowns)_
-- [Templated Label](https://github.com/leekelleher/umbraco-contentment/discussions/100)
 - [Time Duration](https://github.com/leekelleher/umbraco-contentment/discussions/114)
 
 **There are [plenty of ideas](IDEAS.md)!**

diff --git a/.gitignore b/.gitignore
@@ -17,4 +17,5 @@ src/packages/*/**
 /tools/*.exe
 /build/__umb/*
 /build/__nuget/*
-/build/build-push.ps1
+/build/build-push-nuget.ps1
+/build/build-push-umb.ps1
diff --git a/VERSION b/VERSION
@@ -1 +1 @@
-2.1.0
+2.2.0
diff --git a/build/build-pkgs.ps1 b/build/build-pkgs.ps1
@@ -19,6 +19,7 @@ $authorName = 'Lee Kelleher';
 $authorUrl = 'https://leekelleher.com/';
 $minUmbracoVersion = 8,14,0;
 $copyright = "Copyright " + [char]0x00A9 + " " + (Get-Date).year + " $authorName";
+$tags = "umbraco";
 
 $rootFolder = (Get-Item($MyInvocation.MyCommand.Path)).Directory.Parent.FullName;
 $buildFolder = Join-Path -Path $rootFolder -ChildPath 'build';
@@ -105,8 +106,8 @@ Compress-Archive -Path "${umbFolder}\*" -DestinationPath "${artifactsFolder}\Con
 # Populate the NuGet package manifest
 
 Copy-Item -Path "${rootFolder}\docs\assets\img\logo.png" -Destination "${assetsFolder}\icon.png";
-& $nuget_exe pack "${buildFolder}\manifest-nuget-core.nuspec" -BasePath $assetsFolder -OutputDirectory $artifactsFolder -Version "$version" -Properties "id=$nugetPackageId;version=$version;title=$nugetTitle;authors=$authorName;owners=$authorName;projectUrl=$packageUrl;requireLicenseAcceptance=false;description=$packageDescription;copyright=$copyright;license=MPL-2.0;language=en;tags=umbraco;minUmbracoVersion=$($minUmbracoVersion[0]).$($minUmbracoVersion[1]).$($minUmbracoVersion[2]);repositoryUrl=$packageUrl;"
-& $nuget_exe pack "${buildFolder}\manifest-nuget-web.nuspec" -BasePath $assetsFolder -OutputDirectory $artifactsFolder -Version "$version" -Properties "id=$nugetPackageId;version=$version;title=$nugetTitle;authors=$authorName;owners=$authorName;projectUrl=$packageUrl;requireLicenseAcceptance=false;description=$packageDescription;copyright=$copyright;license=MPL-2.0;language=en;tags=umbraco;minUmbracoVersion=$($minUmbracoVersion[0]).$($minUmbracoVersion[1]).$($minUmbracoVersion[2]);repositoryUrl=$packageUrl;"
+& $nuget_exe pack "${buildFolder}\manifest-nuget-core.nuspec" -BasePath $assetsFolder -OutputDirectory $artifactsFolder -Version "$version" -Properties "id=$nugetPackageId;version=$version;title=$nugetTitle;authors=$authorName;owners=$authorName;projectUrl=$packageUrl;requireLicenseAcceptance=false;description=$packageDescription;copyright=$copyright;license=MPL-2.0;language=en;tags=$tags;minUmbracoVersion=$($minUmbracoVersion[0]).$($minUmbracoVersion[1]).$($minUmbracoVersion[2]);repositoryUrl=$packageUrl;"
+& $nuget_exe pack "${buildFolder}\manifest-nuget-web.nuspec" -BasePath $assetsFolder -OutputDirectory $artifactsFolder -Version "$version" -Properties "id=$nugetPackageId;version=$version;title=$nugetTitle;authors=$authorName;owners=$authorName;projectUrl=$packageUrl;requireLicenseAcceptance=false;description=$packageDescription;copyright=$copyright;license=MPL-2.0;language=en;tags=$tags;minUmbracoVersion=$($minUmbracoVersion[0]).$($minUmbracoVersion[1]).$($minUmbracoVersion[2]);repositoryUrl=$packageUrl;"
 
 
 # Tidy up folders

diff --git a/docs/README.md b/docs/README.md
@@ -20,6 +20,7 @@ Here is the documentation for the Contentment property-editors...
 - [Notes](../docs/editors/notes.md) - a read-only label to display rich-text instructional messages for content editors.
 - [Number Input](../docs/editors/number-input.md) - a numeric editor, with sizing configurations.
 - [Render Macro](../docs/editors/render-macro.md) - a read-only label dynamically generated from an Umbraco Macro.
+- [Templated Label](../docs/editors/templated-label.md) - a display label, ideal for showing data from 3rd-party systems.
 - [Text Input](../docs/editors/text-input.md) - a textstring editor, configurable with HTML5 options.
 
 

diff --git a/docs/data-sources/README.md b/docs/data-sources/README.md
@@ -0,0 +1,47 @@
+<img src="../assets/img/logo.png" alt="Contentment for Umbraco logo" title="A state of Umbraco happiness." height="130" align="right">
+
+## Contentment for Umbraco
+
+### Data Sources
+
+The following data-sources are available by default with the Contentment package for the [Data List](../editors/data-list.md) and [Text Input](../editors/text-input.md) editors.
+
+#### .NET
+
+- [.NET Countries (ISO 3166)](data-source--countries.md) - All the countries available in the .NET Framework, (as installed on the web server).
+- [.NET Currencies (ISO 4217)](data-source--currencies.md) - All the currencies available in the .NET Framework, (as installed on the web server).
+- [.NET Enumeration](data-source--enum.md) - Select an enumeration from a .NET assembly as the data source.
+- [.NET Languages (ISO 639)](data-source--languages.md) - All the languages available in the .NET Framework, (as installed on the web server).
+- [.NET Time Zones (UTC)](data-source--timezone.md) - All the time zones available in the .NET Framework.
+
+#### Data
+
+- [File System](data-source--file-system.md) - Select paths from the physical file system as the data source.
+- [JSON Data](data-source--json.md) - Configure JSON data to populate the data source.
+- [Number Range](data-source--number-range.md) - Generates a sequence of numbers within a specified range.
+- [SQL Data](data-source--sql.md) - Use a SQL Server database query as the data source.
+- [Text Delimited Data](data-source--text-delimited.md) - Configure text-delimited data to populate the data source.
+- [User-defined List](data-source--user-defined.md) - Manually configure the items for the data source.
+- [XML Data](data-source--xml.md) - Configure XML data to populate the data source.
+
+#### Umbraco
+
+- [Examine Query](data-source--examine.md) - Populate the data source from an Examine query.
+- [Umbraco Content](data-source--umbraco-content.md) - Select a start node to use its children as the data source.
+- [Umbraco Content Properties](data-source--umbraco-content-properties.md) - Populate the data source using a Content Type's properties.
+- [Umbraco Content Types](data-source--umbraco-content-types.md) - Populate the data source using Content Types.
+- [Umbraco Content by XPath](data-source--umbraco-content-xpath.md) - Use an XPath query to select Umbraco content to use as the data source.
+- [Umbraco Dictionary Items](data-source--umbraco-dictionary.md) - Select an Umbraco dictionary item to populate the data source with its child items.
+- [Umbraco Entities](data-source--umbraco-entity.md) - Select an Umbraco entity type to populate the data source.
+- [Umbraco Image Crops](data-source--umbraco-image-crop.md) - Select an Image Cropper data-type to use its defined crops to populate the data source.
+- [Umbraco Languages](data-source--umbraco-languages.md) - Populate the data source with langauges configured in Umbraco.
+- [Umbraco Member Groups](data-source--umbraco-member-group.md) - Populate the data source with Umbraco member groups.
+- [Umbraco Members](data-source--umbraco-members.md) - Use Umbraco members to populate the data source.
+- [Umbraco Tags](data-source--umbraco-tags.md) - Populate the data source using already defined tags.
+
+
+#### Web
+
+- [uCssClassName](data-source--ucssclassname.md) - A homage to @marcemarc's bingo-famous uCssClassNameDropdown package!
+- [XML Sitemap: Change Frequency](data-source--xml-sitemap-change-frequency.md) - Populate the data source using XML Sitemap change frequency values.
+- [XML Sitemap: Priority](data-source--xml-sitemap-priority.md) - Populate the data source using XML Sitemap priority values.
diff --git a/docs/data-sources/data-source--countries.md b/docs/data-sources/data-source--countries.md
@@ -0,0 +1,19 @@
+<img src="../assets/img/logo.png" alt="Contentment for Umbraco logo" title="A state of Umbraco happiness." height="130" align="right">
+
+## Contentment for Umbraco
+
+### Data Sources
+
+#### .NET Countries (ISO 3166)
+
+All the countries available in the .NET Framework, (as installed on the web server).
+
+
+##### How to configure the editor?
+
+_[TBC]_
+
+
+##### What is the value's object-type?
+
+_[TBC]_
diff --git a/docs/data-sources/data-source--currencies.md b/docs/data-sources/data-source--currencies.md
@@ -0,0 +1,19 @@
+<img src="../assets/img/logo.png" alt="Contentment for Umbraco logo" title="A state of Umbraco happiness." height="130" align="right">
+
+## Contentment for Umbraco
+
+### Data Sources
+
+#### .NET Currencies (ISO 4217)
+
+All the currencies available in the .NET Framework, (as installed on the web server).
+
+
+##### How to configure the editor?
+
+_[TBC]_
+
+
+##### What is the value's object-type?
+
+_[TBC]_
diff --git a/docs/data-sources/data-source--enum.md b/docs/data-sources/data-source--enum.md
@@ -0,0 +1,19 @@
+<img src="../assets/img/logo.png" alt="Contentment for Umbraco logo" title="A state of Umbraco happiness." height="130" align="right">
+
+## Contentment for Umbraco
+
+### Data Sources
+
+#### .NET Enumeration
+
+Select an enumeration from a .NET assembly as the data source.
+
+
+##### How to configure the editor?
+
+_[TBC]_
+
+
+##### What is the value's object-type?
+
+_[TBC]_