From 6b89d9d2151b44b3fe9557d3038164941d5d2313 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?S=C3=A1ra=20El-Saig?= <daud.ici@gmail.com>
Date: Tue, 14 Nov 2023 02:11:36 +0100
Subject: [PATCH] TDEAL-2: documentation update. (#378)

* Define the Lombiq paths in the parent submodule.

* Add documentation about using submodules.

* Fix Contributors.
---
 .all-contributorsrc                                 |  6 +++---
 Contributors.md                                     |  2 +-
 Directory.Build.props                               |  4 ++++
 Readme.md                                           | 13 ++++++++++++-
 .../OrchardCore.Commerce.ContentFields.csproj       |  4 ----
 .../OrchardCore.Commerce.Inventory.csproj           |  4 ----
 6 files changed, 20 insertions(+), 13 deletions(-)

diff --git a/.all-contributorsrc b/.all-contributorsrc
index 6f61c76b7..cc5a08860 100644
--- a/.all-contributorsrc
+++ b/.all-contributorsrc
@@ -12,10 +12,10 @@
   "contributorsPerLine": 6,
   "contributors": [
     {
-      "login": "DAud-IcI",
-      "name": "Dávid El-Saig",
+      "login": "sarahelsaig",
+      "name": "Sára El-Saig",
       "avatar_url": "https://avatars.githubusercontent.com/u/4007293?v=4",
-      "profile": "https://github.com/DAud-IcI",
+      "profile": "https://github.com/sarahelsaig",
       "contributions": [
         "code",
         "doc"
diff --git a/Contributors.md b/Contributors.md
index d493308a2..873d09a8c 100644
--- a/Contributors.md
+++ b/Contributors.md
@@ -11,7 +11,7 @@ Thanks goes to these wonderful people ([emoji key](https://allcontributors.org/d
 <!-- markdownlint-disable -->
 <table>
   <tr>
-    <td align="center"><a href="https://github.com/DAud-IcI"><img src="https://avatars.githubusercontent.com/u/4007293?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Dávid El-Saig</b></sub></a><br /><a href="https://github.com/OrchardCMS/OrchardCore.Commerce/commits?author=DAud-IcI" title="Code">💻</a> <a href="https://github.com/OrchardCMS/OrchardCore.Commerce/commits?author=DAud-IcI" title="Documentation">📖</a></td>
+    <td align="center"><a href="https://github.com/sarahelsaig"><img src="https://avatars.githubusercontent.com/u/4007293?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Sára El-Saig</b></sub></a><br /><a href="https://github.com/OrchardCMS/OrchardCore.Commerce/commits?author=sarahelsaig" title="Code">💻</a> <a href="https://github.com/OrchardCMS/OrchardCore.Commerce/commits?author=sarahelsaig" title="Documentation">📖</a></td>
     <td align="center"><a href="https://github.com/DemeSzabolcs"><img src="https://avatars.githubusercontent.com/u/80963259?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Szabolcs Deme</b></sub></a><br /><a href="https://github.com/OrchardCMS/OrchardCore.Commerce/commits?author=DemeSzabolcs" title="Code">💻</a></td>
     <td align="center"><a href="http://bertrandleroy.net/"><img src="https://avatars.githubusercontent.com/u/1165609?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Bertrand Le Roy</b></sub></a><br /><a href="https://github.com/OrchardCMS/OrchardCore.Commerce/commits?author=bleroy" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/Psichorex"><img src="https://avatars.githubusercontent.com/u/92299130?v=4?s=100" width="100px;" alt=""/><br /><sub><b>Roland Márkus</b></sub></a><br /><a href="https://github.com/OrchardCMS/OrchardCore.Commerce/commits?author=Psichorex" title="Code">💻</a></td>
diff --git a/Directory.Build.props b/Directory.Build.props
index 670aa8c5f..16851b49b 100644
--- a/Directory.Build.props
+++ b/Directory.Build.props
@@ -18,4 +18,8 @@
           DestinationFiles="$(ProjectDir)OrchardCoreIcon.png"
           SkipUnchangedFiles="true" />
   </Target>
+
+  <!-- Inherit parent props file if one exists. -->
+  <Import Condition="$([MSBuild]::GetPathOfFileAbove('Directory.Build.props', '$(MSBuildThisFileDirectory)../')) != ''"
+          Project="$([MSBuild]::GetPathOfFileAbove('Directory.Build.props', '$(MSBuildThisFileDirectory)../'))" />
 </Project>
diff --git a/Readme.md b/Readme.md
index 1fcc11f63..a6eaf76b9 100644
--- a/Readme.md
+++ b/Readme.md
@@ -22,7 +22,18 @@ See the [discussions page](https://github.com/OrchardCMS/OrchardCore.Commerce/di
 
 ### Pre-requisites
 
-This project uses `Lombiq Node.js Extensions` to compile and lint client-side assets. See its pre-requisites [here](https://github.com/Lombiq/NodeJs-Extensions/tree/dev#pre-requisites).
+This project uses [`Lombiq Node.js Extensions`](https://github.com/Lombiq/NodeJs-Extensions) to compile and lint client-side assets. See its pre-requisites [here](https://github.com/Lombiq/NodeJs-Extensions/tree/dev#pre-requisites).
+
+If you want to include OrchardCore.Commerce as a git submodule instead of NuGet package, include the [`Lombiq Helpful Libraries`](https://github.com/Lombiq/Helpful-Libraries/) and `Lombiq Node.js Extensions` submodules as well. In your solution directory create a _Directory.Build.props_ file if one doesn't exist. This should contain the properties that configure the path to the _Lombiq.HelpfulLibraries.OrchardCore.csproj_ file and the _Lombiq.NodeJs.Extensions_ project directory. For example:
+
+```xml
+<Project>
+  <PropertyGroup>
+    <LombiqHelpfulLibrariesPath>$(MSBuildThisFileDirectory)/src/Libraries/Lombiq.HelpfulLibraries/Lombiq.HelpfulLibraries.OrchardCore/Lombiq.HelpfulLibraries.OrchardCore.csproj</LombiqHelpfulLibrariesPath>
+    <LombiqNodeJsExtensionsPath>$(MSBuildThisFileDirectory)/src/Utilities/Lombiq.NodeJs.Extensions/Lombiq.NodeJs.Extensions</LombiqNodeJsExtensionsPath>
+  </PropertyGroup>
+</Project>
+```
 
 ### Setup
 
diff --git a/src/Modules/OrchardCore.Commerce.ContentFields/OrchardCore.Commerce.ContentFields.csproj b/src/Modules/OrchardCore.Commerce.ContentFields/OrchardCore.Commerce.ContentFields.csproj
index e2bfde3e3..a78caf11e 100644
--- a/src/Modules/OrchardCore.Commerce.ContentFields/OrchardCore.Commerce.ContentFields.csproj
+++ b/src/Modules/OrchardCore.Commerce.ContentFields/OrchardCore.Commerce.ContentFields.csproj
@@ -37,10 +37,6 @@
     <ProjectReference Include="..\..\Libraries\OrchardCore.Commerce.Abstractions\OrchardCore.Commerce.Abstractions.csproj" />
   </ItemGroup>
 
-  <PropertyGroup>
-    <LombiqHelpfulLibrariesPath>..\..\..\..\..\Libraries\Lombiq.HelpfulLibraries\Lombiq.HelpfulLibraries.OrchardCore\Lombiq.HelpfulLibraries.OrchardCore.csproj</LombiqHelpfulLibrariesPath>
-  </PropertyGroup>
-
   <ItemGroup Condition="Exists($(LombiqHelpfulLibrariesPath))">
     <ProjectReference Include="$(LombiqHelpfulLibrariesPath)" />
   </ItemGroup>
diff --git a/src/Modules/OrchardCore.Commerce.Inventory/OrchardCore.Commerce.Inventory.csproj b/src/Modules/OrchardCore.Commerce.Inventory/OrchardCore.Commerce.Inventory.csproj
index 7dcea8ba2..cffb8ffde 100644
--- a/src/Modules/OrchardCore.Commerce.Inventory/OrchardCore.Commerce.Inventory.csproj
+++ b/src/Modules/OrchardCore.Commerce.Inventory/OrchardCore.Commerce.Inventory.csproj
@@ -33,10 +33,6 @@
     <PackageReference Include="OrchardCore.Module.Targets" Version="1.7.0" />
   </ItemGroup>
 
-  <PropertyGroup>
-    <LombiqHelpfulLibrariesPath>..\..\..\..\..\Libraries\Lombiq.HelpfulLibraries\Lombiq.HelpfulLibraries.OrchardCore\Lombiq.HelpfulLibraries.OrchardCore.csproj</LombiqHelpfulLibrariesPath>
-  </PropertyGroup>
-
   <ItemGroup Condition="Exists($(LombiqHelpfulLibrariesPath))">
     <ProjectReference Include="$(LombiqHelpfulLibrariesPath)" />
   </ItemGroup>