Fixes to the documentation templates, better layout with H1 and meta …

…description.

dqops/src/main/java/com/dqops/rules/averages/BetweenPercentMovingAverage30DaysRule10ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/BetweenPercentMovingAverage30DaysRule20ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/BetweenPercentMovingAverage30DaysRule5ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/BetweenPercentMovingAverage60DaysRule10ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/BetweenPercentMovingAverage60DaysRule20ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/BetweenPercentMovingAverage60DaysRule5ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/BetweenPercentMovingAverage7DaysRule10ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/BetweenPercentMovingAverage7DaysRule20ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/BetweenPercentMovingAverage7DaysRule5ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/PercentMovingAverageRuleParametersSpec.java

@@ -28,7 +28,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/WithinPercentMovingAverage30DaysRule10ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/WithinPercentMovingAverage30DaysRule20ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/WithinPercentMovingAverage30DaysRule5ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/WithinPercentMovingAverage60DaysRule10ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/WithinPercentMovingAverage60DaysRule20ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/WithinPercentMovingAverage60DaysRule5ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/WithinPercentMovingAverage7DaysRule10ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/WithinPercentMovingAverage7DaysRule20ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/averages/WithinPercentMovingAverage7DaysRule5ParametersSpec.java

@@ -27,7 +27,7 @@
 import java.util.Objects;
 
 /**
- * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average of a time window.
+ * Data quality rule that verifies if a data quality sensor readout value is not above X percent of the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/stdev/MultiplyMovingStdev30DaysRuleParametersSpec.java

@@ -29,7 +29,7 @@
 
 /**
  * Data quality rule that verifies if a data quality sensor readout value
- * doesn't excessively deviate from the moving average of a time window.
+ * doesn't excessively deviate from the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/stdev/MultiplyMovingStdev60DaysRuleParametersSpec.java

@@ -29,7 +29,7 @@
 
 /**
  * Data quality rule that verifies if a data quality sensor readout value
- * doesn't excessively deviate from the moving average of a time window.
+ * doesn't excessively deviate from the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/stdev/MultiplyMovingStdev7DaysRuleParametersSpec.java

@@ -29,7 +29,7 @@
 
 /**
  * Data quality rule that verifies if a data quality sensor readout value
- * doesn't excessively deviate from the moving average of a time window.
+ * doesn't excessively deviate from the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/stdev/MultiplyMovingStdevWithin30DaysRuleParametersSpec.java

@@ -29,7 +29,7 @@
 
 /**
  * Data quality rule that verifies if a data quality sensor readout value
- * doesn't excessively deviate from the moving average of a time window.
+ * doesn't excessively deviate from the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/stdev/MultiplyMovingStdevWithin60DaysRuleParametersSpec.java

@@ -29,7 +29,7 @@
 
 /**
  * Data quality rule that verifies if a data quality sensor readout value
- * doesn't excessively deviate from the moving average of a time window.
+ * doesn't excessively deviate from the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/rules/stdev/MultiplyMovingStdevWithin7DaysRuleParametersSpec.java

@@ -29,7 +29,7 @@
 
 /**
  * Data quality rule that verifies if a data quality sensor readout value
- * doesn't excessively deviate from the moving average of a time window.
+ * doesn't excessively deviate from the moving average within a time window.
  */
 @JsonInclude(JsonInclude.Include.NON_NULL)
 @JsonNaming(PropertyNamingStrategies.SnakeCaseStrategy.class)

dqops/src/main/java/com/dqops/utils/docs/checks/check_documentation.hbs

@@ -1,21 +1,29 @@
-**{{replace primaryCheckName "_" " "}}** checks
+# {{replace primaryCheckName "_" " "}} data quality checks
 {{#if checkSpecClassJavaDoc}}
-**Description**
 {{checkSpecClassJavaDoc}}
 {{else}}
 {{/if}}
+
 ___
+The **{{replace primaryCheckName "_" " "}}** data quality check has the following variants for each
+[type of data quality](/docs/dqo-concepts/checks/index.md#types-of-checks) checks supported by DQOps.
+
 {{#each allChecks}}
-## **{{replace checkName  "_" " "}}**
+## {{replace checkName  "_" " "}}
 
 
 **Check description**
+
 {{checkHelp}}
 
 |Check name|Check type|Time scale|Quality dimension|Sensor definition|Quality rule|
 |----------|----------|----------|-----------------|-----------------|------------|
 |{{checkName}}|{{checkType}}|{{#if timeScale}}{{timeScale}}{{else}} {{/if}}|{{qualityDimension}}|[{{sensor.sensorName}}](../../../reference/sensors/{{target}}/{{sensor.category}}-{{target}}-sensors.md#{{replace sensor.sensorName "_" "-"}})|[{{rule.ruleName}}](../../../reference/rules/{{capitalizeFirst rule.category}}.md#{{replace rule.ruleName "_" "-"}})|
 
+**Command-line examples**
+
+Please expand the section below to see the DQOps command-line examples to run or activate the {{replace checkName  "_" " "}} data quality check.
+
 ??? example "Managing {{replace checkName  "_" " "}} check from DQOps shell"
 
     === "Activate check"
@@ -42,7 +50,8 @@ ___
         dqo> check run -c=connection_name -t=schema_name.table_name -ch={{checkName}}
         ```
 
-**Sample configuration (YAML)**
+**YAML configuration**
+
 The sample *schema_name.table_name.dqotable.yaml* file with the check configured is shown below.
 
 
@@ -115,24 +124,31 @@ Expand the *Configure with data grouping* section to see additional examples for
 {{/if}}
 {{#if runOnConnectionCliCommand}}
 **CLI command to run check on connection**
+
 ```
 {{runOnConnectionCliCommand}}
 ```
+
 {{else}}
 {{/if}}
 {{#if runOnTableCliCommand}}
 **CLI command to run check on table**
+
 ```
 {{runOnTableCliCommand}}
 ```
+
 {{else}}
 {{/if}}
 {{#if runOnColumnCliCommand}}
 **CLI command to run check on column**
+
 ```
 {{runOnColumnCliCommand}}
 ```
+
 {{else}}
 {{/if}}
 ___
-{{/each}}
+
+{{/each}}

dqops/src/main/java/com/dqops/utils/docs/checks/main_page_documentation.hbs

@@ -1,6 +1,6 @@
 # {{header}}
 
-**{{helpText}}**
+{{helpText}}
 
 {{#each checkTargets}}
 {{#if (gt checkTargets.length 1)}}## {{capitalizeFirst this}} checks{{/if}}
@@ -13,8 +13,10 @@
 |------------|------------|-------------|-------|
 {{#each allChecks}}|[{{checkName}}](/docs/checks/{{target}}/{{categoryName}}/{{replace primaryCheckName " " "-"}}.md#{{replace checkName "_" "-"}})|{{checkType}}|{{checkHelp}}|{{checkClass}}|
 {{/each}}
+
 {{/each}}
 {{else}}
 {{/if}}
 {{/each}}
+
 {{/each}}

dqops/src/main/java/com/dqops/utils/docs/cli/CliCommandDocumentationGeneratorImpl.java

@@ -90,6 +90,8 @@ public List<CliRootCommandDocumentationModel> createCommandModels() {
         for (Map.Entry<String, CommandLine> subcommand : firstLevelCommands.entrySet()) {
             CliRootCommandDocumentationModel rootCommandModel = new CliRootCommandDocumentationModel();
             rootCommandModel.setRootCommandName(subcommand.getKey());
+            rootCommandModel.setRootCommandHeader(extractRootCommandHeader(subcommand.getValue()));
+            rootCommandModel.setRootCommandDescription(extractRootCommandDescription(subcommand.getValue()));
             rootCommands.add(rootCommandModel);
 
             collectSubCommands(rootCommandModel, subcommand.getValue());
@@ -98,6 +100,40 @@ public List<CliRootCommandDocumentationModel> createCommandModels() {
         return rootCommands;
     }
 
+    /**
+     * Retrieves the header from the root command.
+     * @param commandLine Command line.
+     * @return Command header.
+     */
+    public String extractRootCommandHeader(CommandLine commandLine) {
+        CommandLine.Model.CommandSpec commandSpec = commandLine.getCommandSpec();
+
+        CommandLine.Model.UsageMessageSpec usageMessageSpec = commandSpec.usageMessage();
+        String[] header = usageMessageSpec.header();
+        if (header == null) {
+            return null;
+        }
+
+        return String.join(" ", header);
+    }
+
+    /**
+     * Retrieves the description from the root command.
+     * @param commandLine Command line.
+     * @return Command description.
+     */
+    public String extractRootCommandDescription(CommandLine commandLine) {
+        CommandLine.Model.CommandSpec commandSpec = commandLine.getCommandSpec();
+
+        CommandLine.Model.UsageMessageSpec usageMessageSpec = commandSpec.usageMessage();
+        String[] description = usageMessageSpec.description();
+        if (description == null) {
+            return null;
+        }
+
+        return String.join(" ", description);
+    }
+
     /**
      * Create 'dqo' root command used for the documentation.
      * @return Root commands and their subcommands.

dqops/src/main/java/com/dqops/utils/docs/cli/CliRootCommandDocumentationModel.java

@@ -30,6 +30,16 @@ public class CliRootCommandDocumentationModel {
      */
     private String rootCommandName;
 
+    /**
+     * The header of the root command.
+     */
+    private String rootCommandHeader;
+
+    /**
+     * The description of the root command.
+     */
+    private String rootCommandDescription;
+
     /**
      * List of commands.
      */