Skip to content

Commit 30de76b

Browse files
Docs optimization (#181)
* Add Atlas extension to local build * Stop opening links in new windows * Fix source code languages
1 parent be0b67d commit 30de76b

13 files changed

+54
-35
lines changed

docs/docs-src/core/antora.yml

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,11 @@
1-
name: cdc-for-cassandra
2-
title: DataStax CDC for Apache Cassandra
1+
name: 'cdc-for-cassandra'
2+
title: 'DataStax CDC for Apache Cassandra'
33
version: '2.2.9'
4-
display_version: '2.2.9'
5-
start_page: index.adoc
4+
start_page: 'index.adoc'
5+
6+
nav:
7+
- modules/ROOT/nav.adoc
8+
69
asciidoc:
710
attributes:
811
cdc_cass_first: 'DataStax CDC for Apache Cassandra(R)'
@@ -13,5 +16,3 @@ asciidoc:
1316
luna_version: '2.10'
1417
pulsar_version: '2.10'
1518
version: '2.2.9' # cdc-apache-cassandra latest {version}
16-
nav:
17-
- modules/ROOT/nav.adoc

docs/docs-src/core/modules/ROOT/pages/backfill-cli.adoc

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ cd cdc-apache-cassandra
3131
Result::
3232
+
3333
--
34-
[source,bash]
34+
[source,console]
3535
----
3636
BUILD SUCCESSFUL in 37s
3737
17 actionable tasks: 15 executed, 2 up-to-date
@@ -175,7 +175,7 @@ Your data topic is now populated with the existing data from the Cassandra table
175175
.Pulsar consumer subscription output:
176176
[%collapsible]
177177
====
178-
[source,plain]
178+
[source,console]
179179
----
180180
----- got message -----
181181
2023-04-14T11:47:48,652-0400 [main] INFO org.apache.pulsar.client.impl.schema.AutoConsumeSchema - Configure topic schema \x00\x00\x00\x00\x00\x00\x00\x00 for topic persistent://public/default/data-ks1.table1 : {"key":{"name":"table1","schema":{"type":"record","name":"table1","namespace":"ks1","doc":"Table ks1.table1","fields":[{"name":"id","type":"string"}]},"type":"AVRO","timestamp":0,"properties":{}},"value":{"name":"table1","schema":{"type":"record","name":"table1","namespace":"ks1","doc":"Table ks1.table1","fields":[{"name":"val","type":["null","string"]}]},"type":"AVRO","timestamp":0,"properties":{}}}
@@ -236,7 +236,7 @@ When running the backfill CLI as a Pulsar-admin extension, all `--pulsar-*` para
236236
The `--dsbulk-log-dir` is only available when running the backfill CLI as a standalone Java application.
237237

238238
The `--export-dsbulk-option` parameter passes extra parameters to DSBulk.
239-
The relevant DSBulk settings configure the CSV connector and can be found https://github.com/datastax/dsbulk/blob/1.10.x/manual/settings.md#connector.csv[here^].
239+
The relevant DSBulk settings configure the CSV connector and can be found https://github.com/datastax/dsbulk/blob/1.10.x/manual/settings.md#connector.csv[here].
240240
Shortened option names are not supported.
241241

242242
In both the Pulsar-admin extension and the standalone Java application, C* related configurations are exclusively passed as command line arguments.

docs/docs-src/core/modules/ROOT/pages/cdcExample.adoc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
Capture schema changes in your C* tables and pass them to Apache Pulsar(R) with DataStax Change Data Capture (CDC). This doc will guide you through installing, configuring, and using CDC with C* or DSE in a VM-based deployment.
44

5-
This installation requires the following. Latest version artifacts are available https://github.com/datastax/cdc-apache-cassandra/releases/latest[here^]. Use image:https://img.shields.io/github/v/release/datastax/cdc-apache-cassandra?color=green&display_name=tag[link="https://github.com/datastax/cdc-apache-cassandra/releases/latest"^] for the latest version.
5+
This installation requires the following. Latest version artifacts are available https://github.com/datastax/cdc-apache-cassandra/releases/latest[here]. Use image:https://img.shields.io/github/v/release/datastax/cdc-apache-cassandra?color=green&display_name=tag[link="https://github.com/datastax/cdc-apache-cassandra/releases/latest"] for the latest version.
66

77
* C* or DSE environment
88
** https://downloads.datastax.com/#enterprise[DSE 6.8.16+]
@@ -17,7 +17,7 @@ This installation requires the following. Latest version artifacts are available
1717
1818
== Installing and configuring
1919
20-
. Download the https://pulsar.apache.org/download/[Pulsar tarball] and set up a Pulsar cluster. This example uses Pulsar https://pulsar.apache.org/docs/en/standalone/[standalone mode], but you can also use our helpful https://github.com/datastax/pulsar-ansible[Ansible Scripts^].
20+
. Download the https://pulsar.apache.org/download/[Pulsar tarball] and set up a Pulsar cluster. This example uses Pulsar https://pulsar.apache.org/docs/en/standalone/[standalone mode], but you can also use our helpful https://github.com/datastax/pulsar-ansible[Ansible Scripts].
2121
+
2222
[source,bash]
2323
----
@@ -29,7 +29,7 @@ bin/pulsar standalone
2929
====
3030
We recommend using the latest CDC agent version (at least version `1.0.4`+) to support C* collection data types.
3131
====
32-
. Install C*/DSE with your preferred https://docs.datastax.com/en/install/6.8/install/installWhichOne.html[installation method^].
32+
. Install C*/DSE with your preferred https://docs.datastax.com/en/install/6.8/install/installWhichOne.html[installation method].
3333
3434
. After installing C*/DSE, but before starting the C*/DSE service, set the `Cassandra-env.sh` configuration:
3535
+
@@ -78,13 +78,13 @@ INFO [main] 2022-04-11 18:47:06,433 Agent.java:92 - CDC agent started
7878
7979
== Deploy Pulsar Connector
8080
81-
. Deploy the Pulsar Cassandra Source Connector (CSC) for each CDC-enabled C* table. In the below example, we're configuring the source connector with parameters passed in `--source-config`.
81+
. Deploy the Pulsar Cassandra Source Connector (CSC) for each CDC-enabled C* table. In the below example, we're configuring the source connector with parameters passed in `--source-config`.
8282
+
83-
The `outputFormat` source configuration controls the format of messages on the data topic.
83+
The `outputFormat` source configuration controls the format of messages on the data topic.
8484
+
85-
* `key-value-avro` - Default behavior. Key and value are encoded separately in AVRO format.
85+
* `key-value-avro` - Default behavior. Key and value are encoded separately in AVRO format.
8686
* `key-value-json` - Key and value are encoded *separately* in JSON format.
87-
* `json` - Key and value are encoded *together* in a single JSON object. Key field is populated with a JSON string representing key fields.
87+
* `json` - Key and value are encoded *together* in a single JSON object. Key field is populated with a JSON string representing key fields.
8888
+
8989
[tabs]
9090
====
@@ -161,9 +161,9 @@ $ pulsar-admin source create \
161161
--
162162
====
163163
164-
. Verify the CSC connector is deployed.
164+
. Verify the CSC connector is deployed.
165165
+
166-
[source, bash]
166+
[source,bash]
167167
----
168168
pulsar-admin source list ["<csc_connector_name>"]
169169
----

docs/docs-src/core/modules/ROOT/pages/faqs.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,7 @@ We recommend active monitoring of the disk space of the C* nodes. If the Pulsar
102102
When the disk space of the `cdc_raw` directory reaches your `cdc_total_space_in_mb` Cassandra setting (less than 4GB by default), writes to CDC-enabled tables will fail with a `CDCWriteException`.
103103
The following warning message is included in Cassandra logs:
104104

105-
[source,language-bash]
105+
[source,bash]
106106
----
107107
WARN [CoreThread-5] 2021-10-29 09:12:52,790 NoSpamLogger.java:98 - Rejecting Mutation containing CDC-enabled table. Free up space in /mnt/data/cdc_raw.
108108
----

docs/docs-src/core/modules/ROOT/pages/install.adoc

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ The following files are available in the tar file:
2424

2525
. Extract the files from the tar with the following command:
2626
+
27-
[source,language-bash]
27+
[source,bash]
2828
----
2929
tar xvf cassandra-source-agents-<version>.tar
3030
----
@@ -75,7 +75,7 @@ Without the change agent to process the CDC data, the space used will grow until
7575

7676
Here is an example set of configurations for the `cassandra.yaml` file:
7777

78-
[source,language-bash]
78+
[source,bash]
7979
----
8080
cdc_enabled: true
8181
commitlog_sync_period_in_ms: 2000
@@ -107,7 +107,7 @@ The following files are available:
107107

108108
Extract the files from the tar with the following command:
109109

110-
[source,language-bash]
110+
[source,bash]
111111
----
112112
tar xvf cassandra-source-connectors-<version>.tar
113113
----
@@ -136,7 +136,7 @@ You have to specify the following parameters:
136136

137137
Here is an example:
138138

139-
[source,language-bash]
139+
[source,bash]
140140
----
141141
pulsar-admin source create \
142142
--name cassandra-source-1 \
@@ -159,7 +159,7 @@ pulsar-admin source create \
159159
----
160160

161161
Then check your connector is in the running state with no errors:
162-
[source,language-bash]
162+
[source,bash]
163163
----
164164
pulsar-admin source status --name cassandra-source-1
165165
----
@@ -175,7 +175,7 @@ For advanced configuration of the Cassandra driver in the {cdc_pulsar}, see xref
175175

176176
Once the change agent is installed and the connector is running, you can enable or disable CDC on table using the following commands:
177177

178-
[source,language-bash]
178+
[source,bash]
179179
----
180180
CREATE TABLE foo (a int, b text, PRIMARY KEY(a)) WITH cdc=true;
181181
ALTER TABLE foo WITH cdc=true;

docs/docs-src/core/modules/ROOT/pages/monitor.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ The change agent is a JVM agent running in Apache Cassandra(R) nodes and provide
5757

5858
The {cdc_cass} framework reports stats for each connector. You can view the stats for a connector like this:
5959

60-
[source,language-bash]
60+
[source,bash]
6161
----
6262
pulsar-admin source stats --name cassandra-source-1
6363

docs/docs-src/core/modules/ROOT/partials/cfgCassandraJavaDriverSettings.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
In your {cdc_pulsar} configuration file, you can directly pass settings to the DataStax Java driver by using the `datastax-java-driver` prefix.
44
For example:
55

6-
[source,no-highlight]
6+
[source,console]
77
----
88
datastax-java-driver.basic.request.consistency=ALL
99
----
@@ -48,7 +48,7 @@ For `datastax-java-driver.basic.contact-points`, you must provide the fully qual
4848

4949
By passing in the Java driver's setting, this option gives you more configuration flexibility because you can specify a different port for each host. For example:
5050

51-
[source,no-highlight]
51+
[source,console]
5252
----
5353
datastax-java-driver.basic.contact-points = 127.0.0.1:9042, 127.0.0.2:9042
5454
----
File renamed without changes.

0 commit comments

Comments
 (0)