Clarify the use of Solutions vs Solution Filters in the repository (#3037)

* Update CONTRIBUTING.md

* Renamed Sentry.NoMobile.sln to .generated.NoMobile.sln

Author: jamescrosswell

Sentry.NoMobile.sln renamed to .generated.NoMobile.sln

@@ -57,10 +57,16 @@ Also note `/Directory.Build.targets` contains some [convention based rules](http
 
 ## Solution Filters
 
-Most contributors will rarely need to load Sentry.sln. The repository contains various solution filters that will be more practical for day to day tasks.
+_TLDR;_ when working with the the Sentry codebase, you should use the solution filters (not the solutions).
+
+_Full explanation:_ 
+
+The `Sentry.sln` solution contains all of the projects required to build Sentry, it's integrations and samples for every platform. However the repository contains various solution filters that will be more practical for day to day tasks.
 
 These solution filters get generated automatically by `/scripts/generate-solution-filters.ps1` so, although you can certainly create your own solution filters and manage these how you wish, don't try to modify any of the `*.slnf` files that are committed to source control. Instead, changes to these can be made by modifying `/scripts/generate-solution-filters-config.yml` and re-running the script that generates these.
 
+Also note that script generates a `.generated.NoMobile.sln` solution, which is an identical copy of `Sentry.sln`. Again, we don't recommend opening this directly. It exists as a round about way to conditionally set build properties in certain solution filters. You should instead use those solution filters (e.g. `SentryNoMobile.slnf`) when working in the Sentry codebase.
+
 ## API changes approval process
 
 This repository uses [Verify](https://github.com/VerifyTests/Verify) to store the public API diffs in snapshot files.

CONTRIBUTING.md

@@ -15,7 +15,7 @@
     <NoWarn>$(NoWarn);CS8002</NoWarn>
   </PropertyGroup>
 
-  <PropertyGroup Condition="'$(SolutionName)' == 'Sentry.NoMobile'">
+  <PropertyGroup Condition="'$(SolutionName)' == '.generated.NoMobile'">
     <NO_MOBILE>true</NO_MOBILE>
   </PropertyGroup>
 

Directory.Build.props

@@ -1,6 +1,6 @@
 {
   "solution": {
-    "path": "Sentry.NoMobile.sln",
+    "path": ".generated.NoMobile.sln",
     "projects": [
       "samples\\Sentry.Samples.AspNetCore.Basic\\Sentry.Samples.AspNetCore.Basic.csproj",
       "samples\\Sentry.Samples.AspNetCore.Blazor.Server\\Sentry.Samples.AspNetCore.Blazor.Server.csproj",

SentryAspNetCore.slnf

@@ -1,6 +1,6 @@
 {
   "solution": {
-    "path": "Sentry.NoMobile.sln",
+    "path": ".generated.NoMobile.sln",
     "projects": [
       "benchmarks\\Sentry.Benchmarks\\Sentry.Benchmarks.csproj",
       "samples\\Sentry.Samples.Console.Basic\\Sentry.Samples.Console.Basic.csproj",

SentryCore.slnf

@@ -1,6 +1,6 @@
 {
   "solution": {
-    "path": "Sentry.NoMobile.sln",
+    "path": ".generated.NoMobile.sln",
     "projects": [
       "src\\Sentry.DiagnosticSource\\Sentry.DiagnosticSource.csproj",
       "src\\Sentry.Extensions.Logging\\Sentry.Extensions.Logging.csproj",

SentryDiagnosticSource.slnf

@@ -1,6 +1,6 @@
 {
   "solution": {
-    "path": "Sentry.NoMobile.sln",
+    "path": ".generated.NoMobile.sln",
     "projects": [
       "benchmarks\\Sentry.Benchmarks\\Sentry.Benchmarks.csproj",
       "samples\\Sentry.Samples.AspNetCore.Basic\\Sentry.Samples.AspNetCore.Basic.csproj",

SentryNoMobile.slnf

@@ -8,7 +8,7 @@ coreSolution: Sentry.sln
 # copies of Sentry.sln that are used to set certain build
 # properties when using solution filters that are based on these
 buildSolutions:
-  - Sentry.NoMobile.sln
+  - .generated.NoMobile.sln
 
 groupConfigs:
   allProjects:
@@ -83,7 +83,7 @@ filterConfigs:
         - "test/**/*.csproj"
 
   - outputPath: SentryAspNetCore.slnf
-    solution: Sentry.NoMobile.sln
+    solution: .generated.NoMobile.sln
     include:
       patterns:
         - "**/*AspNetCore*.csproj"
@@ -109,7 +109,7 @@ filterConfigs:
         - "**/Sentry.Tests.csproj"
 
   - outputPath: SentryCore.slnf
-    solution: Sentry.NoMobile.sln
+    solution: .generated.NoMobile.sln
     include:
       patterns:
         - "**/Sentry.Benchmarks.csproj"
@@ -123,7 +123,7 @@ filterConfigs:
         - "**/Sentry.Tests.csproj"
 
   - outputPath: SentryDiagnosticSource.slnf
-    solution: Sentry.NoMobile.sln
+    solution: .generated.NoMobile.sln
     include:
       patterns:
         - "**/*DiagnosticSource*.csproj"
@@ -155,7 +155,7 @@ filterConfigs:
         - "test/MauiTestUtils/**/*.csproj"
 
   - outputPath: SentryNoMobile.slnf
-    solution: Sentry.NoMobile.sln
+    solution: .generated.NoMobile.sln
     include:
       groups:
         - "allProjects"