docs(cloudquery): correctness and completeness pass on task docs - #175
Open
aj-emerich wants to merge 1 commit into
Open
docs(cloudquery): correctness and completeness pass on task docs#175aj-emerich wants to merge 1 commit into
aj-emerich wants to merge 1 commit into
Conversation
Add the missing @PluginSubGroup title, remove a non-existent beforeCommands property from the CloudQueryCLI how-to entry, and fix the malformed multi-document YAML indentation in the CloudQueryCLI example (the --- separator and destination doc were indented under the source spec). Documentation only.
Contributor
📦 Artifacts
🧪 Java Unit Tests
🔁 Unreleased Commits1 commits since
|
Contributor
Tests report quick summary:success ✅ > tests: 3, success: 3, skipped: 0, failed: 0 unfold for details
|
Malaydewangan09
approved these changes
Jul 29, 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.
Documentation review: plugin-cloudquery
Task-level doc pass over the two tasks (
Sync,CloudQueryCLI), the sharedAbstractCloudQueryCommand,index.yaml, and the how-to doc. Documentation only; no runtime behavior changes.Fixes
package-info.java—@PluginSubGroupwas missing thetitleattribute → added"CloudQuery"(matchesindex.yaml).CloudQueryCLIentry told users to setbeforeCommands, but that is not a property on the task (thealias cloudquery=…before-command is applied internally; there is no user-settablebeforeCommands) → removed it from the list.CloudQueryCLIexample — the inlineconfig.ymlblock scalar placed the---multi-document separator and the entiredestinationdocument indented under the source'sspec. After the block scalar is de-indented, the---lands at column 2 (not a valid YAML document separator) and the destination document is nested incorrectly, so the config would fail to parse. Realigned the---and destination document to the top level of the file.Sync's two examples,AbstractCloudQueryCommand(env/docker/taskRunner/containerImage all documented,dockercorrectly marked deprecated),index.yaml, and the how-to Authentication section were all accurate. No@Metricdeclared or emitted; secrets use{{ secret('...') }}throughout. No code-level flags.