DOC-1455 End to end config property automation (#129)

* Add support for overrides and proper defaults

* Add support for providing examples in overrides

* Add support for overriding version

* Add support for templates

* Apply suggestions

* Update directories for output files

* Do not add name field

* Fix test

* Save only final properties to examples dir

* Remove duplicates

* Bump version

* Improve error reporting

* Increase timeout

* Mock data for faster testing

* Simplify

* Apply suggestions

* Allow for null defaults

* Fix dirs

* Apply suggestions

* Update tools/property-extractor/generate-handlebars-docs.js

* Update deprecated

* Fix doc

* Integrate topic property automation

* Bump version

Author: JakeSCahill

.github/workflows/test.yaml

@@ -222,19 +222,6 @@ jobs:
       - name: Run all tests
         run: npm test
 
-      - name: Generate coverage report
-        if: matrix.node-version == '18'
-        run: npm test -- --coverage --coverageReporters=lcov
-
-      - name: Upload coverage to Codecov
-        if: matrix.node-version == '18'
-        uses: codecov/codecov-action@v3
-        with:
-          token: ${{ secrets.CODECOV_TOKEN }}
-          file: ./coverage/lcov.info
-          flags: unittests
-          name: codecov-umbrella
-
   # Summary job that all other jobs depend on
   test-summary:
     if: always()

.gitignore

@@ -1,4 +1,3 @@
-/node_modules/*
 /wip/*
 /docs/*
 .vscode
@@ -10,4 +9,5 @@ gen/
 tree-sitter/
 test/
 modules/
-cloud-controlplane/
+cloud-controlplane/
+node_modules

__tests__/docs-data/examples/admin-example.adoc

@@ -0,0 +1,15 @@
+.Example Configuration for Admin API
+This example shows how to configure the admin API endpoint with custom addressing.
+
+[,yaml]
+----
+redpanda:
+  admin:
+    - address: "0.0.0.0"
+      port: 9644
+    - address: "127.0.0.1"
+      port: 9645
+----
+
+You can specify multiple admin endpoints to provide redundancy and load balancing.
+The admin API is used for cluster management operations.

__tests__/docs-data/property-overrides.json

@@ -0,0 +1,81 @@
+{
+  "properties": {
+    "admin": {
+      "description": "Network addresses for Admin API servers with version info.",
+      "version": "v23.1.0",
+      "example_file": "examples/admin-example.adoc"
+    },
+    "admin_api_tls": {
+      "description": "TLS configuration for the Admin API endpoints.",
+      "version": "v23.2.0",
+      "example_yaml": {
+        "title": "Example TLS Configuration",
+        "description": "This example shows how to configure TLS for the Admin API with client authentication.",
+        "config": {
+          "redpanda": {
+            "admin_api_tls": [
+              {
+                "name": "internal-admin",
+                "enabled": true,
+                "cert_file": "/etc/redpanda/certs/admin.crt",
+                "key_file": "/etc/redpanda/certs/admin.key",
+                "truststore_file": "/etc/redpanda/certs/ca.crt",
+                "require_client_auth": true
+              }
+            ]
+          }
+        }
+      }
+    },
+    "abort_index_segment_size": {
+      "description": "Segment size for transaction abort index. Controls how large each abort index segment can grow.",
+      "example": [
+        ".Example: Setting abort index segment size",
+        "[,yaml]",
+        "----",
+        "redpanda:",
+        "  abort_index_segment_size: 134217728  # 128MB",
+        "----",
+        "",
+        "This setting controls the maximum size of abort index segments.",
+        "Smaller segments may improve memory usage but increase overhead."
+      ]
+    },
+    "append_chunk_size": {
+      "description": "Size of data chunks for append operations.",
+      "version": "v24.1.0",
+      "example": "67108864"
+    },
+    "cloud_storage_access_key": {
+      "description": "Access key for cloud storage authentication. Used to authenticate with S3-compatible object storage services."
+    },
+        "cleanup.policy": {
+      "description": "Determines how log segments are cleaned. **delete** removes old segments based on time or size. **compact** retains only the latest value for each key. **compact,delete** enables both strategies.",
+      "version": "v23.1.0",
+      "example": [
+        ".Example: Setting cleanup policy",
+        "[,bash]",
+        "----",
+        "rpk topic alter-config my-topic --set cleanup.policy=compact",
+        "----",
+        "",
+        "For topics that require both compaction and deletion:",
+        "",
+        "[,bash]",
+        "----",
+        "rpk topic alter-config my-topic --set cleanup.policy=compact,delete",
+        "----"
+      ]
+    },
+    "compression.type": {
+      "description": "Compression algorithm used for compressing message batches. Options include **none** (no compression), **gzip**, **snappy**, **lz4**, and **zstd**.",
+      "example": [
+        ".Example: Setting compression type",
+        "[,bash]",
+        "----",
+        "rpk topic alter-config my-topic --set compression.type=zstd",
+        "----"
+      ]
+    }
+  }
+}

__tests__/tools/property-docs-overrides.test.js

@@ -0,0 +1,87 @@
+const fs = require('fs');
+const path = require('path');
+const os = require('os');
+
+const repoRoot = path.resolve(__dirname, '..', '..');
+const overridesFile = path.join(repoRoot, '__tests__', 'docs-data', 'property-overrides.json');
+
+describe('property-docs description override', () => {
+  let tempDir;
+  let mockPropertiesFile;
+
+  beforeAll(() => {
+    tempDir = fs.mkdtempSync(path.join(os.tmpdir(), 'property-docs-test-'));
+    
+    // Create mock property data that includes admin property
+    const mockProperties = {
+      properties: {
+        admin: {
+          config_scope: "broker",
+          default: [{ address: "127.0.0.1", port: 9644 }],
+          defined_in: "src/v/config/node_config.cc",
+          description: "Default description for admin",
+          name: "admin",
+          needs_restart: true,
+          nullable: false,
+          type: "array",
+          visibility: "user"
+        },
+        kafka_api: {
+          config_scope: "broker", 
+          default: [{ address: "127.0.0.1", port: 9092 }],
+          defined_in: "src/v/config/node_config.cc",
+          description: "IP address and port of the Kafka API endpoint that handles requests.",
+          name: "kafka_api",
+          needs_restart: true,
+          nullable: false,
+          type: "array", 
+          visibility: "user"
+        }
+      }
+    };
+    
+    // Write mock properties to a temp file
+    mockPropertiesFile = path.join(tempDir, 'mock-properties.json');
+    fs.writeFileSync(mockPropertiesFile, JSON.stringify(mockProperties, null, 2));
+  });
+
+  afterAll(() => {
+    fs.rmSync(tempDir, { recursive: true, force: true });
+  });
+
+  it('applies the override description for admin property', () => {
+    const overrides = JSON.parse(fs.readFileSync(overridesFile, 'utf8'));
+    const mockProperties = JSON.parse(fs.readFileSync(mockPropertiesFile, 'utf8'));
+    
+    // Test 1: Verify the override file structure
+    const adminOverride = overrides.properties.admin;
+    expect(adminOverride).toBeTruthy();
+    expect(adminOverride.description).toBeTruthy();
+    expect(adminOverride.version).toBe('v23.1.0');
+    expect(adminOverride.description).toBe('Network addresses for Admin API servers with version info.');
+    
+    // Test 2: Verify our mock data has the correct structure (no artificial name field)
+    const adminProperty = mockProperties.properties.admin;
+    expect(adminProperty.default).toEqual([{ address: "127.0.0.1", port: 9644 }]);
+    
+    const adminDefault = adminProperty.default[0];
+    expect(adminDefault).toHaveProperty('address', '127.0.0.1');
+    expect(adminDefault).toHaveProperty('port', 9644);
+    
+    // Test 3: Simulate applying overrides (this is what the Python script would do)
+    const adminWithOverrides = {
+      ...adminProperty,
+      description: adminOverride.description,
+      version: adminOverride.version
+    };
+    
+    expect(adminWithOverrides.description).toBe('Network addresses for Admin API servers with version info.');
+    expect(adminWithOverrides.version).toBe('v23.1.0');
+    expect(adminWithOverrides.default).toEqual([{ address: "127.0.0.1", port: 9644 }]);
+    
+    // Test 4: Verify that kafka_api (without overrides) keeps its original description
+    const kafkaProperty = mockProperties.properties.kafka_api;
+    expect(kafkaProperty.description).toBe('IP address and port of the Kafka API endpoint that handles requests.');
+    expect(kafkaProperty.default).toEqual([{ address: "127.0.0.1", port: 9092 }]);
+  });
+});