CI: Address some certification comments (#6740)

Author: gmuloc

.pre-commit-config.yaml

@@ -148,13 +148,13 @@ repos:
         name: Check for Linting errors on Python files outside the Ansible collection.
         description: This hook runs pylint.
         types: [python]
-      - id: pylint # Use pylintrc file in Ansible collection
+      - id: pylint # Use pylintrc-ansible file for Ansible collection
         name: Check for Linting errors on Python files in the Ansible collection.
         description: This hook runs pylint.
         types: [python]
         files: ansible_collections/arista/avd/
         args:
-          - --rcfile=ansible_collections/arista/avd/pylintrc
+          - --rcfile=pylintrc-ansible
 
   - repo: https://github.com/adrienverge/yamllint.git
     rev: "v1.38.0"
@@ -204,7 +204,13 @@ repos:
     hooks:
       - id: pdm-export
         name: Extract requirements from pyavd/pyproject.toml to requirements.txt
-        entry: pdm export -p python-avd -o ansible_collections/arista/avd/requirements.txt --without-hashes -G ansible -G self --pyproject
+        entry: pdm export -p python-avd -o ansible_collections/arista/avd/requirements.txt --without-hashes -G ansible-collection -G self --pyproject
+        language: python
+        files: python-avd/pyproject.toml
+        pass_filenames: false
+      - id: pdm-export
+        name: Extract requirements from pyavd/pyproject.toml to docs/requirements.txt
+        entry: pdm export -p python-avd -o docs/requirements.txt --without-hashes -G ansible -G self --pyproject
         language: python
         files: python-avd/pyproject.toml
         pass_filenames: false

ansible_collections/arista/avd/.yamllint

@@ -3,45 +3,54 @@
 extends: default
 
 rules:
-  braces:
-    min-spaces-inside: 0
-    max-spaces-inside: 1
+  comments:
+    # https://github.com/prettier/prettier/issues/6780
+    min-spaces-from-content: 1
     level: error
-  brackets:
-    max-spaces-inside: 1
+  # https://github.com/adrienverge/yamllint/issues/384
+  comments-indentation: false
+  document-start: disable
+  # We are adding an extra space inside braces as that's how prettier does it
+  # and we are trying not to fight other linters.
+  line-length:
+    max: 160
+    # TODO: See how we can fix this going forward
+    ignore:
+      - /extensions/molecule/**/intended/structured_configs/
+      - /changelogs/fragments_backup/
+  braces:
+    min-spaces-inside: 0 # yamllint defaults to 0
+    max-spaces-inside: 1 # yamllint defaults to 0
     level: error
+  octal-values:
+    forbid-implicit-octal: true # yamllint defaults to false
+    forbid-explicit-octal: true # yamllint defaults to false
+  #######################################################################
+  # AVD Extra checks as compared to default ansible-lint configuration  #
+  #     in most cases we are stricter so this is not conflicting except #
+  #     for the indentation rule where we are more flexible.            #
+  #######################################################################
   colons:
     max-spaces-after: -1
     level: error
   commas:
     max-spaces-after: -1
     level: error
-  comments:
-    # prettier compatibility
-    min-spaces-from-content: 1
+  brackets:
+    max-spaces-inside: 1
     level: error
-  comments-indentation: false
-  document-start: disable
   empty-lines:
     max: 1
     level: error
   hyphens:
     level: error
   key-duplicates:
     forbid-duplicated-merge-keys: true
-  line-length:
-    max: 160
-    ignore:
-      - /extensions/molecule/**/intended/structured_configs/
-      - /extensions/molecule/**/intended/structured_configs/cvp/
-      - /examples/**/intended/structured_configs/cvp/
-      - /changelogs/fragments_backup/
-      - /tests/inventory/**/expected_output
   new-lines:
     type: unix
   indentation:
     level: error
+    # NOTE: Here we diverge from the ansible-lint default configuration
+    #       and this is causing issues when running ansible-lint without
+    #       out custom configuration.
     indent-sequences: consistent
-  octal-values:
-    forbid-implicit-octal: true
-    forbid-explicit-octal: true