fix(csv): promote "Output CSV column order" out of the Metadata section#462
Open
JakeSCahill wants to merge 1 commit into
Open
fix(csv): promote "Output CSV column order" out of the Metadata section#462JakeSCahill wants to merge 1 commit into
JakeSCahill wants to merge 1 commit into
Conversation
The csv input's description nested "=== Output CSV column order" (a how-to for producing deterministic CSV output, with a Bloblang example) as a level-3 subsection under "== Metadata". It is not metadata, and tooling that extracts the Metadata section verbatim (the Redpanda Connect docs metadata partials) swept the whole subsection into the generated metadata reference. Promote it to a sibling "==" section so it stands on its own and no longer leaks into the metadata block.
|
|
This was referenced Jul 22, 2026
Merged
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Problem
The
csvinput'sDescription()nests=== Output CSV column order— a how-to for producing deterministic CSV output (prose + a Bloblangescape_csvexample) — as a level-3 subsection under== Metadata. It isn't metadata.Downstream tooling in the Redpanda Connect docs extracts the
== Metadatasection verbatim into a regenerated metadata reference partial, and because a level-3 heading doesn't terminate the section, the entire "Output CSV column order" subsection (including the YAML block) is swept into the generated metadata docs. See the analysis in redpanda-data/rp-connect-docs#459.Fix
Promote the heading from
=== Output CSV column orderto a sibling== Output CSV column ordersection. It's still on the csv input page, just no longer nested inside — and no longer part of the Metadata block.Note
Two connectors were found doing this; the other (
gcp_cloud_storage,=== Credentials) lives in redpanda-data/connect and is fixed there separately. A legitimate use of===under Metadata (grouping fields by operation, e.g. thenats_kvprocessor) is intentionally left as-is.