diff --git a/package-lock.json b/package-lock.json index 4758367..d1d8f24 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { "name": "@redpanda-data/docs-extensions-and-macros", - "version": "4.10.4", + "version": "4.10.5", "lockfileVersion": 3, "requires": true, "packages": { "": { "name": "@redpanda-data/docs-extensions-and-macros", - "version": "4.10.4", + "version": "4.10.5", "license": "ISC", "dependencies": { "@asciidoctor/tabs": "^1.0.0-beta.6", diff --git a/package.json b/package.json index 7ceb91c..4e9dfc3 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "@redpanda-data/docs-extensions-and-macros", - "version": "4.10.4", + "version": "4.10.5", "description": "Antora extensions and macros developed for Redpanda documentation.", "keywords": [ "antora", diff --git a/tools/property-extractor/generate-handlebars-docs.js b/tools/property-extractor/generate-handlebars-docs.js index cc882dd..266aa9c 100644 --- a/tools/property-extractor/generate-handlebars-docs.js +++ b/tools/property-extractor/generate-handlebars-docs.js @@ -1,3 +1,4 @@ +const AUTOGEN_NOTICE = '// This content is autogenerated. Do not edit manually. To override descriptions, use the doc-tools CLI with the --overrides option: https://redpandadata.atlassian.net/wiki/spaces/DOC/pages/1396244485/Review+Redpanda+configuration+properties\n'; 'use strict'; const fs = require('fs'); @@ -144,7 +145,7 @@ function generatePropertyPartials(properties, partialsDir) { const selectedTemplate = type === 'topic' ? topicTemplate : propertyTemplate; const content = props.map(p => selectedTemplate(p)).join('\n'); const filename = `${type}-properties.adoc`; - fs.writeFileSync(path.join(propertiesPartialsDir, filename), content, 'utf8'); + fs.writeFileSync(path.join(propertiesPartialsDir, filename), AUTOGEN_NOTICE + content, 'utf8'); console.log(`✅ Generated ${filename} (${props.length} properties)`); totalCount += props.length; }); @@ -183,7 +184,7 @@ function generateDeprecatedDocs(properties, outputDir) { : path.join(outputDir, 'partials', 'deprecated', 'deprecated-properties.adoc'); fs.mkdirSync(path.dirname(outputPath), { recursive: true }); - fs.writeFileSync(outputPath, output, 'utf8'); + fs.writeFileSync(outputPath, AUTOGEN_NOTICE + output, 'utf8'); console.log(`✅ Generated ${outputPath}`); return deprecatedProperties.length; } @@ -211,7 +212,7 @@ function generateTopicPropertyMappings(properties, partialsDir) { const hbs = handlebars.compile(hbsSource); const rendered = hbs({ topicProperties }); const mappingsOut = path.join(partialsDir, 'topic-property-mappings.adoc'); - fs.writeFileSync(mappingsOut, rendered, 'utf8'); + fs.writeFileSync(mappingsOut, AUTOGEN_NOTICE + rendered, 'utf8'); console.log(`✅ Generated ${mappingsOut}`); return topicProperties.length; } diff --git a/tools/redpanda-connect/templates/examples-partials.hbs b/tools/redpanda-connect/templates/examples-partials.hbs index 32e0f2c..b9aa237 100644 --- a/tools/redpanda-connect/templates/examples-partials.hbs +++ b/tools/redpanda-connect/templates/examples-partials.hbs @@ -1,5 +1,5 @@ {{#with examples}} -// This content is autogenerated. Do not edit manually. +// This content is autogenerated. Do not edit manually. To override descriptions, use the doc-tools CLI with the --overrides option: https://redpandadata.atlassian.net/wiki/spaces/DOC/pages/1247543314/Generate+reference+docs+for+Redpanda+Connect == Examples