Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -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",
Expand Down
7 changes: 4 additions & 3 deletions tools/property-extractor/generate-handlebars-docs.js
Original file line number Diff line number Diff line change
@@ -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');
Expand Down Expand Up @@ -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;
});
Expand Down Expand Up @@ -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;
}
Expand Down Expand Up @@ -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;
}
Expand Down
2 changes: 1 addition & 1 deletion tools/redpanda-connect/templates/examples-partials.hbs
Original file line number Diff line number Diff line change
@@ -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

Expand Down