Add a docs to the pipeline

Update the scan repo health expected output

Signed-off-by: ziad hany <ziadhany2016@gmail.com>

Author: ziadhany

docs/application-settings.rst

@@ -419,6 +419,55 @@ Also provide the name and email that will be used to sign off on commits to Git
 
     FEDERATEDCODE_GIT_SERVICE_EMAIL=insert_email_here
 
+.. _scancodeio_settings_grimoirelab:
+
+GrimoireLab
+^^^^^^^^^^^^^
+
+GrimoireLab is a platform for software development analytics and insights.
+
+Before launching the GrimoireLab service, ensure that your GrimoireLab
+instance is version 2.x and that OpenSearch is running.
+
+See https://github.com/chaoss/grimoirelab#getting-started for more details
+on the installation.
+
+To configure your local environment, set the following in your ``.env`` file::
+
+    GRIMOIRELAB_METRICS_EXECUTABLE="./healthycode/venv/bin/grimoirelab-metrics"
+    GRIMOIRELAB_URL="http://example.com:8000"
+    GRIMOIRELAB_USERNAME="username"
+    GRIMOIRELAB_PASSWORD="password"
+    GRIMOIRELAB_OPENSEARCH_URL="https://example.com:9200"
+    GRIMOIRELAB_OPENSEARCH_INDEX="events"
+    GRIMOIRELAB_OPENSEARCH_USERNAME="opensearch_username"
+    GRIMOIRELAB_OPENSEARCH_PASSWORD="opensearch_password"
+    GRIMOIRELAB_ECOSYSTEM="npm-training-set"
+    GRIMOIRELAB_PROJECT="npm-popular-components"
+
+The following variables configure the connection to the GrimoireLab instance:
+
+- ``GRIMOIRELAB_METRICS_EXECUTABLE``: Path to the grimoirelab-metrics executable, See
+  here for more details on how to set up
+  the grimoirelab-metrics executable: https://github.com/aboutcode-org/healthycode#installation
+
+- ``GRIMOIRELAB_URL``: URL of the GrimoireLab instance.
+- ``GRIMOIRELAB_USERNAME``: Username used to authenticate with GrimoireLab.
+- ``GRIMOIRELAB_PASSWORD``: Password used to authenticate with GrimoireLab.
+
+The following variables configure the connection to OpenSearch:
+
+- ``GRIMOIRELAB_OPENSEARCH_URL``: URL of the OpenSearch instance.
+- ``GRIMOIRELAB_OPENSEARCH_INDEX``: OpenSearch index containing the GrimoireLab events.
+- ``GRIMOIRELAB_OPENSEARCH_USERNAME``: Username used to authenticate with OpenSearch.
+- ``GRIMOIRELAB_OPENSEARCH_PASSWORD``: Password used to authenticate with OpenSearch.
+
+The following variables specify the GrimoireLab project where the project
+data is stored:
+
+- ``GRIMOIRELAB_ECOSYSTEM``: Ecosystem containing the project data.
+- ``GRIMOIRELAB_PROJECT``: Name of the GrimoireLab project containing the project data.
+
 
 .. _scancodeio_settings_fetch_authentication:
 

docs/images/tutorial-web-ui-project-form-repo-health-result.png

@@ -48,6 +48,7 @@ Learn via practical step-by-step guides.
 - :ref:`tutorial_web_ui_symbol_and_string_collection`
 - :ref:`tutorial_cli_end_to_end_scanning_to_dejacode`
 - :ref:`tutorial_analyze_symbols_reachability`
+- :ref:`tutorial_web_ui_scan_repo_health`
 
 .. rst-class:: column column2 bottom-left
 
@@ -118,6 +119,7 @@ Indices and tables
     tutorial_web_ui_symbol_and_string_collection
     tutorial_cli_end_to_end_scanning_to_dejacode
     tutorial_analyze_symbols_reachability
+    tutorial_web_ui_scan_repo_health
     scanpipe-concepts
     built-in-pipelines
     custom-pipelines

docs/images/tutorial-web-ui-project-form-repo-health.png

@@ -0,0 +1,44 @@
+.. _tutorial_web_ui_scan_repo_health:
+
+Scan repo health (Web UI)
+=========================
+
+This tutorial guides you through scanning the health
+of a git repository using the ScanCode.io Web UI.
+
+.. note::
+    This tutorial assumes you have a recent version of ScanCode.io installed
+    locally on your machine and **running with Docker**.
+    If you do not have it installed, see our :ref:`installation` guide for instructions.
+
+Requirements
+------------
+
+Before you follow the instructions in this tutorial, you need to:
+
+- Install **ScanCode.io** locally.
+- Access to the web application from your preferred browser on http://localhost/ or
+  http://localhost:8001/ if you run on a local development setup.
+- Make sure the following GrimoireLab
+  service is correctly configured: :ref:`scancodeio_settings_grimoirelab`.
+
+Instructions
+------------
+
+1. From the homepage, click the ``New Project`` button.
+2. Enter ``npm-example-repo-health`` as the project **Name** for example.
+3. Add a valid git repository url into the **Download URL** field:
+   https://github.com/aboutcode-org/npm-project-example
+4. Select ``scan_repo_health`` from the **Pipeline** dropdown.
+5. Check the **Execute pipeline now** box to run the pipeline immediately upon creation.
+6. Click **Create**.
+
+.. image:: images/tutorial-web-ui-project-form-repo-health.png
+   :alt: Create project form for repo health scan
+
+7. Once the pipeline execution is complete, you can download the generated output result in
+   **JSON** format (for example, ``metrics-2026-09-10-12-02-38.json``)
+   or directly view the data from the project's result view.
+
+.. image:: images/tutorial-web-ui-project-form-repo-health-result.png
+   :alt: Scan repo health output pipeline

docs/index.rst

@@ -166,8 +166,8 @@ def format_metrics_output(self):
 
         result = {
             "repository": repository,
-            "npm_health_score": score,
-            "health_metrics": metrics,
+            "score": score,
+            "metrics": metrics,
         }
 
         with open(self.metrics_output_path, "w") as f:

docs/tutorial_web_ui_scan_repo_health.rst

@@ -1,14 +1,14 @@
 {
   "repository": "https://github.com/baidu/san.git",
-  "npm_health_score": {
+  "score": {
     "value": 0.027432660614030716,
     "metadata": {
       "ecosystem": "npm",
       "model": "health",
       "version": "0.1"
     }
   },
-  "health_metrics": {
+  "metrics": {
     "total_commits": 21,
     "total_contributors": 5,
     "total_organizations": 4,