Skip to content

Commit

Permalink
Fix markdown highlights (#1978)
Browse files Browse the repository at this point in the history
- SqlServerDsc
  - Update markdown highlights with newly supported keywords.
  • Loading branch information
johlju authored Nov 19, 2023
1 parent 85f8523 commit e9639fd
Show file tree
Hide file tree
Showing 13 changed files with 20 additions and 15 deletions.
1 change: 1 addition & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

- SqlServerDsc
- Bump PSResourceGet to v1.0.0 (used when resolving dependencies).
- Update markdown highlights with newly supported keywords.

## [16.5.0] - 2023-10-05

Expand Down
2 changes: 1 addition & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -347,7 +347,7 @@ 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]
> [!IMPORTANT]
> Below output assumes `$ErrorView` is set to `'NormalView'` in the
> PowerShell session.
Expand Down
2 changes: 1 addition & 1 deletion source/Classes/020.SqlDatabasePermission.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
permissions for a user in a database. For more information about permissions,
please read the article [Permissions (Database Engine)](https://docs.microsoft.com/en-us/sql/relational-databases/security/permissions-database-engine).
> [!NOTE]
> [!CAUTION]
> When revoking permission with PermissionState 'GrantWithGrant', both the
> grantee and _all the other users the grantee has granted the same permission_
> _to_, will also get their permission revoked.
Expand Down
2 changes: 1 addition & 1 deletion source/Classes/020.SqlPermission.ps1
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
Server permissions for a login. For more information about permissions,
please read the article [Permissions (Database Engine)](https://docs.microsoft.com/en-us/sql/relational-databases/security/permissions-database-engine).
> [!NOTE]
> [!CAUTION]
> When revoking permission with PermissionState 'GrantWithGrant', both the
> grantee and _all the other users the grantee has granted the same permission_
> _to_, will also get their permission revoked.
Expand Down
2 changes: 1 addition & 1 deletion source/DSCResources/DSC_SqlDatabaseMail/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The `SqlDatabaseMail` DSC resource manages SQL Server Database Mail.

> [!NOTE]
> [!TIP]
> Database Mail XPs can be enabled using the resource `SqlConfiguration`.
## Requirements
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ of database objects in a database for a SQL Server instance.
For more information about permission names that can be managed, see the
property names of the [ObjectPermissionSet](https://docs.microsoft.com/en-us/dotnet/api/microsoft.sqlserver.management.smo.objectpermissionset#properties) class.

> [!NOTE]
> [!CAUTION]
> When revoking permission with PermissionState 'GrantWithGrant', both the
> grantee and _all the other users the grantee has granted the same permission to_,
> will also get their permission revoked.
Expand Down
4 changes: 3 additions & 1 deletion source/DSCResources/DSC_SqlEndpoint/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@ The `SqlEndpoint` DSC resource is used to create an endpoint. Currently
it only supports creating a database mirror and a service broker endpoint. A database mirror
endpoint can be used by AlwaysOn.

> [!NOTE]
> [!IMPORTANT]
> The endpoint will be started after creation, but will not be enforced
> unless the the parameter `State` is specified.
>
> [!TIP]
> To set connect permission to the endpoint, please use
> the resource [**SqlEndpointPermission**](#sqlendpointpermission).
Expand Down
2 changes: 1 addition & 1 deletion source/DSCResources/DSC_SqlRSSetup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ used, then the installation will run as SYSTEM.
is successful (because the executable returns exit code 0) but the
Microsoft SQL Server Reporting Services instance was not actually removed.

> [!NOTE]
> [!IMPORTANT]
> When using the action 'Uninstall' and the target node to begin with
> requires a restart, on the first run the Microsoft SQL Server Reporting
> Services instance will not be uninstalled, but instead exits with code
Expand Down
2 changes: 1 addition & 1 deletion source/DSCResources/DSC_SqlSecureConnection/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The `SqlSecureConnection` DSC resource configures SQL connections
to be encrypted. Read more about encrypted connections in this article
[Enable Encrypted Connections](https://docs.microsoft.com/en-us/sql/database-engine/configure-windows/enable-encrypted-connections-to-the-database-engine).

> [!NOTE]
> [!IMPORTANT]
> The 'LocalSystem' service account will return a connection
> error, even though the connection has been successful. In that case,
> the 'SYSTEM' service account can be used.
Expand Down
2 changes: 1 addition & 1 deletion source/DSCResources/DSC_SqlSetup/DSC_SqlSetup.schema.mof
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
[ClassVersion("1.0.0.0"), FriendlyName("SqlSetup")]
class DSC_SqlSetup : OMI_BaseResource
{
[Write, Description("The action to be performed. Default value is `'Install'`. <br />> [!NOTE] **AddNode is not currently functional.**"), ValueMap{"Install","Upgrade","InstallFailoverCluster","AddNode","PrepareFailoverCluster","CompleteFailoverCluster"}, Values{"Install","Upgrade","InstallFailoverCluster","AddNode","PrepareFailoverCluster","CompleteFailoverCluster"}] String Action;
[Write, Description("The action to be performed. Default value is `'Install'`."), ValueMap{"Install","Upgrade","InstallFailoverCluster","AddNode","PrepareFailoverCluster","CompleteFailoverCluster"}, Values{"Install","Upgrade","InstallFailoverCluster","AddNode","PrepareFailoverCluster","CompleteFailoverCluster"}] String Action;
[Required, Description("The path to the root of the source files for installation. I.e and UNC path to a shared resource. Environment variables can be used in the path.")] String SourcePath;
[Write, EmbeddedInstance("MSFT_Credential"), Description("Credentials used to access the path set in the parameter **SourcePath**. See section [Considerations](#considerations) regarding the parameter **SourceCredential**.")] String SourceCredential;
[Write, Description("Suppresses reboot.")] Boolean SuppressReboot;
Expand Down
6 changes: 4 additions & 2 deletions source/DSCResources/DSC_SqlSetup/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ available on all versions of _SQL Server_.
- SSMS
- ADV_SSMS

> [!NOTE]
> [!IMPORTANT]
> 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
Expand Down Expand Up @@ -142,7 +142,7 @@ 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]
> [!CAUTION]
> The functionality, exposed with a feature flag, can be changed
> from one release to another, including having breaking changes.
Expand All @@ -156,3 +156,5 @@ AnalysisServicesConnection | A new method of loading the assembly *Microsoft.Ana
## 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).

> [!IMPORTANT] The setup action AddNode is not currently functional.
6 changes: 3 additions & 3 deletions source/Examples/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -140,7 +140,7 @@ changed to match your configuration. Also, please see other resource examples in
[xFailOverCluster](https://github.com/PowerShell/xFailOverCluster) to see if
they could improve you configuration, for example the resource xClusterQuorum.

> [!NOTE]
> [!IMPORTANT]
> Make sure any user accounts you use in the configuration exist in
> Active Directory and that they have the correct permission.
Expand All @@ -151,7 +151,7 @@ The example shows how to
And this example shows how to
[install the second SQL Server Failover Cluster node for a named instance](https://github.com/PowerShell/SqlServerDsc/blob/dev/Examples/Resources/SqlSetup/5-InstallNamedInstanceInFailoverClusterSecondNode.ps1).

> [!NOTE]
> [!IMPORTANT]
> Make sure any user accounts you use in the configuration exist in
> Active Directory and that they have the correct permission.
Expand Down Expand Up @@ -205,6 +205,6 @@ Once AlwaysOn is enabled we can create the Availability Group. The example [Crea
shows how to create the Availability Group on the primary replica and join the
Availability Group on the secondary replica.

> [!NOTE]
> [!IMPORTANT]
> Make sure any user accounts you use in the configuration exist in
> Active Directory and that they have the correct permission.
2 changes: 1 addition & 1 deletion source/WikiSource/Home.md
Original file line number Diff line number Diff line change
Expand Up @@ -84,7 +84,7 @@ machine-wide, or at minimum set for each user that runs DSC resources, on
the target node. Make sure you comply with any license terms that is part
of dbatools.

> [!NOTE]
> [!TIP]
> It is also possible to use any module as a preferred module if
> its name is set as the value of the environment variable `SMODefaultModuleName`.
Expand Down

0 comments on commit e9639fd

Please sign in to comment.