chore: Update Docs URLs#22943
Open
stoovon wants to merge 3 commits into
Open
Conversation
There was a problem hiding this comment.
Pull request overview
Updates plugin documentation (and a few embedded schema/comment strings) to use the latest CloudQuery docs URL conventions, primarily moving from relative /docs/... links to https://www.cloudquery.io/... links across source and destination plugins. However, this PR also removes several Go imports that are still required by the code, which will break compilation.
Changes:
- Replace relative docs links (
/docs/...) with canonicalhttps://www.cloudquery.io/docs/...URLs across many plugin docs. - Update some Hub-related links (e.g., destination list / tables pages) to
https://www.cloudquery.io/hub/.... - Update embedded JSON schema descriptions and Go struct comments to use the new URL format (but introduces compile-breaking import removals in a few Go files).
Reviewed changes
Copilot reviewed 39 out of 39 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
| plugins/source/xkcd/docs/overview.md | Switch Source Spec / Quickstart links to cloudquery.io docs URLs. |
| plugins/source/typeform/docs/overview.md | Update tables + Source Spec Reference links to cloudquery.io URLs. |
| plugins/source/square/docs/overview.md | Update tables + Source Spec Reference links to cloudquery.io URLs. |
| plugins/source/hackernews/docs/overview.md | Update destination + incremental/state management + source spec docs links to cloudquery.io URLs. |
| plugins/source/bitbucket/docs/overview.md | Update Source Spec Reference link to cloudquery.io URL. |
| plugins/source/airtable/docs/overview.md | Update Source Spec Reference link to cloudquery.io URL. |
| plugins/destination/snowflake/docs/overview.md | Update batching parameter links to cloudquery.io docs URLs. |
| plugins/destination/s3/docs/_configuration.md | Update Destination Spec Reference links to cloudquery.io docs URLs. |
| plugins/destination/postgresql/docs/overview.md | Update Destination Spec Reference + batching parameter links to cloudquery.io docs URLs. |
| plugins/destination/neo4j/docs/types.md | Update Arrow string representation link to cloudquery.io docs URL. |
| plugins/destination/neo4j/docs/overview.md | Update Destination Spec Reference + batching parameter links to cloudquery.io docs URLs. |
| plugins/destination/mysql/docs/example.md | Update Destination Spec Reference + env var expansion links to cloudquery.io docs URLs. |
| plugins/destination/mysql/docs/configuration.md | Update batching parameter links to cloudquery.io docs URLs. |
| plugins/destination/mssql/docs/example.md | Update Destination Spec Reference link to cloudquery.io docs URL. |
| plugins/destination/mssql/docs/configuration.md | Update env var expansion + batching parameter links to cloudquery.io docs URLs. |
| plugins/destination/mongodb/docs/overview.md | Update env var substitution + batching parameter links to cloudquery.io docs URLs. |
| plugins/destination/mongodb/docs/_configuration.md | Update Destination Spec Reference link to cloudquery.io docs URL. |
| plugins/destination/meilisearch/docs/overview.md | Update source plugin + batching/write_mode + file substitution links to cloudquery.io URLs. |
| plugins/destination/meilisearch/client/spec.go | Update comment URL (but also removes a required Go import). |
| plugins/destination/meilisearch/client/schema.json | Update schema description URL to cloudquery.io docs URL. |
| plugins/destination/kafka/docs/_configuration.md | Update Destination Spec Reference links to cloudquery.io docs URLs. |
| plugins/destination/gremlin/docs/types.md | Update Arrow string representation link to cloudquery.io docs URL. |
| plugins/destination/gremlin/docs/overview.md | Update Destination Spec Reference + batching parameter links to cloudquery.io docs URLs. |
| plugins/destination/gcs/docs/_configuration.md | Update Destination Spec Reference link to cloudquery.io docs URL. |
| plugins/destination/gcs/client/spec/spec.go | Update comment URL (but also removes a required Go import). |
| plugins/destination/gcs/client/spec/schema.json | Update schema description URL to cloudquery.io docs URL. |
| plugins/destination/firehose/docs/overview.md | Update Destination Spec Reference + batching parameter links to cloudquery.io docs URLs. |
| plugins/destination/file/docs/overview.md | Update S3/GCS/Azblob destination links to Hub cloudquery.io URLs. |
| plugins/destination/file/docs/_configuration.md | Update Destination Spec Reference link to cloudquery.io docs URL. |
| plugins/destination/elasticsearch/docs/overview.md | Update batching + file substitution links to cloudquery.io docs URLs. |
| plugins/destination/clickhouse/docs/overview.md | Update write_mode + file substitution links to cloudquery.io docs URLs. |
| plugins/destination/clickhouse/docs/_configuration.md | Update Destination Spec Reference link to cloudquery.io docs URL. |
| plugins/destination/clickhouse/client/spec/spec.go | Update comment URL (but also removes a required Go import). |
| plugins/destination/clickhouse/client/spec/schema.json | Update schema description URL to cloudquery.io docs URL. |
| plugins/destination/clickhouse/CHANGELOG.md | Update changelog link to cloudquery.io docs URL. |
| plugins/destination/bigquery/docs/overview.md | Update batching + env/file substitution links to cloudquery.io docs URLs. |
| plugins/destination/bigquery/client/spec.go | Update comment URL to cloudquery.io docs URL. |
| plugins/destination/bigquery/client/schema.json | Update schema description URL to cloudquery.io docs URL. |
| plugins/destination/azblob/docs/overview.md | Update Destination Spec Reference link to cloudquery.io docs URL. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Update docs to match latest conventions. Context: Linear 6955
da6fd1c to
bf027a4
Compare
Revert the doc-URL edits for the airtable and azblob (Azure Blob Storage) plugins back to pre-PR content. airtable's pnpm-lock.yaml is broken on main (frozen-lockfile fails) and azblob's CI workflow is broken — both unrelated to this docs change. Dropping these two keeps the remaining 37-file URL update unblocked.
"The plugin discover" -> "The plugin discovers" in plugins/source/bitbucket/docs/overview.md.
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.
Summary
Update docs to match latest conventions.
Context: Linear 6955