Fix note comment in markdown (#1955)

dsccommunity · Aug 7, 2023 · 0dda9c3 · 0dda9c3
1 parent 7260dfa
commit 0dda9c3
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 7 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -21,7 +21,11 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - Bumped dbatools to v2.0.1 for the integration tests.
   - Running PSScriptAnalyzer on the built module ([issue #1945](https://github.com/dsccommunity/SqlServerDsc/issues/1945)).
   - Fix header in unit tests that referenced the wrong path.
-  - Fix a path in VS Code workspace settings to correctly use Script Analyzer on Linux and macOS.
+  - Fix a path in VS Code workspace settings to correctly use Script Analyzer on
+    Linux and macOS.
+  - Updating a note comment in the CONTRIBUTING.md.
+- SqlSetup
+  - Updating a note comment in the README.md.
 
 ### Fixed
 

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -347,8 +347,9 @@ not be used, neither shall the command `Write-Error` with the parameter
 to throw a terminating error. The exception is when a `[ValidateScript()]`
 has to throw an error, then `throw` must be used.
 
->**NOTE:** Below output assumes `$ErrorView` is set to `'NormalView'` in the
->PowerShell session.
+> [!NOTE]
+> Below output assumes `$ErrorView` is set to `'NormalView'` in the
+> PowerShell session.
 
 When using `throw` it will fail on the line with the throw statement
 making it look like it is that statement inside the function that failed,

diff --git a/source/DSCResources/DSC_SqlSetup/README.md b/source/DSCResources/DSC_SqlSetup/README.md
@@ -65,10 +65,11 @@ available on all versions of _SQL Server_.
 - SSMS
 - ADV_SSMS
 
-> **Note:** It is not possible to add or remove features to a SQL Server failover
->cluster. This is a limitation of SQL Server. See article
->[You cannot add or remove features to a SQL Server 2008, SQL Server 2008 R2, or
->SQL Server 2012 failover cluster](https://support.microsoft.com/en-us/help/2547273/you-cannot-add-or-remove-features-to-a-sql-server-2008,-sql-server-2008-r2,-or-sql-server-2012-failover-cluster).
+> [!NOTE]
+> It is not possible to add or remove features to a SQL Server failover
+> cluster. This is a limitation of SQL Server. See article
+> [You cannot add or remove features to a SQL Server 2008, SQL Server 2008 R2, or
+> SQL Server 2012 failover cluster](https://support.microsoft.com/en-us/help/2547273/you-cannot-add-or-remove-features-to-a-sql-server-2008,-sql-server-2008-r2,-or-sql-server-2012-failover-cluster).
 
 ## Skip rules