Skip to content

Commit 70759a3

Browse files
Chris Choschmalliso
authored andcommitted
DOCSP-15819: troubleshooting overview (#189)
* DOCSP-15819: troubleshooting landing page
1 parent 4b1c53e commit 70759a3

File tree

4 files changed

+10
-7
lines changed

4 files changed

+10
-7
lines changed

snooty.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "kafka-connector"
22
title = "MongoDB Kafka Connector"
33
intersphinx = ["https://docs.mongodb.com/manual/objects.inv"]
4-
toc_landing_pages = ["/sink-connector", "/source-connector", "/sink-connector/configuration-properties", "/source-connector/configuration-properties", "/security-and-authentication"]
4+
toc_landing_pages = ["/sink-connector", "/source-connector", "/sink-connector/configuration-properties", "/source-connector/configuration-properties", "/security-and-authentication", "/troubleshooting"]
55

66
[constants]
77
mkc = "MongoDB Kafka Connector"

source/source-connector/fundamentals/change-streams.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ Resume Tokens
105105
Your connector uses a **resume token** as its **offset**. An offset is a value
106106
your connector stores in an {+ak+} topic to keep track of what source data it
107107
has processed. Your connector uses its offset value when it must recover from
108-
a restart or crash. A resume token is a piece of data that references the
108+
a restart or crash. A resume token is a piece of data that references the
109109
``_id`` field of a change event document in your MongoDB oplog.
110110

111111
If your source connector does not have an offset, such as when you start
@@ -116,8 +116,8 @@ its offset.
116116

117117
If the resume token value of your source connector's offset does not correspond to
118118
any entry in your MongoDB deployment's oplog, your connector has an invalid resume
119-
token. To learn how to recover from an invalid resume token,
120-
:ref:`see our troubleshooting guide <kafka-troubleshoot-recover-invalid-resume-token>`.
119+
token. To learn how to recover from an invalid resume token, see the
120+
:ref:`invalid token troubleshooting guide <kafka-troubleshoot-invalid-resume-token>`.
121121

122122
To learn more about resume tokens, see the following resources:
123123

source/troubleshooting.txt

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,5 +5,10 @@ Troubleshooting
55
.. toctree::
66
:titlesonly:
77
:maxdepth: 1
8-
8+
99
Invalid Resume Token </troubleshooting/recover-from-invalid-resume-token.txt>
10+
11+
Learn how to address issues you may encounter while running the {+mkc+}.
12+
13+
- :ref:`<kafka-troubleshoot-invalid-resume-token>`
14+

source/troubleshooting/recover-from-invalid-resume-token.txt

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,6 @@ Invalid Resume Token
1313
:class: singlecol
1414

1515

16-
.. _kafka-troubleshoot-recover-invalid-resume-token:
17-
1816
Overview
1917
--------
2018

0 commit comments

Comments
 (0)