DOC-1065 Enabling connectivity for cloud-based external systems #185
Conversation
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
✅ Deploy Preview for redpanda-connect ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
asimms41
commented
Mar 5, 2025
| @@ -0,0 +1,15 @@ | |||
| ifndef::env-cloud[] | |||
|
|
|||
There was a problem hiding this comment.
I've added this message to just the timeplus input for now. See page previews for cloud and non-cloud versions. I skimmed through the list but wasn't entirely sure which connectors it might apply to, it didn't seem relevant in many cases. Any guidance appreciated: https://github.com/redpanda-data/connect/blob/main/internal/plugins/info.csv
asimms41
commented
Mar 5, 2025
| @@ -0,0 +1,15 @@ | |||
| ifndef::env-cloud[] | |||
|
|
|||
| == Enable connectivity to cloud-based data sinks | |||
There was a problem hiding this comment.
I've added this message to a small set of outputs for now. Again, any guidance on which other data sinks this should be added to would be appreciated.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Description
Resolves DOC-1065
Review deadline: 10th March
Interim solution: Adding a message to alert users that they need to enable connectivity.
This pull request introduces changes to improve the documentation for external connectivity in various input and output components. The key changes include adding partials for external connectivity instructions and including these partials in the relevant documentation files.
Documentation improvements:
modules/components/pages/inputs/timeplus.adoc: Included the external connectivity instructions for inputs.modules/components/pages/outputs/elasticsearch.adoc: Included the external connectivity instructions for outputs.modules/components/pages/outputs/mongodb.adoc: Included the external connectivity instructions for outputs.modules/components/pages/outputs/snowflake_put.adoc: Included the external connectivity instructions for outputs.modules/components/pages/outputs/snowflake_streaming.adoc: Included the external connectivity instructions for outputs.Addition of external connectivity partials:
modules/components/partials/external_connectivity_inputs.adoc: Added instructions for enabling connectivity from cloud-based data sources, with different instructions for cloud and BYOC environments.modules/components/partials/external_connectivity_outputs.adoc: Added instructions for enabling connectivity to cloud-based data sinks, with different instructions for cloud and BYOC environments.Page previews
Inputs
Outputs
Checks