fix(gcp_cloud_storage): promote Credentials out of the Metadata section#4620
Merged
Conversation
The gcp_cloud_storage input's description nested "=== Credentials" (GCP auth guidance) as a level-3 subsection under "== Metadata". It is not metadata. Tooling that extracts the Metadata section verbatim (the docs metadata partials) swept it into the generated metadata reference. Promote it to a sibling "== Credentials" section, matching how other components document credentials, so it no longer leaks into the metadata block. Regenerated docs page updated to match.
josephwoodward
approved these changes
Jul 23, 2026
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
2 participants
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
gcp_cloud_storageinput'sDescription()nests=== Credentials(GCP auth guidance) as a level-3 subsection under== Metadata. It isn't metadata.The Redpanda Connect docs tooling extracts the
== Metadatasection verbatim into a regenerated metadata reference partial, and because a level-3 heading doesn't terminate the section, the Credentials note is swept into the generated metadata docs. See the analysis in redpanda-data/rp-connect-docs#459.Fix
Promote
=== Credentialsto a sibling== Credentialssection — matching how other components document credentials — so it terminates the Metadata block and no longer leaks into the metadata partial. Regenerateddocs/page updated to match (heading level only).Related
The other offender (
csvinput's=== Output CSV column order) lives inredpanda-data/benthosand is fixed in redpanda-data/benthos#462. A legitimate use of===under Metadata (grouping metadata fields by operation, e.g. thenats_kvprocessor) is intentionally left as-is.