Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

(DOCSP-43962) [Kafka] Kafka connector nested components #167

Merged
merged 34 commits into from
Oct 4, 2024

Conversation

elyse-mdb
Copy link
Collaborator

@elyse-mdb elyse-mdb commented Oct 3, 2024

Unnesting components in 18 Kafka Connector pages.

This spreadsheet tracks the number of nested components on each page, and this doc provides guidelines for fixing nested components.

PR Reviewing Guidelines

DOCSP-42962

STAGING

  1. troubleshooting/recover-from-invalid-resume-token — Unnested 1 example in tip.
  2. sink-connector/configuration-properties/connector-message — Unnested 1 important admonition in table.
  3. sink-connector/configuration-properties/mongodb-connection — Unnested 1 important admonition in table include.
  4. sink-connector/configuration-properties/mongodb-namespace — Unnested 1 tip in table.
  5. sink-connector/configuration-properties/time-series — Unnested 1 important admonition in table.
  6. monitoring
  7. sink-connector/configuration-properties/topic-override — Unnested 1 example and 1 note in table.
  8. source-connector/configuration-properties/startup — Unnested 2 examples and 1 note in table.
  9. sink-connector/configuration-properties/error-handling — Unnested 2 notes in table.
  10. sink-connector/configuration-properties/post-processors — Unnested 2 tips.
  11. source-connector/configuration-properties/mongodb-connection — Unnested 2 important admonitions in table.
  12. sink-connector/configuration-properties/kafka-topic — Unnested 2 notes and 1 example in table.
  13. source-connector/configuration-properties/error-handling — Unnested 3 important admonitions.
  14. source-connector/configuration-properties/change-stream — Unnested 3 tips and 1 example in table.
  15. source-connector/configuration-properties/output-format — Unnested 1 note, 2 tips, 1 important admonition.
  16. source-connector/configuration-properties/kafka-topic — Unnested 3 tips, 1 example and 1 important admonition in table.
  17. sink-connector/configuration-properties/all-properties — Contains includes from all other pages, so unnestings all complete for the individual pages above.
  18. source-connector/configuration-properties/all-properties — Contains includes from all other pages, so unnestings all complete for the individual pages above.

Self-Review Checklist

  • Is this free of any warnings or errors in the RST?
  • Did you run a spell-check?
  • Did you run a grammar-check?
  • Are all the links working?
  • Are the facets and meta keywords accurate?

Copy link

netlify bot commented Oct 3, 2024

Deploy Preview for docs-kafka-connector ready!

Name Link
🔨 Latest commit 1eaa527
🔍 Latest deploy log https://app.netlify.com/sites/docs-kafka-connector/deploys/67003c27d84d2a00073c193c
😎 Deploy Preview https://deploy-preview-167--docs-kafka-connector.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

your proper name added 28 commits October 3, 2024 11:21
Copy link
Collaborator

@carriecwk carriecwk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM with some minor nits.

@elyse-mdb elyse-mdb merged commit e474abb into mongodb:master Oct 4, 2024
5 of 6 checks passed
elyse-mdb added a commit to elyse-mdb/docs-kafka-connector that referenced this pull request Oct 4, 2024
* (DOCSP-43962) Unnested 1 example in tip.

* (DOCSP-43962) Removing the subjunctive should

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Typo fix.

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Unnested 1 tip in table.

* (DOCSP-42962) Fixing indentation error and unnesting 1 important admonition in table.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Build errors.

* (DOCSP-42962) Unnested 1 example and 1 note in table.

* (DOCSP-42962) Unnested 2 examples and 1 note in include.

* (DOCSP-42962) Replace quotation marks with monospace.

* (DOCSP-42962) Unnested 2 notes in table.

* (DOCSP-42962) consistency.

* (DOCSP-42962) Edited for consistency and unnested 2 tips.

* (DOCSP-42962) Removing extra line breaks.

* (DOCSP-42962) Unnested 2 important admonitions in table.

* (DOCSP-42962) Fix rendering error.

* (DOCSP-42962) Fixing rendering issues.

* (DOCSP-42962) Unnested 2 notes and 1 example in table.

* (DOCSP-42962) Unnested 3 important admonitions

* (DOCSP-42962) Spacing fix.

* (DOCSP-42962) Unnested 1 example and 3 tips.

* (DOCSP-42962) Unnested 1 note, 2 tips, 1 important admonition.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing and adding reference to the Data Formats page.

* (DOCSP-42962) Unnested 3 tips, 1 example and 1 important admonition in table.

* (DOCSP-42962) Regularizing usage of pipeline operator line breaks.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing across pages.

* Update source/source-connector/configuration-properties/kafka-topic.txt

Co-authored-by: carriecwk <[email protected]>

* Update source/source-connector/configuration-properties/kafka-topic.txt

Co-authored-by: carriecwk <[email protected]>

---------

Co-authored-by: Elyse Foreman <[email protected]>
Co-authored-by: carriecwk <[email protected]>
elyse-mdb added a commit to elyse-mdb/docs-kafka-connector that referenced this pull request Oct 4, 2024
* (DOCSP-43962) Unnested 1 example in tip.

* (DOCSP-43962) Removing the subjunctive should

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Typo fix.

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Unnested 1 tip in table.

* (DOCSP-42962) Fixing indentation error and unnesting 1 important admonition in table.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Build errors.

* (DOCSP-42962) Unnested 1 example and 1 note in table.

* (DOCSP-42962) Unnested 2 examples and 1 note in include.

* (DOCSP-42962) Replace quotation marks with monospace.

* (DOCSP-42962) Unnested 2 notes in table.

* (DOCSP-42962) consistency.

* (DOCSP-42962) Edited for consistency and unnested 2 tips.

* (DOCSP-42962) Removing extra line breaks.

* (DOCSP-42962) Unnested 2 important admonitions in table.

* (DOCSP-42962) Fix rendering error.

* (DOCSP-42962) Fixing rendering issues.

* (DOCSP-42962) Unnested 2 notes and 1 example in table.

* (DOCSP-42962) Unnested 3 important admonitions

* (DOCSP-42962) Spacing fix.

* (DOCSP-42962) Unnested 1 example and 3 tips.

* (DOCSP-42962) Unnested 1 note, 2 tips, 1 important admonition.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing and adding reference to the Data Formats page.

* (DOCSP-42962) Unnested 3 tips, 1 example and 1 important admonition in table.

* (DOCSP-42962) Regularizing usage of pipeline operator line breaks.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing across pages.

* Update source/source-connector/configuration-properties/kafka-topic.txt

Co-authored-by: carriecwk <[email protected]>

* Update source/source-connector/configuration-properties/kafka-topic.txt

Co-authored-by: carriecwk <[email protected]>

---------

Co-authored-by: Elyse Foreman <[email protected]>
Co-authored-by: carriecwk <[email protected]>
elyse-mdb added a commit that referenced this pull request Oct 4, 2024
* (DOCSP-43962) [Kafka] Kafka connector nested components (#167)

* (DOCSP-43962) Unnested 1 example in tip.

* (DOCSP-43962) Removing the subjunctive should

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Typo fix.

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Unnested 1 tip in table.

* (DOCSP-42962) Fixing indentation error and unnesting 1 important admonition in table.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Build errors.

* (DOCSP-42962) Unnested 1 example and 1 note in table.

* (DOCSP-42962) Unnested 2 examples and 1 note in include.

* (DOCSP-42962) Replace quotation marks with monospace.

* (DOCSP-42962) Unnested 2 notes in table.

* (DOCSP-42962) consistency.

* (DOCSP-42962) Edited for consistency and unnested 2 tips.

* (DOCSP-42962) Removing extra line breaks.

* (DOCSP-42962) Unnested 2 important admonitions in table.

* (DOCSP-42962) Fix rendering error.

* (DOCSP-42962) Fixing rendering issues.

* (DOCSP-42962) Unnested 2 notes and 1 example in table.

* (DOCSP-42962) Unnested 3 important admonitions

* (DOCSP-42962) Spacing fix.

* (DOCSP-42962) Unnested 1 example and 3 tips.

* (DOCSP-42962) Unnested 1 note, 2 tips, 1 important admonition.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing and adding reference to the Data Formats page.

* (DOCSP-42962) Unnested 3 tips, 1 example and 1 important admonition in table.

* (DOCSP-42962) Regularizing usage of pipeline operator line breaks.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing across pages.

* Update source/source-connector/configuration-properties/kafka-topic.txt

Co-authored-by: carriecwk <[email protected]>

* Update source/source-connector/configuration-properties/kafka-topic.txt

Co-authored-by: carriecwk <[email protected]>

---------

Co-authored-by: Elyse Foreman <[email protected]>
Co-authored-by: carriecwk <[email protected]>

* (DOCSP-42962-v110-backport) Build error fix.

---------

Co-authored-by: carriecwk <[email protected]>
Co-authored-by: your proper name <your github email>
elyse-mdb added a commit that referenced this pull request Oct 4, 2024
* (DOCSP-43962) Unnested 1 example in tip.

* (DOCSP-43962) Removing the subjunctive should

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Typo fix.

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Unnested 1 tip in table.

* (DOCSP-42962) Fixing indentation error and unnesting 1 important admonition in table.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Build errors.

* (DOCSP-42962) Unnested 1 example and 1 note in table.

* (DOCSP-42962) Unnested 2 examples and 1 note in include.

* (DOCSP-42962) Replace quotation marks with monospace.

* (DOCSP-42962) Unnested 2 notes in table.

* (DOCSP-42962) consistency.

* (DOCSP-42962) Edited for consistency and unnested 2 tips.

* (DOCSP-42962) Removing extra line breaks.

* (DOCSP-42962) Unnested 2 important admonitions in table.

* (DOCSP-42962) Fix rendering error.

* (DOCSP-42962) Fixing rendering issues.

* (DOCSP-42962) Unnested 2 notes and 1 example in table.

* (DOCSP-42962) Unnested 3 important admonitions

* (DOCSP-42962) Spacing fix.

* (DOCSP-42962) Unnested 1 example and 3 tips.

* (DOCSP-42962) Unnested 1 note, 2 tips, 1 important admonition.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing and adding reference to the Data Formats page.

* (DOCSP-42962) Unnested 3 tips, 1 example and 1 important admonition in table.

* (DOCSP-42962) Regularizing usage of pipeline operator line breaks.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing across pages.

* Update source/source-connector/configuration-properties/kafka-topic.txt



* Update source/source-connector/configuration-properties/kafka-topic.txt



---------

Co-authored-by: carriecwk <[email protected]>
elyse-mdb added a commit to elyse-mdb/docs-kafka-connector that referenced this pull request Oct 4, 2024
* (DOCSP-43962) Unnested 1 example in tip.

* (DOCSP-43962) Removing the subjunctive should

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Typo fix.

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Unnested 1 tip in table.

* (DOCSP-42962) Fixing indentation error and unnesting 1 important admonition in table.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Build errors.

* (DOCSP-42962) Unnested 1 example and 1 note in table.

* (DOCSP-42962) Unnested 2 examples and 1 note in include.

* (DOCSP-42962) Replace quotation marks with monospace.

* (DOCSP-42962) Unnested 2 notes in table.

* (DOCSP-42962) consistency.

* (DOCSP-42962) Edited for consistency and unnested 2 tips.

* (DOCSP-42962) Removing extra line breaks.

* (DOCSP-42962) Unnested 2 important admonitions in table.

* (DOCSP-42962) Fix rendering error.

* (DOCSP-42962) Fixing rendering issues.

* (DOCSP-42962) Unnested 2 notes and 1 example in table.

* (DOCSP-42962) Unnested 3 important admonitions

* (DOCSP-42962) Spacing fix.

* (DOCSP-42962) Unnested 1 example and 3 tips.

* (DOCSP-42962) Unnested 1 note, 2 tips, 1 important admonition.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing and adding reference to the Data Formats page.

* (DOCSP-42962) Unnested 3 tips, 1 example and 1 important admonition in table.

* (DOCSP-42962) Regularizing usage of pipeline operator line breaks.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing across pages.

* Update source/source-connector/configuration-properties/kafka-topic.txt

Co-authored-by: carriecwk <[email protected]>

* Update source/source-connector/configuration-properties/kafka-topic.txt

Co-authored-by: carriecwk <[email protected]>

---------

Co-authored-by: Elyse Foreman <[email protected]>
Co-authored-by: carriecwk <[email protected]>
elyse-mdb added a commit to elyse-mdb/docs-kafka-connector that referenced this pull request Oct 4, 2024
* (DOCSP-43962) Unnested 1 example in tip.

* (DOCSP-43962) Removing the subjunctive should

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Typo fix.

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Unnested 1 tip in table.

* (DOCSP-42962) Fixing indentation error and unnesting 1 important admonition in table.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Build errors.

* (DOCSP-42962) Unnested 1 example and 1 note in table.

* (DOCSP-42962) Unnested 2 examples and 1 note in include.

* (DOCSP-42962) Replace quotation marks with monospace.

* (DOCSP-42962) Unnested 2 notes in table.

* (DOCSP-42962) consistency.

* (DOCSP-42962) Edited for consistency and unnested 2 tips.

* (DOCSP-42962) Removing extra line breaks.

* (DOCSP-42962) Unnested 2 important admonitions in table.

* (DOCSP-42962) Fix rendering error.

* (DOCSP-42962) Fixing rendering issues.

* (DOCSP-42962) Unnested 2 notes and 1 example in table.

* (DOCSP-42962) Unnested 3 important admonitions

* (DOCSP-42962) Spacing fix.

* (DOCSP-42962) Unnested 1 example and 3 tips.

* (DOCSP-42962) Unnested 1 note, 2 tips, 1 important admonition.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing and adding reference to the Data Formats page.

* (DOCSP-42962) Unnested 3 tips, 1 example and 1 important admonition in table.

* (DOCSP-42962) Regularizing usage of pipeline operator line breaks.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing across pages.

* Update source/source-connector/configuration-properties/kafka-topic.txt

Co-authored-by: carriecwk <[email protected]>

* Update source/source-connector/configuration-properties/kafka-topic.txt

Co-authored-by: carriecwk <[email protected]>

---------

Co-authored-by: Elyse Foreman <[email protected]>
Co-authored-by: carriecwk <[email protected]>
elyse-mdb added a commit that referenced this pull request Oct 4, 2024
* (DOCSP-43962) Unnested 1 example in tip.

* (DOCSP-43962) Removing the subjunctive should

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Typo fix.

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Unnested 1 tip in table.

* (DOCSP-42962) Fixing indentation error and unnesting 1 important admonition in table.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Build errors.

* (DOCSP-42962) Unnested 1 example and 1 note in table.

* (DOCSP-42962) Unnested 2 examples and 1 note in include.

* (DOCSP-42962) Replace quotation marks with monospace.

* (DOCSP-42962) Unnested 2 notes in table.

* (DOCSP-42962) consistency.

* (DOCSP-42962) Edited for consistency and unnested 2 tips.

* (DOCSP-42962) Removing extra line breaks.

* (DOCSP-42962) Unnested 2 important admonitions in table.

* (DOCSP-42962) Fix rendering error.

* (DOCSP-42962) Fixing rendering issues.

* (DOCSP-42962) Unnested 2 notes and 1 example in table.

* (DOCSP-42962) Unnested 3 important admonitions

* (DOCSP-42962) Spacing fix.

* (DOCSP-42962) Unnested 1 example and 3 tips.

* (DOCSP-42962) Unnested 1 note, 2 tips, 1 important admonition.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing and adding reference to the Data Formats page.

* (DOCSP-42962) Unnested 3 tips, 1 example and 1 important admonition in table.

* (DOCSP-42962) Regularizing usage of pipeline operator line breaks.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing across pages.

* Update source/source-connector/configuration-properties/kafka-topic.txt



* Update source/source-connector/configuration-properties/kafka-topic.txt



---------

Co-authored-by: carriecwk <[email protected]>
elyse-mdb added a commit that referenced this pull request Oct 4, 2024
* (DOCSP-43962) Unnested 1 example in tip.

* (DOCSP-43962) Removing the subjunctive should

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Typo fix.

* (DOCSP-42962) Unnested 1 important admonition in table.

* (DOCSP-42962) Unnested 1 tip in table.

* (DOCSP-42962) Fixing indentation error and unnesting 1 important admonition in table.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Build errors.

* (DOCSP-42962) Unnested 1 example and 1 note in table.

* (DOCSP-42962) Unnested 2 examples and 1 note in include.

* (DOCSP-42962) Replace quotation marks with monospace.

* (DOCSP-42962) Unnested 2 notes in table.

* (DOCSP-42962) consistency.

* (DOCSP-42962) Edited for consistency and unnested 2 tips.

* (DOCSP-42962) Removing extra line breaks.

* (DOCSP-42962) Unnested 2 important admonitions in table.

* (DOCSP-42962) Fix rendering error.

* (DOCSP-42962) Fixing rendering issues.

* (DOCSP-42962) Unnested 2 notes and 1 example in table.

* (DOCSP-42962) Unnested 3 important admonitions

* (DOCSP-42962) Spacing fix.

* (DOCSP-42962) Unnested 1 example and 3 tips.

* (DOCSP-42962) Unnested 1 note, 2 tips, 1 important admonition.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing and adding reference to the Data Formats page.

* (DOCSP-42962) Unnested 3 tips, 1 example and 1 important admonition in table.

* (DOCSP-42962) Regularizing usage of pipeline operator line breaks.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Spacing.

* (DOCSP-42962) Normalizing spacing across pages.

* Update source/source-connector/configuration-properties/kafka-topic.txt



* Update source/source-connector/configuration-properties/kafka-topic.txt



---------

Co-authored-by: carriecwk <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants