Skip to content

Commit 85ca8d9

Browse files
rustagirrustagir
authored
DOCSP-30019: add detail to index + some other cleanup (#115)
* DOCSP-30019: add detail to kafka index + some other cleanup * first pass fixes * CC PR fixes 1 * CC suggestions
1 parent fe32d11 commit 85ca8d9

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

55 files changed

+98
-137
lines changed

‎source/compatibility.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
Compatibility
55
=============
66

7-
.. default-domain:: mongodb
8-
97
MongoDB Compatibility
108
---------------------
119

‎source/contribute.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _kafka-community-contributions:
2+
13
=================
24
How to Contribute
35
=================

‎source/index.txt

Lines changed: 86 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,10 @@
11
.. _kafka:
2-
32
.. _kafka-connector-landing:
43

54
=======================
65
MongoDB Kafka Connector
76
=======================
87

9-
.. default-domain:: mongodb
10-
118
.. toctree::
129
:titlesonly:
1310
:maxdepth: 1
@@ -29,25 +26,92 @@ MongoDB Kafka Connector
2926
Overview
3027
--------
3128

32-
The `MongoDB Kafka connector <https://www.mongodb.com/kafka-connector>`__ is
33-
a Confluent-verified connector that persists data from Kafka topics as a
29+
The `{+connector-long+} <https://www.mongodb.com/kafka-connector>`__ is
30+
a Confluent-verified connector that persists data from {+kafka+} topics as a
3431
data sink into MongoDB as well as publishes changes from MongoDB into Kafka
3532
topics as a data source.
3633

37-
This guide provides information on available configuration options and
38-
examples to help you complete your implementation in the following
39-
sections:
40-
41-
- :doc:`What's New </whats-new>`
42-
- :doc:`Quick Start </quick-start>`
43-
- :doc:`Introduction </introduction>`
44-
- :doc:`Tutorials </tutorials>`
45-
- :doc:`Sink Connector </sink-connector>`
46-
- :doc:`Source Connector </source-connector>`
47-
- :doc:`Security and Authentication </security-and-authentication>`
48-
- :doc:`Monitoring </monitoring>`
49-
- :doc:`Migrate from the Community Connector </migrate-from-kafka-connect-mongodb>`
50-
- :doc:`Troubleshooting </troubleshooting>`
51-
- :doc:`How to Contribute </contribute>`
52-
- :doc:`Issues & Help </issues-and-help>`
53-
- :doc:`Compatibility </compatibility>`
34+
What's New
35+
----------
36+
37+
For a list of new features and changes in each version, see the
38+
:ref:`kafka-connector-whats-new` section.
39+
40+
Quick Start
41+
-----------
42+
43+
Learn how to get started with the {+connector+} and begin working with data
44+
in the :ref:`kafka-quick-start` section.
45+
46+
Introduction
47+
------------
48+
49+
Learn about and how the {+connector+} passes data between {+kafka+}
50+
and MongoDB in the :ref:`kafka-connector-introduction` section. In this
51+
section, you can also learn about how to install the connector and
52+
configure it to connect to your MongoDB deployment.
53+
54+
Tutorials
55+
---------
56+
57+
Follow :ref:`tutorials <kafka-connector-tutorials>` to learn how to set
58+
up the {+connector+} to read and write data for several use cases.
59+
60+
Sink Connector
61+
--------------
62+
63+
Learn how to configure how the {+sink-connector+} writes data from
64+
{+kafka+} into MongoDB in the :ref:`kafka-sink-overview` section.
65+
66+
Source Connector
67+
----------------
68+
69+
Learn how to configure how the {+source-connector+} writes data from
70+
MongoDB into {+kafka+} in the :ref:`kafka-source-overview` section.
71+
72+
Security and Authentication
73+
---------------------------
74+
75+
Learn how to secure communications between MongoDB and the
76+
{+connector+} in the :ref:`kafka-connector-security-auth` section. In this
77+
section, you can also learn how to configure the {+connector+} to
78+
authenticate to MongoDB with your AWS Identity and IAM credentials.
79+
80+
Monitoring
81+
----------
82+
83+
Learn how to monitor your MongoDB Kafka source and sink connectors in
84+
the :ref:`kafka-monitoring` section.
85+
86+
Migrate from the Community Connector
87+
------------------------------------
88+
89+
Learn how to to migrate from the legacy Kafka Connect MongoDB
90+
sink connector to the official {+connector+} in the
91+
:ref:`Migration Guide <migrate-from-kafka-connect-mongodb>`.
92+
93+
Troubleshooting
94+
---------------
95+
96+
Learn how to resolve issues you may encounter while running the
97+
{+connector+} in the :ref:`kafka-troubleshooting` section.
98+
99+
How to Contribute
100+
-----------------
101+
102+
Learn how to contribute to the {+connector+} codebase in
103+
the :ref:`kafka-community-contributions` section.
104+
105+
Issues & Help
106+
-------------
107+
108+
Learn how to report bugs and request features in the
109+
:ref:`kafka-issues-help` section.
110+
111+
Compatibility
112+
-------------
113+
114+
For information about compatibility between the {+connector+} and
115+
MongoDB, see the :ref:`kafka-compatibility` section. In this section,
116+
you can also learn about compatibility between the {+connector+} and
117+
{+kafka-connect-long+}.

‎source/introduction.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _kafka-connector-introduction:
2+
13
============
24
Introduction
35
============

‎source/introduction/connect.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
Connect to MongoDB
55
==================
66

7-
.. default-domain:: mongodb
8-
97
.. contents:: On this page
108
:local:
119
:backlinks: none

‎source/introduction/converters.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
Converters
55
==========
66

7-
.. default-domain:: mongodb
8-
97
.. contents:: On this page
108
:local:
119
:backlinks: none

‎source/introduction/data-formats.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,6 @@
22
Data Formats
33
============
44

5-
.. default-domain:: mongodb
6-
75
.. contents:: On this page
86
:local:
97
:backlinks: none

‎source/introduction/install.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
Install the MongoDB Kafka Connector
55
===================================
66

7-
.. default-domain:: mongodb
8-
97
.. contents:: On this page
108
:local:
119
:backlinks: none

‎source/introduction/kafka-connect.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,6 @@
44
Kafka and Kafka Connect
55
=======================
66

7-
.. default-domain:: mongodb
8-
97
.. contents:: On this page
108
:local:
119
:backlinks: none

‎source/issues-and-help.txt

Lines changed: 2 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,9 @@
1+
.. _kafka-issues-help:
2+
13
=============
24
Issues & Help
35
=============
46

5-
.. default-domain:: mongodb
6-
77
Often, the quickest way to get support for general questions is through the
88
`MongoDB Community Forums <https://www.mongodb.com/community/forums/tags/c/connectors-integrations/48/kafka-connector>`__.
99

@@ -25,18 +25,3 @@ Bug reports in JIRA for the Kafka Connector project are **public**.
2525
If you've identified a security vulnerability in the connector or any other
2626
MongoDB project, please report it according to the instructions found in the
2727
:manual:`Create a Vulnerability Report </tutorial/create-a-vulnerability-report>`.
28-
29-
Pull Requests
30-
-------------
31-
32-
We're happy to accept contributions to help improve the connector. We
33-
will review user contributions to ensure they meet the standards of the
34-
codebase.
35-
36-
To get started check out the source and work on a branch:
37-
38-
.. code-block:: bash
39-
40-
git clone https://github.com/mongodb/mongo-kafka.git
41-
cd mongo-kafka
42-
git checkout -b myNewFeature

0 commit comments

Comments
 (0)