Update crd-docs (#3391)

* CRD & doc update
Issue: [sc-12818]

* Change linter GH action

This splits the GH linter action that was checking for
TODOs and trailing spaces in the documentation into two actions:
* one that checks TODOs and trailing spaces in all files except the crd
* one that checks TODOs only in the crd.md file

Author: benjaminjb

.github/workflows/lint.yaml

@@ -16,7 +16,7 @@ jobs:
       # - https://bugs.launchpad.net/ubuntu/+source/mawk/+bug/69724
       - run: awk -W version && awk '{ exit 1 != match($0, /[[:space:]]/) }' <<< ' '
       - run: |
-          find docs/content -not -type d -print0 | xargs -0 awk '
+          find docs/content -not -type d -not -name crd.md -print0 | xargs -0 awk '
             BEGIN { print "::add-matcher::.github/actions/awk-matcher.json" }
 
             /[[:space:]]$/ { errors++; print FILENAME ":" FNR " error: Trailing space" }
@@ -26,6 +26,23 @@ jobs:
             END { exit errors != 0 }
           '
 
+  documentation-crd:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+
+      # The `documentation-crd` job only checks the crd.md for `TODO`,
+      # as some of the upstream documentation has trailing spaces
+      - run: |
+          find docs/content -name crd.md -print0 | xargs -0 awk '
+            BEGIN { print "::add-matcher::.github/actions/awk-matcher.json" }
+
+            /TODO/ { errors++; print FILENAME ":" FNR " error: Found TODO. Try running hack/create-todo-patch.sh" }
+
+            END { print "::remove-matcher owner=awk::" }
+            END { exit errors != 0 }
+          '
+
   golangci-lint:
     runs-on: ubuntu-latest
     steps: