Add profanity scanning to Code Quality checks

Author: annietllnd

.github/workflows/content-checks.yml

@@ -59,6 +59,17 @@ jobs:
           name: spellcheck-output
           path: spellcheck-output.txt
           retention-days: 5 # Default is 90 days
+      - name: Scan for profanities
+        run: |
+          python tools/profanity.py
+          cat profanity_log.txt
+
+      - name: Export profanities
+        uses: actions/upload-artifact@v4
+        with:
+          name: profanities
+          path: profanity_log.txt
+          retention-days: 5
 
       - name: Scan for malware
         run: |

.profanity_ignore.yml

@@ -0,0 +1,26 @@
+XX
+-kill
+kill
+KVM
+kvm
+X.X.X
+.xx.
+.xxx.
+naked
+facial
+Facial
+screw
+len
+LEN
+test
+TEST
+Test
+--strip-
+(x=x
+**VM
+Kill
+slave
+Slave
+A55
+a55
+455

profanity_log.txt

@@ -0,0 +1,111 @@
+Profanity found in file: ./content/install-guides/perf.md
+Profanities found: dummy
+
+Profanity found in file: ./content/learning-paths/embedded-and-microcontrollers/tfm/tfm.md
+Profanities found: <NUL>TFM_DUMMY_PROVISIONING, TFM_DUMMY_PROVISIONING, dummy
+
+Profanity found in file: ./content/learning-paths/embedded-and-microcontrollers/advanced_soc/connecting_peripheral.md
+Profanities found: #IO_L3N_T0_DQS_AD1N_35
+
+Profanity found in file: ./content/learning-paths/embedded-and-microcontrollers/cmsisdsp-dev-with-python/how-to-4.md
+Profanities found: vmax=[np.max(l)
+
+Profanity found in file: ./content/learning-paths/embedded-and-microcontrollers/training-inference-pytorch/fine-tune-2.md
+Profanities found: outputs.max(1)
+
+Profanity found in file: ./content/learning-paths/cross-platform/kleidiai-explainer/page1.md
+Profanities found: *z*
+
+Profanity found in file: ./content/learning-paths/cross-platform/ipexplorer/custom1.md
+Profanities found: m4x1_cache_2kb, m4x1_nocache_ws0, m4x1_nocache_ws4, m4x1_cache_64kb
+
+Profanity found in file: ./content/learning-paths/cross-platform/vectorization-friendly-data-layout/a-more-complex-problem-revisited-sve.md
+Profanities found: objects->vz[i], &objects->vz[i]);, box_hi_v);, &objects->vz[i],
+
+Profanity found in file: ./content/learning-paths/cross-platform/vectorization-friendly-data-layout/a-more-complex-problem-revisited.md
+Profanities found: objects->vz[i], vnegq_f32(box_hi_v);, box_hi_v);, vld1q_f32(&objects->vz[i]);, vst1q_f32(&objects->vz[i],
+
+Profanity found in file: ./content/learning-paths/cross-platform/vectorization-friendly-data-layout/a-more-complex-problem-manual-simd.md
+Profanities found: vnegq_f32(box_hi_v);, box_hi_v);
+
+Profanity found in file: ./content/learning-paths/cross-platform/adler32/neon-run-8.md
+Profanities found: Test**:
+
+Profanity found in file: ./content/learning-paths/cross-platform/psa-tfm/run.md
+Profanities found: CVM
+
+Profanity found in file: ./content/learning-paths/mobile-graphics-and-gaming/kleidiai-on-android-with-mediapipe-and-xnnpack/2-run-gemma-2b.md
+Profanities found: --cxxopt=-DABSL_FLAGS_STRIP_NAMES=0
+
+Profanity found in file: ./content/learning-paths/mobile-graphics-and-gaming/get-started-with-arm-asr/04-generic_library.md
+Profanities found: **1**,
+
+Profanity found in file: ./content/learning-paths/mobile-graphics-and-gaming/android_opencv_facedetection/background.md
+Profanities found: Facial
+
+Profanity found in file: ./content/learning-paths/mobile-graphics-and-gaming/best-practices-for-hwrt-lumen-performance/8-lumen-general.md
+Profanities found: color=#00FF00>**1**</font>
+
+Profanity found in file: ./content/learning-paths/mobile-graphics-and-gaming/build-android-selfie-app-using-mediapipe-multimodality/6-flow-data-to-view-1.md
+Profanities found: Paint.Style.STROKE, LANDMARK_STROKE_WIDTH
+
+Profanity found in file: ./content/learning-paths/iot/iot-sdk/openiot.md
+Profanities found: <NUL>TFM_DUMMY_PROVISIONING, TFM_DUMMY_PROVISIONING, dummy
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/vLLM-quant/3-run-benchmark.md
+Profanities found: metrics.py:455]
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/arcee-foundation-model-on-aws/02_setting_up_the_instance.md
+Profanities found: G++**:
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/from-iot-to-the-cloud-part3/how-to-2.md
+Profanities found: **1**, **Dev/Test**
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/glibc-with-lse/mongo_benchmark.md
+Profanities found: 455
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/triggering-pmu-events/icache.md
+Profanities found: 455
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/wordpress/wordpress.md
+Profanities found: --strip
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/redis/single-node_deployment.md
+Profanities found: **-h**, **-p**
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/java-gc-tuning/setup.md
+Profanities found: 21.0.4+7-LTS,, 21.0.4+7-LTS)
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/java-gc-tuning/tuning-parameters.md
+Profanities found: 21.0.4+7-LTS,, 21.0.4+7-LTS)
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/arm_linux_page_size/centos.md
+Profanities found: Strip
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/rag/backend.md
+Profanities found: "").strip()
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/multiarch_ollama_on_gke/0-spin_up_gke_cluster.md
+Profanities found: **1**)., **1**
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/from-iot-to-the-cloud-part1/how-to-4.md
+Profanities found: **vm-arm64**, **vm-arm64**,
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/from-iot-to-the-cloud-part1/how-to-2.md
+Profanities found: **vm-arm64**
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/mysql/install_mysql.md
+Profanities found: Manual](https://dev.mysql.com/doc/refman/8.1/en/), options](https://dev.mysql.com/doc/refman/8.1/en/installing.html)., documentation](https://dev.mysql.com/doc/refman/8.1/en/mysqld-server.html),, [instructions](https://dev.mysql.com/doc/refman/8.1/en/mysql.html)
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/llama-vision/backend.md
+Profanities found: f"<|user|>\n{prompt.strip()}<|end_of_text|>\n", token.strip():
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/llama-vision/frontend.md
+Profanities found: data.strip(), line.strip(), user_prompt.strip()
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/arm_pmu/perf_event_open.md
+Profanities found: configure_event(&pe[3],
+
+Profanity found in file: ./content/learning-paths/servers-and-cloud-computing/distributed-inference-with-llama-cpp/_index.md
+Profanities found: Aryan
+

tools/profanity.py

@@ -0,0 +1,39 @@
+import os
+from better_profanity import profanity
+import argparse
+import sys
+def load_excluded_words(file_path):
+    with open(file_path, 'r') as f:
+        excluded_words = [word.strip() for word in f.readlines()]
+    return excluded_words
+
+def scan_for_profanities(directory, log_file, excluded_words_file=None):
+    exclude_words = None
+    profanities = None
+    if excluded_words_file:
+        exclude_words = load_excluded_words(excluded_words_file)
+
+    with open(log_file, 'w') as f:
+        for root, dirs, files in os.walk(directory):
+            for file in files:
+                if file.endswith('.md'):  # Read only markdown files
+                    file_path = os.path.join(root, file)
+                    with open(file_path, 'r') as code_file:
+                        profanities = None
+                        content = code_file.read()
+                        if exclude_words:
+                            excluded_content = content
+                            for word in exclude_words:
+                                excluded_content = excluded_content.replace(word, '')
+                            if profanity.contains_profanity(excluded_content):
+                                profanities = set(word for word in excluded_content.split() if profanity.contains_profanity(word))
+                        else:
+                            if profanity.contains_profanity(content):
+                                profanities = set(word for word in content.split() if profanity.contains_profanity(word))
+                        if profanities:
+                                    f.write(f"Profanity found in file: {file_path}\n")
+                                    f.write("Profanities found: ")
+                                    f.write(", ".join(profanities))
+                                    f.write("\n\n")
+
+scan_for_profanities("./content/", "./profanity_log.txt", excluded_words_file="./.profanity_ignore.yml")