SqlSetup: Updated the documentation (#1589)

- SqlSetup - Updated the documentation with the currently supported features (issue #1566).
dsccommunity · Jul 9, 2020 · ea4c64e · ea4c64e
1 parent 359104f
commit ea4c64e
Show file tree

Hide file tree

Showing 2 changed files with 59 additions and 34 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -10,6 +10,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - SqlServerDsc
   - Updated comment-based help according to style guideline throughout
     ([issue #1500](https://github.com/dsccommunity/SqlServerDsc/issues/1500)).
+- SqlSetup
+  - Updated the documentation with the currently supported features
+    ([issue #1566](https://github.com/dsccommunity/SqlServerDsc/issues/1566)).
 
 ## [14.1.0] - 2020-07-06
 

diff --git a/source/DSCResources/DSC_SqlSetup/README.md b/source/DSCResources/DSC_SqlSetup/README.md
@@ -4,52 +4,57 @@ The `SqlSetup` DSC resource installs SQL Server on the target node.
 
 ## Requirements
 
-* Target machine must be running Windows Server 2012 or later.
-* For configurations that utilize the 'InstallFailoverCluster' action, the following
+- Target machine must be running Windows Server 2012 or later.
+- For configurations that utilize the 'InstallFailoverCluster' action, the following
   parameters are required (beyond those required for the standalone installation).
   See the article [Install SQL Server from the Command Prompt](https://msdn.microsoft.com/en-us/library/ms144259.aspx)
   under the section [Failover Cluster Parameters](https://msdn.microsoft.com/en-us/library/ms144259.aspx#Anchor_8)
   for more information.
-  * InstanceName (can be MSSQLSERVER if you want to install a default clustered
+  - InstanceName (can be MSSQLSERVER if you want to install a default clustered
     instance).
-  * FailoverClusterNetworkName
-  * FailoverClusterIPAddress
-  * Additional parameters need when installing Database Engine.
-    * InstallSQLDataDir
-    * AgtSvcAccount
-    * SQLSvcAccount
-    * SQLSysAdminAccounts
-  * Additional parameters need when installing Analysis Services.
-    * ASSysAdminAccounts
-    * AsSvcAccount
-* The parameters below can only be used when installing SQL Server 2016 or
+  - FailoverClusterNetworkName
+  - FailoverClusterIPAddress
+  - Additional parameters need when installing Database Engine.
+    - InstallSQLDataDir
+    - AgtSvcAccount
+    - SQLSvcAccount
+    - SQLSysAdminAccounts
+  - Additional parameters need when installing Analysis Services.
+    - ASSysAdminAccounts
+    - AsSvcAccount
+- The parameters below can only be used when installing SQL Server 2016 or
   later:
-  * SqlTempdbFileCount
-  * SqlTempdbFileSize
-  * SqlTempdbFileGrowth
-  * SqlTempdbLogFileSize
-  * SqlTempdbLogFileGrowth
+  - SqlTempdbFileCount
+  - SqlTempdbFileSize
+  - SqlTempdbFileGrowth
+  - SqlTempdbLogFileSize
+  - SqlTempdbLogFileGrowth
 
 > **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).
 
-## Feature flags
-
-Feature flags are used to toggle functionality on or off. One or more
-feature flags can be added to the parameter `FeatureFlag`, i.e.
-`FeatureFlag = @('DetectionSharedFeatures')`.
-
->**NOTE:** The functionality, exposed
-with a feature flag, can be changed from one release to another, including
-having breaking changes.
-
-<!-- markdownlint-disable MD013 -->
-Flag | Description
---- | ---
-\- | -
-<!-- markdownlint-enable MD013 -->
+## Features supported
+
+This is a list of currently supported features. All features might not be
+available on all versions of _SQL Server_.
+
+- SQLENGINE
+- REPLICATION
+- DQ
+- DQC
+- BOL
+- CONN
+- BC
+- SDK
+- MDS
+- FULLTEXT
+- RS
+- AS
+- IS
+- SSMS
+- ADV_SSMS
 
 ## Skip rules
 
@@ -114,6 +119,23 @@ name of the temporary folder. If the path, that is assigned to parameter
 `SourcePath`, does not have a leaf folder, for example '\\server\share', then
 a unique GUID will be used as the name of the temporary folder.
 
+## Feature flags
+
+_Not to be mistaken with the **Features** parameter._
+
+Feature flags are used to toggle resource functionality on or off. One or
+more feature flags can be added to the parameter `FeatureFlag`, i.e.
+`FeatureFlag = @('DetectionSharedFeatures')`.
+
+>**NOTE:** The functionality, exposed with a feature flag, can be changed
+>from one release to another, including having breaking changes.
+
+<!-- markdownlint-disable MD013 -->
+Flag | Description
+--- | ---
+\- | -
+<!-- markdownlint-enable MD013 -->
+
 ## Known issues
 
 All issues are not listed here, see [here for all open issues](https://github.com/dsccommunity/SqlServerDsc/issues?q=is%3Aissue+is%3Aopen+in%3Atitle+SqlSetup).