Skip to content

Commit 538699a

Browse files
updated readme.md
fixed typos and minors things. replaced "checks" with "rules"
1 parent 450aa37 commit 538699a

1 file changed

Lines changed: 4 additions & 4 deletions

File tree

samples/manage/sql-assessment-api/README.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -11,15 +11,15 @@ Learn how to assess your SQL Server configuration for best practices in 2 simple
1111

1212
## config.json
1313

14-
This is the default set of checks shipped with SQL Assessment API. Feel free to open issues to have us fix or add checks. Also, we're happy to see your pull requests to this file.
14+
This is the default set of rules shipped with SQL Assessment API. Feel free to open issues to have us fix or add rules. Also, we're happy to see your pull requests to this file.
1515

1616
## DisablingBuiltInChecks_sample.json
1717

18-
Contains two parts. First shows how you can disable a specified check by its ID. The second disables all the checks with the "TraceFlag" tag.
18+
Contains two parts. First shows how you can disable a specified rule by its ID. The second disables all the rules with the "TraceFlag" tag.
1919

2020
## MakingCustomChecks_sample.json
2121

22-
Demonstrates how to make a custom rule set containing two checks. The sample contains two sections: `checks` and `probes`. `Checks` is for check (or rule) definitions. Usually, checks or rules are best practices or a company's internal policies that should be applied to SQL Server. Here's one of the checks from this sample with comments on each property:
22+
Demonstrates how to make a custom ruleset containing two checks. The sample contains two sections: `rules` and `probes`. `Rules` is for rule (sometimes refered to as check) definitions. Usually, rules are best practices or a company's internal policies that should be applied to SQL Server configuration. Here's one of the rules from this sample with comments on each property:
2323

2424
```
2525
{
@@ -45,7 +45,7 @@ Demonstrates how to make a custom rule set containing two checks. The sample con
4545
}
4646
```
4747

48-
`Probes` describe how and where get required data to perform a check. For this, you can use T-SQL queries as well as methods from assemblies. The probe below uses a T-SQL query.
48+
`Probes` describes how and where get required data to perform a check. For this, you can use T-SQL queries as well as methods from assemblies. The probe below uses a T-SQL query.
4949
```
5050
"probes":{
5151
"DatabaseConfiguration": [ //Probe name that is used to reference the probe from a check.

0 commit comments

Comments
 (0)