Title and description of descriptor and linter pages (#2183)

* build.py * Build * [MegaLinter] Apply linters fixes Co-authored-by: nvuillam <[email protected]>
oxsecurity · Dec 26, 2022 · 0d6e8fa · 0d6e8fa
1 parent d285e67
commit 0d6e8fa
Show file tree

Hide file tree

Showing 170 changed files with 752 additions and 0 deletions.
diff --git a/.automation/build.py b/.automation/build.py
@@ -767,7 +767,16 @@ def generate_documentation():
 def generate_descriptor_documentation(descriptor):
     descriptor_file = f"{descriptor.get('descriptor_id').lower()}.yml"
     descriptor_url = f"{URL_ROOT}/megalinter/descriptors/{descriptor_file}"
+    linter_names = [
+        linter.get("linter_name") for linter in descriptor.get("linters", [])
+    ]
+    logging.info(linter_names)
     descriptor_md = [
+        "---",
+        f"title: {descriptor.get('descriptor_id')} linters in MegaLinter",
+        f"description: {', '.join(linter_names)} are available to analyze "
+        f"{descriptor.get('descriptor_id')} files in MegaLinter",
+        "---",
         "<!-- markdownlint-disable MD003 MD020 MD033 MD041 -->",
         f"<!-- {'@'}generated by .automation/build.py, please do not update manually -->",
         f"<!-- Instead, update descriptor file at {descriptor_url} -->",
@@ -1001,6 +1010,12 @@ def process_type(linters_by_type, type1, type_label, linters_tables_md):
 
         # Build individual linter doc
         linter_doc_md = [
+            "---",
+            f"title: {linter.linter_name} configuration in MegaLinter",
+            f"description: How to use {linter.linter_name} (configure, "
+            "ignore files, ignore errors, help & version documentations)"
+            f" to analyze {linter.descriptor_id} files",
+            "---",
             "<!-- markdownlint-disable MD033 MD041 -->",
             f"<!-- {'@'}generated by .automation/build.py, please do not update manually -->",
         ]
@@ -2881,6 +2896,7 @@ def update_dependents_info():
     generate_linter_dockerfiles()
     generate_linter_test_classes()
     if UPDATE_DOC is True:
+        logging.info("Running documentation generators...")
         refresh_users_info()
         generate_documentation()
         generate_documentation_all_linters()

diff --git a/.automation/generated/flavors-stats.json b/.automation/generated/flavors-stats.json
@@ -1155,6 +1155,10 @@
         [
             "2022-12-24T20:01:35",
             2714076
+        ],
+        [
+            "2022-12-25T21:13:52",
+            2714989
         ]
     ],
     "ci_light": [
@@ -2313,6 +2317,10 @@
         [
             "2022-12-24T20:01:35",
             39674
+        ],
+        [
+            "2022-12-25T21:13:52",
+            39700
         ]
     ],
     "cupcake": [
@@ -2451,6 +2459,10 @@
         [
             "2022-12-24T20:01:35",
             1225
+        ],
+        [
+            "2022-12-25T21:13:52",
+            1225
         ]
     ],
     "dart": [
@@ -4519,6 +4531,10 @@
         [
             "2022-12-24T20:01:35",
             98101
+        ],
+        [
+            "2022-12-25T21:13:52",
+            98252
         ]
     ],
     "dotnet": [
@@ -5677,6 +5693,10 @@
         [
             "2022-12-24T20:01:35",
             334463
+        ],
+        [
+            "2022-12-25T21:13:52",
+            334507
         ]
     ],
     "go": [
@@ -6835,6 +6855,10 @@
         [
             "2022-12-24T20:01:35",
             15827
+        ],
+        [
+            "2022-12-25T21:13:52",
+            15835
         ]
     ],
     "java": [
@@ -7993,6 +8017,10 @@
         [
             "2022-12-24T20:01:35",
             103911
+        ],
+        [
+            "2022-12-25T21:13:52",
+            103944
         ]
     ],
     "javascript": [
@@ -9151,6 +9179,10 @@
         [
             "2022-12-24T20:01:35",
             179656
+        ],
+        [
+            "2022-12-25T21:13:52",
+            179790
         ]
     ],
     "php": [
@@ -10309,6 +10341,10 @@
         [
             "2022-12-24T20:01:35",
             32943
+        ],
+        [
+            "2022-12-25T21:13:52",
+            33040
         ]
     ],
     "python": [
@@ -11467,6 +11503,10 @@
         [
             "2022-12-24T20:01:35",
             140786
+        ],
+        [
+            "2022-12-25T21:13:52",
+            140818
         ]
     ],
     "ruby": [
@@ -12621,6 +12661,10 @@
         [
             "2022-12-24T20:01:35",
             2793
+        ],
+        [
+            "2022-12-25T21:13:52",
+            2793
         ]
     ],
     "rust": [
@@ -13775,6 +13819,10 @@
         [
             "2022-12-24T20:01:35",
             4350
+        ],
+        [
+            "2022-12-25T21:13:52",
+            4350
         ]
     ],
     "salesforce": [
@@ -14933,6 +14981,10 @@
         [
             "2022-12-24T20:01:35",
             15841
+        ],
+        [
+            "2022-12-25T21:13:52",
+            15846
         ]
     ],
     "scala": [
@@ -16089,6 +16141,10 @@
         [
             "2022-12-24T20:01:35",
             1833
+        ],
+        [
+            "2022-12-25T21:13:52",
+            1836
         ]
     ],
     "swift": [
@@ -17243,6 +17299,10 @@
         [
             "2022-12-24T20:01:35",
             3008
+        ],
+        [
+            "2022-12-25T21:13:52",
+            3008
         ]
     ],
     "terraform": [
@@ -18401,6 +18461,10 @@
         [
             "2022-12-24T20:01:35",
             152010
+        ],
+        [
+            "2022-12-25T21:13:52",
+            152274
         ]
     ]
 }
diff --git a/docs/descriptors/action.md b/docs/descriptors/action.md
@@ -1,3 +1,7 @@
+---
+title: ACTION linters in MegaLinter
+description: actionlint are available to analyze ACTION files in MegaLinter
+---
 <!-- markdownlint-disable MD003 MD020 MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 <!-- Instead, update descriptor file at https://github.com/oxsecurity/megalinter/tree/main/megalinter/descriptors/action.yml -->

diff --git a/docs/descriptors/action_actionlint.md b/docs/descriptors/action_actionlint.md
@@ -1,3 +1,7 @@
+---
+title: actionlint configuration in MegaLinter
+description: How to use actionlint (configure, ignore files, ignore errors, help & version documentations) to analyze ACTION files
+---
 <!-- markdownlint-disable MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 # actionlint [![GitHub last commit](https://img.shields.io/github/last-commit/rhysd/actionlint)](https://github.com/rhysd/actionlint/commits)

diff --git a/docs/descriptors/ansible.md b/docs/descriptors/ansible.md
@@ -1,3 +1,7 @@
+---
+title: ANSIBLE linters in MegaLinter
+description: ansible-lint are available to analyze ANSIBLE files in MegaLinter
+---
 <!-- markdownlint-disable MD003 MD020 MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 <!-- Instead, update descriptor file at https://github.com/oxsecurity/megalinter/tree/main/megalinter/descriptors/ansible.yml -->

diff --git a/docs/descriptors/ansible_ansible_lint.md b/docs/descriptors/ansible_ansible_lint.md
@@ -1,3 +1,7 @@
+---
+title: ansible-lint configuration in MegaLinter
+description: How to use ansible-lint (configure, ignore files, ignore errors, help & version documentations) to analyze ANSIBLE files
+---
 <!-- markdownlint-disable MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 # ansible-lint [![GitHub last commit](https://img.shields.io/github/last-commit/ansible/ansible-lint)](https://github.com/ansible/ansible-lint/commits)

diff --git a/docs/descriptors/arm.md b/docs/descriptors/arm.md
@@ -1,3 +1,7 @@
+---
+title: ARM linters in MegaLinter
+description: arm-ttk are available to analyze ARM files in MegaLinter
+---
 <!-- markdownlint-disable MD003 MD020 MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 <!-- Instead, update descriptor file at https://github.com/oxsecurity/megalinter/tree/main/megalinter/descriptors/arm.yml -->

diff --git a/docs/descriptors/arm_arm_ttk.md b/docs/descriptors/arm_arm_ttk.md
@@ -1,3 +1,7 @@
+---
+title: arm-ttk configuration in MegaLinter
+description: How to use arm-ttk (configure, ignore files, ignore errors, help & version documentations) to analyze ARM files
+---
 <!-- markdownlint-disable MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 # arm-ttk [![GitHub last commit](https://img.shields.io/github/last-commit/Azure/arm-ttk)](https://github.com/Azure/arm-ttk/commits)

diff --git a/docs/descriptors/bash.md b/docs/descriptors/bash.md
@@ -1,3 +1,7 @@
+---
+title: BASH linters in MegaLinter
+description: bash-exec, shellcheck, shfmt are available to analyze BASH files in MegaLinter
+---
 <!-- markdownlint-disable MD003 MD020 MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 <!-- Instead, update descriptor file at https://github.com/oxsecurity/megalinter/tree/main/megalinter/descriptors/bash.yml -->

diff --git a/docs/descriptors/bash_bash_exec.md b/docs/descriptors/bash_bash_exec.md
@@ -1,3 +1,7 @@
+---
+title: bash-exec configuration in MegaLinter
+description: How to use bash-exec (configure, ignore files, ignore errors, help & version documentations) to analyze BASH files
+---
 <!-- markdownlint-disable MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 # bash-exec

diff --git a/docs/descriptors/bash_shellcheck.md b/docs/descriptors/bash_shellcheck.md
@@ -1,3 +1,7 @@
+---
+title: shellcheck configuration in MegaLinter
+description: How to use shellcheck (configure, ignore files, ignore errors, help & version documentations) to analyze BASH files
+---
 <!-- markdownlint-disable MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 # shellcheck [![GitHub last commit](https://img.shields.io/github/last-commit/koalaman/shellcheck)](https://github.com/koalaman/shellcheck/commits)

diff --git a/docs/descriptors/bash_shfmt.md b/docs/descriptors/bash_shfmt.md
@@ -1,3 +1,7 @@
+---
+title: shfmt configuration in MegaLinter
+description: How to use shfmt (configure, ignore files, ignore errors, help & version documentations) to analyze BASH files
+---
 <!-- markdownlint-disable MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 # shfmt [![GitHub last commit](https://img.shields.io/github/last-commit/mvdan/sh)](https://github.com/mvdan/sh/commits)

diff --git a/docs/descriptors/bicep.md b/docs/descriptors/bicep.md
@@ -1,3 +1,7 @@
+---
+title: BICEP linters in MegaLinter
+description: bicep_linter are available to analyze BICEP files in MegaLinter
+---
 <!-- markdownlint-disable MD003 MD020 MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 <!-- Instead, update descriptor file at https://github.com/oxsecurity/megalinter/tree/main/megalinter/descriptors/bicep.yml -->

diff --git a/docs/descriptors/bicep_bicep_linter.md b/docs/descriptors/bicep_bicep_linter.md
@@ -1,3 +1,7 @@
+---
+title: bicep_linter configuration in MegaLinter
+description: How to use bicep_linter (configure, ignore files, ignore errors, help & version documentations) to analyze BICEP files
+---
 <!-- markdownlint-disable MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 # <a href="https://learn.microsoft.com/en-us/azure/azure-resource-manager/bicep/linter" target="blank" title="Visit linter Web Site"><img src="https://raw.githubusercontent.com/Azure/bicep/main/docs/images/BicepLogoImage.png" alt="bicep_linter" height="100px" class="megalinter-logo"></a>bicep_linter [![GitHub last commit](https://img.shields.io/github/last-commit/Azure/bicep)](https://github.com/Azure/bicep/commits)

diff --git a/docs/descriptors/c.md b/docs/descriptors/c.md
@@ -1,3 +1,7 @@
+---
+title: C linters in MegaLinter
+description: cpplint are available to analyze C files in MegaLinter
+---
 <!-- markdownlint-disable MD003 MD020 MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 <!-- Instead, update descriptor file at https://github.com/oxsecurity/megalinter/tree/main/megalinter/descriptors/c.yml -->

diff --git a/docs/descriptors/c_cpplint.md b/docs/descriptors/c_cpplint.md
@@ -1,3 +1,7 @@
+---
+title: cpplint configuration in MegaLinter
+description: How to use cpplint (configure, ignore files, ignore errors, help & version documentations) to analyze C files
+---
 <!-- markdownlint-disable MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 # cpplint [![GitHub last commit](https://img.shields.io/github/last-commit/cpplint/cpplint)](https://github.com/cpplint/cpplint/commits)

diff --git a/docs/descriptors/clojure.md b/docs/descriptors/clojure.md
@@ -1,3 +1,7 @@
+---
+title: CLOJURE linters in MegaLinter
+description: clj-kondo are available to analyze CLOJURE files in MegaLinter
+---
 <!-- markdownlint-disable MD003 MD020 MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 <!-- Instead, update descriptor file at https://github.com/oxsecurity/megalinter/tree/main/megalinter/descriptors/clojure.yml -->

diff --git a/docs/descriptors/clojure_clj_kondo.md b/docs/descriptors/clojure_clj_kondo.md
@@ -1,3 +1,7 @@
+---
+title: clj-kondo configuration in MegaLinter
+description: How to use clj-kondo (configure, ignore files, ignore errors, help & version documentations) to analyze CLOJURE files
+---
 <!-- markdownlint-disable MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 

diff --git a/docs/descriptors/cloudformation.md b/docs/descriptors/cloudformation.md
@@ -1,3 +1,7 @@
+---
+title: CLOUDFORMATION linters in MegaLinter
+description: cfn-lint are available to analyze CLOUDFORMATION files in MegaLinter
+---
 <!-- markdownlint-disable MD003 MD020 MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 <!-- Instead, update descriptor file at https://github.com/oxsecurity/megalinter/tree/main/megalinter/descriptors/cloudformation.yml -->

diff --git a/docs/descriptors/cloudformation_cfn_lint.md b/docs/descriptors/cloudformation_cfn_lint.md
@@ -1,3 +1,7 @@
+---
+title: cfn-lint configuration in MegaLinter
+description: How to use cfn-lint (configure, ignore files, ignore errors, help & version documentations) to analyze CLOUDFORMATION files
+---
 <!-- markdownlint-disable MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 

diff --git a/docs/descriptors/coffee.md b/docs/descriptors/coffee.md
@@ -1,3 +1,7 @@
+---
+title: COFFEE linters in MegaLinter
+description: coffeelint are available to analyze COFFEE files in MegaLinter
+---
 <!-- markdownlint-disable MD003 MD020 MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 <!-- Instead, update descriptor file at https://github.com/oxsecurity/megalinter/tree/main/megalinter/descriptors/coffee.yml -->

diff --git a/docs/descriptors/coffee_coffeelint.md b/docs/descriptors/coffee_coffeelint.md
@@ -1,3 +1,7 @@
+---
+title: coffeelint configuration in MegaLinter
+description: How to use coffeelint (configure, ignore files, ignore errors, help & version documentations) to analyze COFFEE files
+---
 <!-- markdownlint-disable MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 # coffeelint [![GitHub last commit](https://img.shields.io/github/last-commit/clutchski/coffeelint)](https://github.com/clutchski/coffeelint/commits)

diff --git a/docs/descriptors/copypaste.md b/docs/descriptors/copypaste.md
@@ -1,3 +1,7 @@
+---
+title: COPYPASTE linters in MegaLinter
+description: jscpd are available to analyze COPYPASTE files in MegaLinter
+---
 <!-- markdownlint-disable MD003 MD020 MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 <!-- Instead, update descriptor file at https://github.com/oxsecurity/megalinter/tree/main/megalinter/descriptors/copypaste.yml -->

diff --git a/docs/descriptors/copypaste_jscpd.md b/docs/descriptors/copypaste_jscpd.md
@@ -1,3 +1,7 @@
+---
+title: jscpd configuration in MegaLinter
+description: How to use jscpd (configure, ignore files, ignore errors, help & version documentations) to analyze COPYPASTE files
+---
 <!-- markdownlint-disable MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 

diff --git a/docs/descriptors/cpp.md b/docs/descriptors/cpp.md
@@ -1,3 +1,7 @@
+---
+title: CPP linters in MegaLinter
+description: cpplint are available to analyze CPP files in MegaLinter
+---
 <!-- markdownlint-disable MD003 MD020 MD033 MD041 -->
 <!-- @generated by .automation/build.py, please do not update manually -->
 <!-- Instead, update descriptor file at https://github.com/oxsecurity/megalinter/tree/main/megalinter/descriptors/cpp.yml -->