[DSI-8009] Create for .NET Prototype for the Help Pages

.editorconfig

@@ -17,6 +17,9 @@ indent_size = 2
 indent_style = space
 tab_width = 2
 
+[*.{yml}]
+trim_trailing_whitespace = false
+
 [*.cs]
 # Here we set all microsoft's IDExxxx rule violations as compile errors
 # https://learn.microsoft.com/en-us/dotnet/fundamentals/code-analysis/style-rules/

.github/workflows/dotnet-checks.yml

@@ -65,8 +65,18 @@ jobs:
             /k:"DFE-Digital_dsi-platform" `
             /d:sonar.host.url="https://sonarcloud.io" `
             /d:sonar.token="$env:SONAR_TOKEN" `
+            /d:sonar.coverage.exclusions="**/Program.cs,**/*Options.cs,**/*Constants.cs,**/*.cshtml,**/*.js,Fake**" `
             /d:sonar.coverageReportPaths="CoverageReport/SonarQube.xml" `
-            /d:sonar.cs.vstest.reportsPaths="**/*.trx"
+            /d:sonar.cs.vstest.reportsPaths="**/*.trx" `
+            /d:sonar.issue.ignore.multicriteria=e1,e2,e3,e4 `
+            /d:sonar.issue.ignore.multicriteria.e1.ruleKey=csharpsquid:S2094 `
+            /d:sonar.issue.ignore.multicriteria.e1.resourceKey=**/*.cs `
+            /d:sonar.issue.ignore.multicriteria.e2.ruleKey=csharpsquid:S3267 `
+            /d:sonar.issue.ignore.multicriteria.e2.resourceKey=**/*.cs `
+            /d:sonar.issue.ignore.multicriteria.e3.ruleKey=csharpsquid:S3267 `
+            /d:sonar.issue.ignore.multicriteria.e3.resourceKey=**/*.cshtml `
+            /d:sonar.issue.ignore.multicriteria.e4.ruleKey=csharpsquid:S1066 `
+            /d:sonar.issue.ignore.multicriteria.e4.resourceKey=**/*.cs
 
       - name: Build project
         run: dotnet build ./build.sln --no-incremental

.vscode/settings.json

@@ -1,5 +1,9 @@
 {
   "editor.formatOnSave": true,
+  "[aspnetcorerazor]": {
+    "editor.formatOnSave": false,
+    "editor.formatOnType": false
+  },
   "files.associations": {
     "appsettings*.json": "jsonc",
     "*.tmpl*": "html",

Directory.Packages.props

@@ -35,6 +35,11 @@
     <PackageVersion Include="AutoMapper" Version="14.0.0" />
   </ItemGroup>
 
+  <!-- Communication -->
+  <ItemGroup>
+    <PackageVersion Include="GovukNotify" Version="7.2.0" />
+  </ItemGroup>
+
   <!-- Monitoring -->
   <ItemGroup>
     <PackageVersion Include="Azure.Monitor.OpenTelemetry.AspNetCore" Version="1.2.0" />
@@ -77,7 +82,7 @@
   <!-- Frontends -->
   <ItemGroup>
     <!-- GOV.UK design system -->
-    <PackageVersion Include="GovUk.Frontend.AspNetCore" Version="2.8.0" />
+    <PackageVersion Include="GovUk.Frontend.AspNetCore" Version="3.2.3" />
   </ItemGroup>
 
   <!-- Content -->

docs/templates/Dfe.SignIn.DocfxPlugin.Tests/snapshots/guide_getting-started.html.verified.txt

@@ -60,6 +60,20 @@
             </div><!-- .govuk-header__content -->
         </div>
     </header>
+
+    <div class="govuk-phase-banner">
+        <div class="govuk-width-container app-width-container">
+            <p class="govuk-phase-banner__content">
+                <strong class="govuk-tag govuk-phase-banner__content__tag">
+                    Beta
+                </strong>
+                <span class="govuk-phase-banner__text">
+                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
+                </span>
+            </p>
+        </div>
+    </div>
+
     <div class="govuk-service-navigation" data-module="govuk-service-navigation">
         <div class="govuk-width-container app-width-container">
             <div class="govuk-service-navigation__container">
@@ -73,17 +87,6 @@
         </div>
     </div>
     <div class="govuk-width-container app-width-container">
-        <div class="govuk-phase-banner">
-            <p class="govuk-phase-banner__content">
-                <strong class="govuk-tag govuk-phase-banner__content__tag">
-                    Beta
-                </strong>
-                <span class="govuk-phase-banner__text">
-                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
-                </span>
-            </p>
-        </div>
-
         <!--PLACEHOLDER:CRUMBS-->
 
         <!--PLACEHOLDER:CAPTION-->

docs/templates/Dfe.SignIn.DocfxPlugin.Tests/snapshots/guide_introduction.html.verified.txt

@@ -60,6 +60,20 @@
             </div><!-- .govuk-header__content -->
         </div>
     </header>
+
+    <div class="govuk-phase-banner">
+        <div class="govuk-width-container app-width-container">
+            <p class="govuk-phase-banner__content">
+                <strong class="govuk-tag govuk-phase-banner__content__tag">
+                    Beta
+                </strong>
+                <span class="govuk-phase-banner__text">
+                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
+                </span>
+            </p>
+        </div>
+    </div>
+
     <div class="govuk-service-navigation" data-module="govuk-service-navigation">
         <div class="govuk-width-container app-width-container">
             <div class="govuk-service-navigation__container">
@@ -73,17 +87,6 @@
         </div>
     </div>
     <div class="govuk-width-container app-width-container">
-        <div class="govuk-phase-banner">
-            <p class="govuk-phase-banner__content">
-                <strong class="govuk-tag govuk-phase-banner__content__tag">
-                    Beta
-                </strong>
-                <span class="govuk-phase-banner__text">
-                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
-                </span>
-            </p>
-        </div>
-
         <!--PLACEHOLDER:CRUMBS-->
 
         <!--PLACEHOLDER:CAPTION-->

docs/templates/Dfe.SignIn.DocfxPlugin.Tests/snapshots/index.html.verified.txt

@@ -60,6 +60,20 @@
             </div><!-- .govuk-header__content -->
         </div>
     </header>
+
+    <div class="govuk-phase-banner">
+        <div class="govuk-width-container app-width-container">
+            <p class="govuk-phase-banner__content">
+                <strong class="govuk-tag govuk-phase-banner__content__tag">
+                    Beta
+                </strong>
+                <span class="govuk-phase-banner__text">
+                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
+                </span>
+            </p>
+        </div>
+    </div>
+
     <div class="govuk-service-navigation" data-module="govuk-service-navigation">
         <div class="govuk-width-container app-width-container">
             <div class="govuk-service-navigation__container">
@@ -73,17 +87,6 @@
         </div>
     </div>
     <div class="govuk-width-container app-width-container">
-        <div class="govuk-phase-banner">
-            <p class="govuk-phase-banner__content">
-                <strong class="govuk-tag govuk-phase-banner__content__tag">
-                    Beta
-                </strong>
-                <span class="govuk-phase-banner__text">
-                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
-                </span>
-            </p>
-        </div>
-
         <!--PLACEHOLDER:CRUMBS-->
 
         <!--PLACEHOLDER:CAPTION-->

docs/templates/Dfe.SignIn.DocfxPlugin.Tests/snapshots/reference_Dfe.SignIn.DocfxSample.ExampleClass.AddNumbers.html.verified.txt

@@ -62,6 +62,20 @@
             </div><!-- .govuk-header__content -->
         </div>
     </header>
+
+    <div class="govuk-phase-banner">
+        <div class="govuk-width-container app-width-container">
+            <p class="govuk-phase-banner__content">
+                <strong class="govuk-tag govuk-phase-banner__content__tag">
+                    Beta
+                </strong>
+                <span class="govuk-phase-banner__text">
+                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
+                </span>
+            </p>
+        </div>
+    </div>
+
     <div class="govuk-service-navigation" data-module="govuk-service-navigation">
         <div class="govuk-width-container app-width-container">
             <div class="govuk-service-navigation__container">
@@ -75,17 +89,6 @@
         </div>
     </div>
     <div class="govuk-width-container app-width-container">
-        <div class="govuk-phase-banner">
-            <p class="govuk-phase-banner__content">
-                <strong class="govuk-tag govuk-phase-banner__content__tag">
-                    Beta
-                </strong>
-                <span class="govuk-phase-banner__text">
-                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
-                </span>
-            </p>
-        </div>
-
         <nav class="govuk-breadcrumbs" aria-label="Breadcrumb"><ol class="govuk-breadcrumbs__list"><li class="govuk-breadcrumbs__list-item"><a class="govuk-breadcrumbs__link" href="../reference/Dfe.SignIn.DocfxSample.html">Dfe.&#8203;SignIn.&#8203;DocfxSample</a></li><li class="govuk-breadcrumbs__list-item"><a class="govuk-breadcrumbs__link" href="../reference/Dfe.SignIn.DocfxSample.ExampleClass.html">ExampleClass</a></li></ol></nav>
 
         <div class="app-page-caption" aria-hidden="true">Class ExampleClass</div>

docs/templates/Dfe.SignIn.DocfxPlugin.Tests/snapshots/reference_Dfe.SignIn.DocfxSample.ExampleClass.html.verified.txt

@@ -62,6 +62,20 @@
             </div><!-- .govuk-header__content -->
         </div>
     </header>
+
+    <div class="govuk-phase-banner">
+        <div class="govuk-width-container app-width-container">
+            <p class="govuk-phase-banner__content">
+                <strong class="govuk-tag govuk-phase-banner__content__tag">
+                    Beta
+                </strong>
+                <span class="govuk-phase-banner__text">
+                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
+                </span>
+            </p>
+        </div>
+    </div>
+
     <div class="govuk-service-navigation" data-module="govuk-service-navigation">
         <div class="govuk-width-container app-width-container">
             <div class="govuk-service-navigation__container">
@@ -75,17 +89,6 @@
         </div>
     </div>
     <div class="govuk-width-container app-width-container">
-        <div class="govuk-phase-banner">
-            <p class="govuk-phase-banner__content">
-                <strong class="govuk-tag govuk-phase-banner__content__tag">
-                    Beta
-                </strong>
-                <span class="govuk-phase-banner__text">
-                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
-                </span>
-            </p>
-        </div>
-
         <nav class="govuk-breadcrumbs" aria-label="Breadcrumb"><ol class="govuk-breadcrumbs__list"><li class="govuk-breadcrumbs__list-item"><a class="govuk-breadcrumbs__link" href="../reference/Dfe.SignIn.DocfxSample.html">Dfe.&#8203;SignIn.&#8203;DocfxSample</a></li></ol></nav>
 
         <div class="app-page-caption" aria-hidden="true">Namespace Dfe.&#8203;SignIn.&#8203;DocfxSample</div>

docs/templates/Dfe.SignIn.DocfxPlugin.Tests/snapshots/reference_Dfe.SignIn.DocfxSample.SomeNamespace.AnotherClass.AddNumbers.html.verified.txt

@@ -62,6 +62,20 @@
             </div><!-- .govuk-header__content -->
         </div>
     </header>
+
+    <div class="govuk-phase-banner">
+        <div class="govuk-width-container app-width-container">
+            <p class="govuk-phase-banner__content">
+                <strong class="govuk-tag govuk-phase-banner__content__tag">
+                    Beta
+                </strong>
+                <span class="govuk-phase-banner__text">
+                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
+                </span>
+            </p>
+        </div>
+    </div>
+
     <div class="govuk-service-navigation" data-module="govuk-service-navigation">
         <div class="govuk-width-container app-width-container">
             <div class="govuk-service-navigation__container">
@@ -75,17 +89,6 @@
         </div>
     </div>
     <div class="govuk-width-container app-width-container">
-        <div class="govuk-phase-banner">
-            <p class="govuk-phase-banner__content">
-                <strong class="govuk-tag govuk-phase-banner__content__tag">
-                    Beta
-                </strong>
-                <span class="govuk-phase-banner__text">
-                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
-                </span>
-            </p>
-        </div>
-
         <nav class="govuk-breadcrumbs" aria-label="Breadcrumb"><ol class="govuk-breadcrumbs__list"><li class="govuk-breadcrumbs__list-item"><a class="govuk-breadcrumbs__link" href="../reference/Dfe.SignIn.DocfxSample.html">Dfe.&#8203;SignIn.&#8203;DocfxSample</a></li><li class="govuk-breadcrumbs__list-item"><a class="govuk-breadcrumbs__link" href="../reference/Dfe.SignIn.DocfxSample.SomeNamespace.html">SomeNamespace</a></li><li class="govuk-breadcrumbs__list-item"><a class="govuk-breadcrumbs__link" href="../reference/Dfe.SignIn.DocfxSample.SomeNamespace.AnotherClass.html">AnotherClass</a></li></ol></nav>
 
         <div class="app-page-caption" aria-hidden="true">Class AnotherClass</div>

docs/templates/Dfe.SignIn.DocfxPlugin.Tests/snapshots/reference_Dfe.SignIn.DocfxSample.SomeNamespace.AnotherClass.html.verified.txt

@@ -62,6 +62,20 @@
             </div><!-- .govuk-header__content -->
         </div>
     </header>
+
+    <div class="govuk-phase-banner">
+        <div class="govuk-width-container app-width-container">
+            <p class="govuk-phase-banner__content">
+                <strong class="govuk-tag govuk-phase-banner__content__tag">
+                    Beta
+                </strong>
+                <span class="govuk-phase-banner__text">
+                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
+                </span>
+            </p>
+        </div>
+    </div>
+
     <div class="govuk-service-navigation" data-module="govuk-service-navigation">
         <div class="govuk-width-container app-width-container">
             <div class="govuk-service-navigation__container">
@@ -75,17 +89,6 @@
         </div>
     </div>
     <div class="govuk-width-container app-width-container">
-        <div class="govuk-phase-banner">
-            <p class="govuk-phase-banner__content">
-                <strong class="govuk-tag govuk-phase-banner__content__tag">
-                    Beta
-                </strong>
-                <span class="govuk-phase-banner__text">
-                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
-                </span>
-            </p>
-        </div>
-
         <nav class="govuk-breadcrumbs" aria-label="Breadcrumb"><ol class="govuk-breadcrumbs__list"><li class="govuk-breadcrumbs__list-item"><a class="govuk-breadcrumbs__link" href="../reference/Dfe.SignIn.DocfxSample.html">Dfe.&#8203;SignIn.&#8203;DocfxSample</a></li><li class="govuk-breadcrumbs__list-item"><a class="govuk-breadcrumbs__link" href="../reference/Dfe.SignIn.DocfxSample.SomeNamespace.html">SomeNamespace</a></li></ol></nav>
 
         <div class="app-page-caption" aria-hidden="true">Namespace SomeNamespace</div>

docs/templates/Dfe.SignIn.DocfxPlugin.Tests/snapshots/reference_Dfe.SignIn.DocfxSample.SomeNamespace.ISomeService.Invoke.html.verified.txt

@@ -62,6 +62,20 @@
             </div><!-- .govuk-header__content -->
         </div>
     </header>
+
+    <div class="govuk-phase-banner">
+        <div class="govuk-width-container app-width-container">
+            <p class="govuk-phase-banner__content">
+                <strong class="govuk-tag govuk-phase-banner__content__tag">
+                    Beta
+                </strong>
+                <span class="govuk-phase-banner__text">
+                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
+                </span>
+            </p>
+        </div>
+    </div>
+
     <div class="govuk-service-navigation" data-module="govuk-service-navigation">
         <div class="govuk-width-container app-width-container">
             <div class="govuk-service-navigation__container">
@@ -75,17 +89,6 @@
         </div>
     </div>
     <div class="govuk-width-container app-width-container">
-        <div class="govuk-phase-banner">
-            <p class="govuk-phase-banner__content">
-                <strong class="govuk-tag govuk-phase-banner__content__tag">
-                    Beta
-                </strong>
-                <span class="govuk-phase-banner__text">
-                    This is a new service – your <a class="govuk-link" href="#" target="_blank">feedback</a> will help us to improve it.
-                </span>
-            </p>
-        </div>
-
         <nav class="govuk-breadcrumbs" aria-label="Breadcrumb"><ol class="govuk-breadcrumbs__list"><li class="govuk-breadcrumbs__list-item"><a class="govuk-breadcrumbs__link" href="../reference/Dfe.SignIn.DocfxSample.html">Dfe.&#8203;SignIn.&#8203;DocfxSample</a></li><li class="govuk-breadcrumbs__list-item"><a class="govuk-breadcrumbs__link" href="../reference/Dfe.SignIn.DocfxSample.SomeNamespace.html">SomeNamespace</a></li><li class="govuk-breadcrumbs__list-item"><a class="govuk-breadcrumbs__link" href="../reference/Dfe.SignIn.DocfxSample.SomeNamespace.ISomeService.html">ISomeService</a></li></ol></nav>
 
         <div class="app-page-caption" aria-hidden="true">Interface ISomeService</div>