@redpanda-data/docs-extensions-and-macros 5.0.0 → 5.0.2
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/extensions/replace-attributes-in-attachments.js +1 -1
- package/macros/rp-connect-components.js +6 -5
- package/package.json +1 -1
- package/tools/redpanda-connect/AUTOMATION.md +5 -5
- package/tools/redpanda-connect/pr-summary-formatter.js +4 -4
- package/tools/redpanda-connect/templates/bloblang-functions-overview.hbs +1 -1
- package/tools/redpanda-connect/templates/bloblang-methods-overview.hbs +1 -1
- package/tools/redpanda-connect/templates/connector.hbs +2 -2
|
@@ -181,7 +181,7 @@ function getDynamicReplacements(componentVersion, logger) {
|
|
|
181
181
|
const isPrerelease = attrs['page-component-version-is-prerelease'];
|
|
182
182
|
const versionNum = formatVersion(componentVersion.version || '', semver);
|
|
183
183
|
const is24_3plus =
|
|
184
|
-
versionNum && semver.gte(versionNum, '24.3.0') && componentVersion.title === '
|
|
184
|
+
versionNum && semver.gte(versionNum, '24.3.0') && componentVersion.title === 'Streaming';
|
|
185
185
|
const useTagAttributes = isPrerelease || is24_3plus || componentVersion.title === 'Labs';
|
|
186
186
|
|
|
187
187
|
// Derive Redpanda / Console versions
|
|
@@ -1030,17 +1030,18 @@ module.exports.register = function (registry, context) {
|
|
|
1030
1030
|
// Build link to release notes using content catalog for proper URL resolution
|
|
1031
1031
|
const isCloud = attributes['env-cloud'] !== undefined;
|
|
1032
1032
|
let whatsNewUrl = isCloud
|
|
1033
|
-
? '/
|
|
1034
|
-
: '/
|
|
1033
|
+
? '/cloud-data-platform/get-started/whats-new-cloud/'
|
|
1034
|
+
: '/connect/get-started/whats-new/';
|
|
1035
1035
|
|
|
1036
1036
|
// Try to resolve the page from the content catalog for accurate URLs
|
|
1037
1037
|
if (context.contentCatalog && context.file) {
|
|
1038
1038
|
const pageSpec = isCloud
|
|
1039
|
-
? '
|
|
1040
|
-
: '
|
|
1039
|
+
? 'cloud-data-platform:get-started:whats-new-cloud.adoc'
|
|
1040
|
+
: 'connect:get-started:whats-new.adoc';
|
|
1041
1041
|
const page = context.contentCatalog.resolvePage(pageSpec, context.file.src);
|
|
1042
1042
|
if (page) {
|
|
1043
|
-
|
|
1043
|
+
// For directory-style URLs like /a/b/c/, use the URL directly as the base
|
|
1044
|
+
whatsNewUrl = path.relative(context.file.pub.url, page.pub.url);
|
|
1044
1045
|
}
|
|
1045
1046
|
}
|
|
1046
1047
|
|
package/package.json
CHANGED
|
@@ -306,14 +306,14 @@ Brief summary of what this connector does.
|
|
|
306
306
|
====
|
|
307
307
|
Common config::
|
|
308
308
|
+
|
|
309
|
-
include::
|
|
309
|
+
include::connect:components:partial$examples/inputs/connector_name.adoc[tag=common]
|
|
310
310
|
|
|
311
311
|
Advanced config::
|
|
312
312
|
+
|
|
313
|
-
include::
|
|
313
|
+
include::connect:components:partial$examples/inputs/connector_name.adoc[tag=advanced]
|
|
314
314
|
====
|
|
315
315
|
|
|
316
|
-
include::
|
|
316
|
+
include::connect:components:partial$fields/inputs/connector_name.adoc[]
|
|
317
317
|
|
|
318
318
|
// end::single-source[]
|
|
319
319
|
```
|
|
@@ -517,12 +517,12 @@ _No changes in this release_
|
|
|
517
517
|
|
|
518
518
|
**For connectors in pages:**
|
|
519
519
|
\```asciidoc
|
|
520
|
-
include::
|
|
520
|
+
include::connect:components:page$type/name.adoc[tag=single-source]
|
|
521
521
|
\```
|
|
522
522
|
|
|
523
523
|
**For cloud-only connectors (in partials):**
|
|
524
524
|
\```asciidoc
|
|
525
|
-
include::
|
|
525
|
+
include::connect:components:partial$components/cloud-only/type/name.adoc[tag=single-source]
|
|
526
526
|
\```
|
|
527
527
|
|
|
528
528
|
### 🔧 Cgo Requirements
|
|
@@ -101,12 +101,12 @@ function renderBloblangChanges(data, includeVersion = false) {
|
|
|
101
101
|
lines.push('');
|
|
102
102
|
lines.push('For methods, find the appropriate category section in `methods.adoc` and add:');
|
|
103
103
|
lines.push('```asciidoc');
|
|
104
|
-
lines.push('include::
|
|
104
|
+
lines.push('include::connect:partial$bloblang-methods/method_name.adoc[leveloffset=+2]');
|
|
105
105
|
lines.push('```');
|
|
106
106
|
lines.push('');
|
|
107
107
|
lines.push('For functions, add to the Functions section in `functions.adoc`:');
|
|
108
108
|
lines.push('```asciidoc');
|
|
109
|
-
lines.push('include::
|
|
109
|
+
lines.push('include::connect:partial$bloblang-functions/function_name.adoc[leveloffset=+2]');
|
|
110
110
|
lines.push('```');
|
|
111
111
|
lines.push('');
|
|
112
112
|
lines.push('**Note:** Partials are auto-generated. Includes must be added manually in alphabetical order within their section.');
|
|
@@ -700,7 +700,7 @@ function generatePRSummary(diffData, binaryAnalysis = null, draftedConnectors =
|
|
|
700
700
|
lines.push('```asciidoc');
|
|
701
701
|
lines.push('= Connector Name');
|
|
702
702
|
lines.push('');
|
|
703
|
-
lines.push('include::
|
|
703
|
+
lines.push('include::connect:components:page$type/connector-name.adoc[tag=single-source]');
|
|
704
704
|
lines.push('```');
|
|
705
705
|
lines.push('');
|
|
706
706
|
}
|
|
@@ -710,7 +710,7 @@ function generatePRSummary(diffData, binaryAnalysis = null, draftedConnectors =
|
|
|
710
710
|
lines.push('```asciidoc');
|
|
711
711
|
lines.push('= Connector Name');
|
|
712
712
|
lines.push('');
|
|
713
|
-
lines.push('include::
|
|
713
|
+
lines.push('include::connect:components:partial$components/cloud-only/type/connector-name.adoc[tag=single-source]');
|
|
714
714
|
lines.push('```');
|
|
715
715
|
lines.push('');
|
|
716
716
|
}
|
|
@@ -23,7 +23,7 @@ root.values_two = range(0, this.max, 2)
|
|
|
23
23
|
```
|
|
24
24
|
{{#each functions}}
|
|
25
25
|
|
|
26
|
-
include::
|
|
26
|
+
include::connect:components:partial$bloblang-functions/{{this}}.adoc[leveloffset=+1]
|
|
27
27
|
{{/each}}
|
|
28
28
|
|
|
29
29
|
// end::single-source[]
|
|
@@ -32,7 +32,7 @@ root.foo_two = this.(bar | baz).trim().replace_all("dog", "cat")
|
|
|
32
32
|
== {{{toSentenceCase this.name}}}
|
|
33
33
|
{{#each this.methods}}
|
|
34
34
|
|
|
35
|
-
include::
|
|
35
|
+
include::connect:components:partial$bloblang-methods/{{this}}.adoc[leveloffset=+2]
|
|
36
36
|
{{/each}}
|
|
37
37
|
{{/each}}
|
|
38
38
|
|
|
@@ -47,11 +47,11 @@ You can either xref:install:prebuilt-binary.adoc[download a prebuilt cgo-enabled
|
|
|
47
47
|
|
|
48
48
|
{{/if}}
|
|
49
49
|
{{#if (or this.config.children children)}}
|
|
50
|
-
include::
|
|
50
|
+
include::connect:components:partial$fields/{{typeDir}}/{{name}}.adoc[]
|
|
51
51
|
{{/if}}
|
|
52
52
|
|
|
53
53
|
{{#if this.examples}}
|
|
54
|
-
include::
|
|
54
|
+
include::connect:components:partial$examples/{{typeDir}}/{{name}}.adoc[]
|
|
55
55
|
{{/if}}
|
|
56
56
|
|
|
57
57
|
|