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

Author: rustagir

source/compatibility.txt

@@ -4,8 +4,6 @@
 Compatibility
 =============
 
-.. default-domain:: mongodb
-
 MongoDB Compatibility
 ---------------------
 

source/contribute.txt

@@ -1,3 +1,5 @@
+.. _kafka-community-contributions:
+
 =================
 How to Contribute
 =================

source/index.txt

@@ -1,13 +1,10 @@
 .. _kafka:
-
 .. _kafka-connector-landing:
 
 =======================
 MongoDB Kafka Connector
 =======================
 
-.. default-domain:: mongodb
-
 .. toctree::
    :titlesonly:
    :maxdepth: 1
@@ -29,25 +26,92 @@ MongoDB Kafka Connector
 Overview
 --------
 
-The `MongoDB Kafka connector <https://www.mongodb.com/kafka-connector>`__ is
-a Confluent-verified connector that persists data from Kafka topics as a
+The `{+connector-long+} <https://www.mongodb.com/kafka-connector>`__ is
+a Confluent-verified connector that persists data from {+kafka+} topics as a
 data sink into MongoDB as well as publishes changes from MongoDB into Kafka
 topics as a data source.
 
-This guide provides information on available configuration options and
-examples to help you complete your implementation in the following
-sections:
-
-- :doc:`What's New </whats-new>`
-- :doc:`Quick Start </quick-start>`
-- :doc:`Introduction </introduction>`
-- :doc:`Tutorials </tutorials>`
-- :doc:`Sink Connector </sink-connector>`
-- :doc:`Source Connector </source-connector>`
-- :doc:`Security and Authentication </security-and-authentication>`
-- :doc:`Monitoring </monitoring>`
-- :doc:`Migrate from the Community Connector </migrate-from-kafka-connect-mongodb>`
-- :doc:`Troubleshooting </troubleshooting>`
-- :doc:`How to Contribute </contribute>`
-- :doc:`Issues & Help </issues-and-help>`
-- :doc:`Compatibility </compatibility>`
+What's New
+----------
+
+For a list of new features and changes in each version, see the
+:ref:`kafka-connector-whats-new` section.
+
+Quick Start
+-----------
+
+Learn how to get started with the {+connector+} and begin working with data
+in the :ref:`kafka-quick-start` section.
+
+Introduction
+------------
+
+Learn about and how the {+connector+} passes data between {+kafka+}
+and MongoDB in the :ref:`kafka-connector-introduction` section. In this
+section, you can also learn about how to install the connector and
+configure it to connect to your MongoDB deployment.
+
+Tutorials
+---------
+
+Follow :ref:`tutorials <kafka-connector-tutorials>` to learn how to set
+up the {+connector+} to read and write data for several use cases.
+
+Sink Connector
+--------------
+
+Learn how to configure how the {+sink-connector+} writes data from
+{+kafka+} into MongoDB in the :ref:`kafka-sink-overview` section.
+
+Source Connector
+----------------
+
+Learn how to configure how the {+source-connector+} writes data from
+MongoDB into {+kafka+} in the :ref:`kafka-source-overview` section.
+
+Security and Authentication
+---------------------------
+
+Learn how to secure communications between MongoDB and the
+{+connector+} in the :ref:`kafka-connector-security-auth` section. In this
+section, you can also learn how to configure the {+connector+} to
+authenticate to MongoDB with your AWS Identity and IAM credentials.
+
+Monitoring
+----------
+
+Learn how to monitor your MongoDB Kafka source and sink connectors in
+the :ref:`kafka-monitoring` section.
+
+Migrate from the Community Connector
+------------------------------------
+
+Learn how to to migrate from the legacy Kafka Connect MongoDB
+sink connector to the official {+connector+} in the
+:ref:`Migration Guide <migrate-from-kafka-connect-mongodb>`.
+
+Troubleshooting
+---------------
+
+Learn how to resolve issues you may encounter while running the
+{+connector+} in the :ref:`kafka-troubleshooting` section.
+
+How to Contribute
+-----------------
+
+Learn how to contribute to the {+connector+} codebase in
+the :ref:`kafka-community-contributions` section.
+
+Issues & Help
+-------------
+
+Learn how to report bugs and request features in the
+:ref:`kafka-issues-help` section.
+
+Compatibility
+-------------
+
+For information about compatibility between the {+connector+} and
+MongoDB, see the :ref:`kafka-compatibility` section. In this section,
+you can also learn about compatibility between the {+connector+} and
+{+kafka-connect-long+}.

source/introduction.txt

@@ -1,3 +1,5 @@
+.. _kafka-connector-introduction:
+
 ============
 Introduction
 ============

source/introduction/connect.txt

@@ -4,8 +4,6 @@
 Connect to MongoDB
 ==================
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none

source/introduction/converters.txt

@@ -4,8 +4,6 @@
 Converters
 ==========
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none

source/introduction/data-formats.txt

@@ -2,8 +2,6 @@
 Data Formats
 ============
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none

source/introduction/install.txt

@@ -4,8 +4,6 @@
 Install the MongoDB Kafka Connector
 ===================================
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none

source/introduction/kafka-connect.txt

@@ -4,8 +4,6 @@
 Kafka and Kafka Connect
 =======================
 
-.. default-domain:: mongodb
-
 .. contents:: On this page
    :local:
    :backlinks: none

source/issues-and-help.txt

@@ -1,9 +1,9 @@
+.. _kafka-issues-help:
+
 =============
 Issues & Help
 =============
 
-.. default-domain:: mongodb
-
 Often, the quickest way to get support for general questions is through the
 `MongoDB Community Forums <https://www.mongodb.com/community/forums/tags/c/connectors-integrations/48/kafka-connector>`__.
 
@@ -25,18 +25,3 @@ Bug reports in JIRA for the Kafka Connector project are **public**.
 If you've identified a security vulnerability in the connector or any other
 MongoDB project, please report it according to the instructions found in the
 :manual:`Create a Vulnerability Report </tutorial/create-a-vulnerability-report>`.
-
-Pull Requests
--------------
-
-We're happy to accept contributions to help improve the connector. We
-will review user contributions to ensure they meet the standards of the
-codebase. 
-
-To get started check out the source and work on a branch:
-
-.. code-block:: bash
-
-   git clone https://github.com/mongodb/mongo-kafka.git
-   cd mongo-kafka
-   git checkout -b myNewFeature