Skip to content

Commit 88af8f0

Browse files
eric-schneidereric-schneider
committed
Update nav format
1 parent 6202e84 commit 88af8f0

16 files changed

+96
-91
lines changed

‎docs-src/pulsar-sink-core/modules/ROOT/nav.adoc

Lines changed: 54 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,54 +1,61 @@
1-
.Getting Started
2-
** xref:index.adoc[]
3-
** xref:pulsarSizing.adoc[]
4-
** link:https://github.com/datastax/release-notes/blob/master/DataStax_Apache_Pulsar_Connector_1.4_Release_Notes.md[Pulsar Connector release notes]
5-
** xref:pulsarInstall.adoc[]
6-
** xref:pulsarQuickStart.adoc[]
1+
.Get started
2+
* xref:pulsarSizing.adoc[]
3+
* xref:pulsarInstall.adoc[]
4+
* xref:pulsarQuickStart.adoc[]
5+
* https://github.com/datastax/release-notes/blob/master/DataStax_Apache_Pulsar_Connector_1.4_Release_Notes.md[Release notes]
76
87
.Guides and examples
9-
** Configuration
10-
*** xref:cfgPulsarConfigTasksMax.adoc[]
11-
*** xref:cfgPulsarColumnWritetimeTimestamp.adoc[]
12-
*** xref:cfgPulsarSettingRowLevelTtl.adoc[]
13-
*** xref:cfgPulsarSettingJavaDriverConfig.adoc[]
8+
* Configuration
9+
** xref:cfgPulsarConfigTasksMax.adoc[]
10+
** xref:cfgPulsarColumnWritetimeTimestamp.adoc[]
11+
** xref:cfgPulsarSettingRowLevelTtl.adoc[]
12+
** xref:cfgPulsarSettingJavaDriverConfig.adoc[]
13+
** Mapping Pulsar topics to database tables
1414
*** xref:cfgPulsarMapTopicTable.adoc[]
15-
**** xref:cfgPulsarDisplayingTopic.adoc[]
16-
**** xref:cfgPulsarMapKeyPair.adoc[]
15+
*** xref:cfgPulsarDisplayingTopic.adoc[]
16+
*** xref:cfgPulsarMapKeyPair.adoc[]
17+
*** Mapping a message that contains JSON fields
1718
**** xref:cfgPulsarMapJson.adoc[]
18-
***** xref:cfgPulsarStringJson.adoc[]
19-
***** xref:cfgPulsarJsonMessageSchema.adoc[]
20-
**** xref:cfgPulsarMapAvroMessages.adoc[]
21-
**** xref:cfgPulsarRecordHeaderToTable.adoc[]
22-
**** xref:cfgPulsarMapUdt.adoc[]
23-
**** xref:cfgPulsarMapMultipleTables.adoc[]
24-
**** xref:cfgPulsarMultTopicToTables.adoc[]
25-
**** xref:cfgPulsarCqlQuery.adoc[]
26-
**** xref:cfgPulsarNowFunction.adoc[]
27-
** Operations
28-
*** xref:opsPulsarAboutOperations.adoc[]
29-
*** xref:opsPulsarScaling.adoc[]
19+
**** xref:cfgPulsarStringJson.adoc[]
20+
**** xref:cfgPulsarJsonMessageSchema.adoc[]
21+
*** xref:cfgPulsarMapAvroMessages.adoc[]
22+
*** xref:cfgPulsarRecordHeaderToTable.adoc[]
23+
*** xref:cfgPulsarMapUdt.adoc[]
24+
*** xref:cfgPulsarMapMultipleTables.adoc[]
25+
*** xref:cfgPulsarMultTopicToTables.adoc[]
26+
*** xref:cfgPulsarSelectiveUpdateMapsAndUdts.adoc[]
27+
*** xref:cfgPulsarCqlQuery.adoc[]
28+
*** xref:cfgPulsarNowFunction.adoc[]
29+
* Operations
30+
** xref:opsPulsarAboutOperations.adoc[]
31+
** xref:opsPulsarScaling.adoc[]
32+
** Changing the topic or table schema
3033
*** xref:opsPulsarChangeSchema.adoc[]
31-
*** xref:opsPulsarRestart.adoc[]
32-
*** xref:opsPulsarDisplayConfig.adoc[]
33-
*** xref:opsPulsarUpdateConfig.adoc[]
34-
*** xref:opsPulsarDeleteConnector.adoc[]
35-
*** xref:opsPulsarConnectorStatus.adoc[]
36-
** Security
37-
*** xref:secPulsarInternalLdapAuth.adoc[]
38-
** xref:monPulsarConnectMetrics.adoc[]
39-
** Troubleshooting
40-
*** xref:trbPulsarTsRecordFailsToWriteToTable.adoc[]
41-
*** xref:trbPulsarTsLargeBatches.adoc[]
42-
*** xref:trbPulsarTsRecordParsingFails.adoc[]
43-
*** xref:trbPulsarTsLoadBalancing.adoc[]
34+
*** xref:opsPulsarAddField.adoc[]
35+
*** xref:opsPulsarRemoveField.adoc[]
36+
*** xref:opsPulsarAddTableColumn.adoc[]
37+
*** xref:opsPulsarRemoveColumn.adoc[]
38+
** xref:opsPulsarRestart.adoc[]
39+
** xref:opsPulsarDisplayConfig.adoc[]
40+
** xref:opsPulsarUpdateConfig.adoc[]
41+
** xref:opsPulsarDeleteConnector.adoc[]
42+
** xref:opsPulsarConnectorStatus.adoc[]
43+
* Security
44+
** xref:secPulsarInternalLdapAuth.adoc[]
45+
* xref:monPulsarConnectMetrics.adoc[]
46+
* Troubleshooting
47+
** xref:trbPulsarTsRecordFailsToWriteToTable.adoc[]
48+
** xref:trbPulsarTsLargeBatches.adoc[]
49+
** xref:trbPulsarTsRecordParsingFails.adoc[]
50+
** xref:trbPulsarTsLoadBalancing.adoc[]
4451
4552
.Reference
46-
**** xref:cfgRefPulsarConnector.adoc[]
47-
**** xref:cfgRefPulsarDseConnection.adoc[]
48-
**** xref:cfgRefPulsarDseTable.adoc[]
49-
**** xref:cfgRefPulsarDates.adoc[]
50-
**** xref:cfgRefPulsarAuth.adoc[]
51-
***** xref:cfgRefPulsarAuthLdap.adoc[]
52-
**** xref:cfgRefPulsarSsl.adoc[]
53-
**** xref:cfgPulsarConfigureErrorHandling.adoc[]
54-
53+
* xref:cfgRefPulsarConnector.adoc[]
54+
* xref:cfgRefPulsarDseConnection.adoc[]
55+
* xref:cfgRefPulsarDseTable.adoc[]
56+
* xref:cfgRefPulsarDates.adoc[]
57+
* DataStax Enterprise authentication
58+
** xref:cfgRefPulsarAuth.adoc[]
59+
** xref:cfgRefPulsarAuthLdap.adoc[]
60+
* xref:cfgRefPulsarSsl.adoc[]
61+
* xref:cfgPulsarConfigureErrorHandling.adoc[]

‎docs-src/pulsar-sink-core/modules/ROOT/pages/cfgRefPulsarAuth.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
= Using the DataStax Apache Pulsar™ Connector with DataStax Enterprise authentication
2-
1+
= Using the DataStax Apache Pulsar™ Connector with DataStax Enterprise authentication
2+
:navtitle: Using the Pulsar Connector with DSE authentication
33
:page-tag: pulsar-connector,security,secure,pulsar
44

55
When authentication is enabled, provide credentials for internal authentication or LDAP.

‎docs-src/pulsar-sink-core/modules/ROOT/pages/cfgRefPulsarConnector.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
= DataStax Apache Pulsar™ Connector details
2-
1+
= DataStax Apache Pulsar™ Connector parameters
2+
:navtitle: Pulsar Connector parameters
33
:page-tag: pulsar-connector,dev,develop,pulsar
44

55
Set the common DataStax Apache Pulsar™ Connector parameters.
66

7-
== Parameters
7+
== Parameters
88

99
[source,language-yaml]
1010
----

‎docs-src/pulsar-sink-core/modules/ROOT/pages/monPulsarConnectMetrics.adoc

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
= DataStax Apache Pulsar™ Connector metrics
2-
1+
= DataStax Apache Pulsar™ Connector metrics
2+
:navtitle: Metrics
33
:page-tag: pulsar-connector,admin,manage,pulsar
44

55
You can view DataStax Apache Pulsar™ Connector metrics in raw Prometheus format at the Apache Pulsar metrics endpoint:
@@ -45,7 +45,7 @@ com_datastax_oss_pulsar_sink_dse_sink_kv_Count{instance="localhost:8080", job="p
4545

4646
The entries in this reference are separated into the Prometheus root query, and available metrics for the `name` attribute are listed within.
4747

48-
TIP: Specifying only the root query returns all of the available named metrics.
48+
TIP: Specifying only the root query returns all of the available named metrics.
4949

5050
== com_datastax_oss_pulsar_sink_<sink_name>_Count
5151

@@ -86,7 +86,7 @@ com_datastax_oss_pulsar_sink_dse_sink_kv_Count{instance="localhost:8080", job="p
8686

8787
=== batchSizeInBytes
8888

89-
Calculated size of every batch statement in bytes.
89+
Calculated size of every batch statement in bytes.
9090

9191
Example
9292

@@ -145,7 +145,7 @@ com_datastax_oss_pulsar_sink_dse_sink_kv_SnapshotSize{instance="localhost:8080",
145145

146146
=== batchSizeInBytes
147147

148-
Calculated size of every batch statement in bytes.
148+
Calculated size of every batch statement in bytes.
149149

150150
Example
151151

@@ -230,7 +230,7 @@ com_datastax_oss_pulsar_sink_dse_sink_kv_95thPercentile{instance="localhost:8080
230230

231231
=== batchSizeInBytes
232232

233-
Calculated size of every batch statement in bytes.
233+
Calculated size of every batch statement in bytes.
234234

235235
Example
236236

@@ -267,7 +267,7 @@ com_datastax_oss_pulsar_sink_dse_sink_kv_50thPercentile{instance="localhost:8080
267267

268268
=== batchSizeInBytes
269269

270-
Calculated size of every batch statement in bytes.
270+
Calculated size of every batch statement in bytes.
271271

272272
Example
273273

@@ -304,7 +304,7 @@ com_datastax_oss_pulsar_sink_dse_sink_kv_999thPercentile{instance="localhost:808
304304

305305
=== batchSizeInBytes
306306

307-
Calculated size of every batch statement in bytes.
307+
Calculated size of every batch statement in bytes.
308308

309309
Example
310310

@@ -341,7 +341,7 @@ com_datastax_oss_pulsar_sink_dse_sink_kv_98thPercentile{instance="localhost:8080
341341

342342
=== batchSizeInBytes
343343

344-
Calculated size of every batch statement in bytes.
344+
Calculated size of every batch statement in bytes.
345345

346346
Example
347347

@@ -378,7 +378,7 @@ com_datastax_oss_pulsar_sink_dse_sink_kv_99thPercentile{instance="localhost:8080
378378

379379
=== batchSizeInBytes
380380

381-
Calculated size of every batch statement in bytes.
381+
Calculated size of every batch statement in bytes.
382382

383383
Example
384384

@@ -415,7 +415,7 @@ com_datastax_oss_pulsar_sink_dse_sink_kv_Mean{instance="localhost:8080", job="pu
415415

416416
=== batchSizeInBytes
417417

418-
Calculated size of every batch statement in bytes.
418+
Calculated size of every batch statement in bytes.
419419

420420
Example
421421

@@ -452,7 +452,7 @@ com_datastax_oss_pulsar_sink_dse_sink_kv_Max{instance="localhost:8080", job="pul
452452

453453
=== batchSizeInBytes
454454

455-
Calculated size of every batch statement in bytes.
455+
Calculated size of every batch statement in bytes.
456456

457457
Example
458458

@@ -537,7 +537,7 @@ com_datastax_oss_pulsar_sink_dse_sink_kv_Min{instance="localhost:8080", job="pul
537537

538538
=== batchSizeInBytes
539539

540-
Calculated size of every batch statement in bytes.
540+
Calculated size of every batch statement in bytes.
541541

542542
Example
543543

@@ -622,7 +622,7 @@ com_datastax_oss_pulsar_sink_dse_sink_kv_75thPercentile{instance="localhost:8080
622622

623623
=== batchSizeInBytes
624624

625-
Calculated size of every batch statement in bytes.
625+
Calculated size of every batch statement in bytes.
626626

627627
Example
628628

@@ -696,7 +696,7 @@ com_datastax_oss_pulsar_sink_dse_sink_kv_StdDev{instance="localhost:8080", job="
696696

697697
=== batchSizeInBytes
698698

699-
Calculated size of every batch statement in bytes.
699+
Calculated size of every batch statement in bytes.
700700

701701
Example
702702

‎docs-src/pulsar-sink-core/modules/ROOT/pages/opsPulsarAboutOperations.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
= About operating and maintaining the DataStax Connector
2-
1+
= About operating and maintaining the DataStax Apache Pulsar™ Connector
2+
:navtitle: About operating and maintaining the Pulsar Connector
33
:page-tag: pulsar-connector,admin,manage,pulsar
44

55
To operate and maintain the DataStax Apache Pulsar™ Connector use the Apache Pulsar™ adminstration tool, `pulsar-admin` in concert with the Apache Pulsar™ REST Administration API.

‎docs-src/pulsar-sink-core/modules/ROOT/pages/opsPulsarConnectorStatus.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
= Getting the DataStax Connector status
2-
1+
= Getting the DataStax Apache Pulsar™ Connector status
2+
:navtitle: Getting the Pulsar Connector status
33
:page-tag: pulsar-connector,dev,develop,admin,manage,pulsar
44

55
Use the Apache Pulsar™ administration tool `sinks status` command to display the status of the DataStax Apache Pulsar™ Connector.

‎docs-src/pulsar-sink-core/modules/ROOT/pages/opsPulsarDeleteConnector.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
= Deleting the DataStax Apache Pulsar™ Connector
2-
1+
= Deleting the DataStax Apache Pulsar™ Connector
2+
:navtitle: Deleting the Pulsar Connector
33
:page-tag: pulsar-connector,admin,manage,pulsar
44

55
To completely remove the DataStax Apache Pulsar™ Connector:

‎docs-src/pulsar-sink-core/modules/ROOT/pages/opsPulsarDisplayConfig.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
= Displaying the DataStax Apache Pulsar™ Connector configuration
2-
1+
= Displaying the DataStax Apache Pulsar™ Connector configuration
2+
:navtitle: Displaying the Pulsar Connector configuration
33
:page-tag: pulsar-connector,dev,develop,admin,manage,pulsar
44

55
Use the Apache Pulsar™ administration tool sinks command to retrieve detailed information on a Pulsar sink:

‎docs-src/pulsar-sink-core/modules/ROOT/pages/opsPulsarRestart.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
= Restarting the DataStax Apache Pulsar™ Connector
2-
1+
= Restarting the DataStax Apache Pulsar™ Connector
2+
:navtitle: Restarting the Pulsar Connector
33
:page-tag: pulsar-connector,admin,manage,pulsar
44

55
To restart a DataStax Apache Pulsar™ Connector that was previously running, use the `pulsar-admin sinks` command:

‎docs-src/pulsar-sink-core/modules/ROOT/pages/opsPulsarScaling.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
1-
= Scaling the DataStax Apache Pulsar™ Connector
2-
1+
= Scaling the DataStax Apache Pulsar™ Connector
2+
:navtitle: Scaling the Pulsar Connector
33
:page-tag: pulsar-connector,admin,manage,pulsar
44

55
Use the Apache Pulsar™ administration tool to increase or decrease the number of workers to run for a given sink using the parallelism factor. You can specify the parallelism factor during creation of a Pulsar sink, and you can modify it after the fact as well. The default parallelism factor is `1`.

0 commit comments

Comments
 (0)