Fixes to page titles in generated docs (#353)

* Fixes to page titles in generated docs

* Removed streams.adoc

Co-authored-by: Adam Cowley <[email protected]>

Author: adam-cowley

doc/docs.yml

@@ -3,14 +3,16 @@ site:
   url: /neo4j-streams-docs
 content:
   sources:
-    - url: https://github.com/neo4j-contrib/neo4j-streams
-      branches: '4.0'
+    - url: ../
+      branches: HEAD
       start_path: doc/docs
 ui:
   bundle:
     url: https://github.com/neo4j-documentation/docs-refresh/raw/master/ui/build/ui-bundle.zip
     snapshot: true
+urls:
+  html_extension_style: indexify
 asciidoc:
   attributes:
-    page-theme: docs
-    page-cdn: /_/
+    page-theme: labs
+    page-disabletracking: true

doc/docs/antora.yml

@@ -12,3 +12,5 @@ asciidoc:
     copyright: Neo4j Inc.
     common-license-page-uri: https://neo4j.com/docs/license/
     page-product: Neo4j Streams
+    environment: streams.sink
+    page-pagination: true

doc/docs/modules/ROOT/nav.adoc

@@ -1,56 +1,56 @@
 * xref::index.adoc[Neo4j Streams Integrations User Guide]
 
 * xref::overview.adoc[Project overview]
-** xref::overview.adoc#neo4j_streams_plugin_overview[Neo4j Streams plugin]
-** xref::overview.adoc#kafka_connect_plugin_overview[Kafka Connect plugin]
+// ** xref::overview.adoc#neo4j_streams_plugin_overview[Neo4j Streams plugin]
+// ** xref::overview.adoc#kafka_connect_plugin_overview[Kafka Connect plugin]
 
 * xref::quickstart.adoc[Quick Start]
-** xref::quickstart.adoc#neo4j_streams_plugin_quickstart[Neo4j Streams plugin]
-** xref::quickstart.adoc#kafka_connect_plugin_quickstart[Kafka Connect plugin]
+// ** xref::quickstart.adoc#neo4j_streams_plugin_quickstart[Neo4j Streams plugin]
+// ** xref::quickstart.adoc#kafka_connect_plugin_quickstart[Kafka Connect plugin]
 
-* xref::producer.adoc[Neo4j Streams - Source: Neo4j -> Kafka]
-** xref::producer.adoc#neo4j_streams_producer_config[Configuration]
-** xref::producer.adoc#source-patterns[Patterns]
-** xref::producer.adoc#_transaction_event_handler[Transaction Event Handler]
+* xref::producer.adoc[Source: Neo4j -> Kafka]
+// ** xref::producer.adoc#neo4j_streams_producer_config[Configuration]
+// ** xref::producer.adoc#source-patterns[Patterns]
+// ** xref::producer.adoc#_transaction_event_handler[Transaction Event Handler]
 
-* xref::consumer.adoc[Neo4j Streams - Sink: Neo4j -> Kafka]
-** xref::consumer.adoc#neo4j_streams_sink_howitworks[How it works]
-** xref::consumer.adoc#_sink_ingestion_strategies[Sink ingestion strategies]
-** xref::consumer.adoc#neo4j_streams_dlq[How deal with bad data]
-** xref::consumer.adoc#neo4j_streams_supported_deserializers[Supported Kafka deserializers]
-** xref::consumer.adoc#neo4j_streams_config_summary[Configuration summary]
+* xref::consumer.adoc[Sink: Neo4j -> Kafka]
+// ** xref::consumer.adoc#neo4j_streams_sink_howitworks[How it works]
+// ** xref::consumer.adoc#_sink_ingestion_strategies[Sink ingestion strategies]
+// ** xref::consumer.adoc#neo4j_streams_dlq[How deal with bad data]
+// ** xref::consumer.adoc#neo4j_streams_supported_deserializers[Supported Kafka deserializers]
+// ** xref::consumer.adoc#neo4j_streams_config_summary[Configuration summary]
 
-* xref::procedures.adoc[Neo4j Streams - Procedures]
-** xref::procedures.adoc#neo4j_streams_procedures_config[Configuration]
-** xref::procedures.adoc#neo4j_streams_procedure_publish[streams.publish]
-** xref::procedures.adoc#neo4j_streams_procedure_consume[streams.consume]
+* xref::procedures.adoc[Procedures]
+// ** xref::procedures.adoc#_configuration[Configuration]
+// ** xref::procedures.adoc#_streams_publish[streams.publish]
+// ** xref::procedures.adoc#_streams_consume[streams.consume]
 
 * xref::kafka-connect.adoc[Kafka Connect Plugin]
-** xref::kafka-connect.adoc#kafka_connect_plugin_install[Plugin installation]
-** xref::kafka-connect.adoc#kafka-connect-sink-instance[Create the Sink Instance]
-** xref::kafka-connect.adoc#kafka-connect-sink-strategies[Sink ingestion strategies]
-** xref::kafka-connect.adoc#kafka-connect-cud-file-format[How deal with bad data]
-** xref::kafka-connect.adoc#kafka_connect_monitor[Monitor via Confluent Pltaform UI]
-** xref::kafka-connect.adoc#kafka_connect_config_policy[Kafka Connect Client Config Override Policy]
-** xref::kafka-connect.adoc#_configuration_summary[Configuration Summary]
+// ** xref::kafka-connect.adoc#kafka_connect_plugin_install[Plugin installation]
+// ** xref::kafka-connect.adoc#kafka-connect-sink-instance[Create the Sink Instance]
+// ** xref::kafka-connect.adoc#kafka-connect-sink-strategies[Sink ingestion strategies]
+// ** xref::kafka-connect.adoc#kafka-connect-cud-file-format[How deal with bad data]
+// ** xref::kafka-connect.adoc#kafka_connect_monitor[Monitor via Confluent Pltaform UI]
+// ** xref::kafka-connect.adoc#kafka_connect_config_policy[Kafka Connect Client Config Override Policy]
+// ** xref::kafka-connect.adoc#_configuration_summary[Configuration Summary]
 
 * xref::neo4j-cluster.adoc[Using with Neo4j Causal Cluster]
-** xref::neo4j-cluster.adoc#cluster_overview[Overview]
-** xref::neo4j-cluster.adoc#cluster_kafka_connect[Kafka Connect]
-** xref::neo4j-cluster.adoc#cluster_neo4j_plugin[Neo4j Plugin]
-** xref::neo4j-cluster.adoc#cluster_remote_clients[Remote Clients]
+// ** xref::neo4j-cluster.adoc#cluster_overview[Overview]
+// ** xref::neo4j-cluster.adoc#cluster_kafka_connect[Kafka Connect]
+// ** xref::neo4j-cluster.adoc#cluster_neo4j_plugin[Neo4j Plugin]
+// ** xref::neo4j-cluster.adoc#cluster_remote_clients[Remote Clients]
 
 * xref::docker.adoc[Run with Docker]
-** xref::docker.adoc#neo4j_streams_docker[Neo4j Streams plugin]
-** xref::docker.adoc#docker_kafka_connect[Kafka Connect Plugin]
-** xref::docker.adoc#docker_streams_cluster[Neo4j Streams with Neo4j Cluster and Kafka Cluster]
+// ** xref::docker.adoc#neo4j_streams_docker[Neo4j Streams plugin]
+// ** xref::docker.adoc#docker_kafka_connect[Kafka Connect Plugin]
+// ** xref::docker.adoc#docker_streams_cluster[Neo4j Streams with Neo4j Cluster and Kafka Cluster]
 
 * xref::kafka-ssl.adoc[Configure with Kafka over SSL]
-** xref::kafka-ssl.adoc#kafka_ssl_self_signed[Self Signed Certificates]
-** xref::kafka-ssl.adoc#kafka_ssl_config[Kafka Configuration]
-** xref::kafka-ssl.adoc#kafka_ssl_neo4j_config[Neo4j Configuration]
-** xref::kafka-ssl.adoc#kafka_ssl_testing[Testing]
-** xref::kafka-ssl.adoc#_authentication_with_sasl[Authentication with SASL]
+// ** xref::kafka-ssl.adoc#kafka_ssl_self_signed[Self Signed Certificates]
+// ** xref::kafka-ssl.adoc#kafka_ssl_config[Kafka Configuration]
+// ** xref::kafka-ssl.adoc#kafka_ssl_neo4j_config[Neo4j Configuration]
+// ** xref::kafka-ssl.adoc#kafka_ssl_testing[Testing]
+// ** xref::kafka-ssl.adoc#_authentication_with_sasl[Authentication with SASL]
 
 * xref::cloud.adoc[Confluent Cloud]
 
@@ -65,22 +65,22 @@
 ** xref::architecture/optimize.adoc[Optimizing Kafka]
 
 * xref::examples.adoc[Examples with Confluent Platform and Kafka Connect Datagen]
-** xref::examples.adoc#examples_binary_format[Confluent and Neo4j in binary format]
-** xref::examples.adoc#confluent_docker_example[Confluent with Docker, Neo4j in binary format]
+// ** xref::examples.adoc#examples_binary_format[Confluent and Neo4j in binary format]
+// ** xref::examples.adoc#confluent_docker_example[Confluent with Docker, Neo4j in binary format]
 
 * xref::developing.adoc[Developing Neo4j Streams]
-** xref::developing.adoc#dev_build_locally[Build locally]
-** xref::developing.adoc#dev_gen_docs[Generating this Documentation]
-** xref::developing.adoc#dev_gen_docs_antora[Generating this Documentation with Antora]
+// ** xref::developing.adoc#dev_build_locally[Build locally]
+// ** xref::developing.adoc#dev_gen_docs[Generating this Documentation]
+// ** xref::developing.adoc#dev_gen_docs_antora[Generating this Documentation with Antora]
 
 * xref::faq.adoc[Neo4j Streams FAQ]
-** xref::faq.adoc#_source_code_license[Source Code License]
-** xref::faq.adoc#_how_to_integrate_neo4j_and_kafka[How to integrate Neo4j and Kafka]
-** xref::faq.adoc#_about_cud_file_format[About CUD file format]
-** xref::faq.adoc#_how_to_ingest_events_using_cdc_schema_strategy[How to ingest events using CDC Schema strategy]
-** xref::faq.adoc#_is_neo4j_streams_supported_by_confluent_cloud[Is Neo4j Streams supported by Confluent Cloud?]
-** xref::faq.adoc#_kafka_output_events_description[Kafka output events description]
-** xref::faq.adoc#_how_to_configure_kafka_over_ssl[How to configure Kafka over SSL?]
-** xref::faq.adoc#_enabling_dlq_functionality[Enabling DLQ functionality]
-** xref::faq.adoc#_supported_kafka_deserializers[Supported Kafka deserializers]
-** xref::faq.adoc#_kafka_cluster_and_topic_with_multiple_partition_setup[Kafka cluster and topic with multiple partition setup]
+// ** xref::faq.adoc#_source_code_license[Source Code License]
+// ** xref::faq.adoc#_how_to_integrate_neo4j_and_kafka[How to integrate Neo4j and Kafka]
+// ** xref::faq.adoc#_about_cud_file_format[About CUD file format]
+// ** xref::faq.adoc#_how_to_ingest_events_using_cdc_schema_strategy[How to ingest events using CDC Schema strategy]
+// ** xref::faq.adoc#_is_neo4j_streams_supported_by_confluent_cloud[Is Neo4j Streams supported by Confluent Cloud?]
+// ** xref::faq.adoc#_kafka_output_events_description[Kafka output events description]
+// ** xref::faq.adoc#_how_to_configure_kafka_over_ssl[How to configure Kafka over SSL?]
+// ** xref::faq.adoc#_enabling_dlq_functionality[Enabling DLQ functionality]
+// ** xref::faq.adoc#_supported_kafka_deserializers[Supported Kafka deserializers]
+// ** xref::faq.adoc#_kafka_cluster_and_topic_with_multiple_partition_setup[Kafka cluster and topic with multiple partition setup]

doc/docs/modules/ROOT/pages/architecture.adoc

@@ -1,6 +1,6 @@
-[[architecture]]
-== Architectural Guidance
+= Architectural Guidance
 
+[[architecture]]
 The purpose of this section is to:
 
 * Describe how this integration works

doc/docs/modules/ROOT/pages/cloud.adoc

@@ -1,7 +1,7 @@
 
-[[confluent_cloud]]
-== Confluent Cloud
+= Confluent Cloud
 
+[[confluent_cloud]]
 Configuring a connection to a Confluent Cloud instance should follow
 link:https://docs.confluent.io/current/cloud/using/config-client.html#java-client[Confluent's Java Client]
 configuration advice, and the advice in <<_kafka_settings, Kafka Settings>> section.

doc/docs/modules/ROOT/pages/config-override-policy.adoc

@@ -1,5 +1,5 @@
 
-[[kafka_connect_config_policy]]
+[#kafka_connect_config_policy]
 === Kafka Connect Client Config Override Policy
 
 In Apache Kafka 2.3.0 was introduced the ability for each source and sink connector to inherit their client configurations

doc/docs/modules/ROOT/pages/consumer-configuration.adoc

@@ -1,11 +1,9 @@
-
-[[neo4j_streams_config_summary]]
 === Configuration summary
 
 You can set the following Kafka configuration values in your `neo4j.conf`, here are the defaults.
 
 .neo4j.conf
-[subs="verbatim,attributes"]
+[source,subs="verbatim,attributes"]
 ----
 kafka.zookeeper.connect=localhost:2181
 kafka.bootstrap.servers=localhost:9092
@@ -34,6 +32,7 @@ in order to support this feature you can set for each database instance a config
 
 Following the list of new properties that allows to support multi-tenancy:
 
+[source]
 ----
 streams.sink.topic.cypher.<TOPIC_NAME>.to.<DB_NAME>=<CYPHER_QUERY>
 streams.sink.topic.cdc.sourceId.to.<DB_NAME>=<LIST_OF_TOPICS_SEPARATE_BY_SEMICOLON>
@@ -49,6 +48,7 @@ This means that for each db instance you can specify if:
 
 So if you have a instance name `foo` you can specify a configuration in this way:
 
+[source]
 ----
 streams.sink.topic.cypher.<TOPIC_NAME>.to.foo=<CYPHER_QUERY>
 streams.sink.topic.cdc.sourceId.to.foo=<LIST_OF_TOPICS_SEPARATE_BY_SEMICOLON>
@@ -60,6 +60,7 @@ streams.sink.enabled.to.foo=<true/false, default=true>
 
 The old properties:
 
+[source]
 ----
 streams.sink.topic.cypher.<TOPIC_NAME>=<CYPHER_QUERY>
 streams.sink.topic.cdc.sourceId=<LIST_OF_TOPICS_SEPARATE_BY_SEMICOLON>
@@ -83,6 +84,7 @@ Database names are case-insensitive and normalized to lowercase, and must follow
 In particular the following property will be used as default values
 for non-default db instances, in case of the specific configuration params is not provided:
 
+[source]
 ----
 streams.sink.enabled=<true/false, default=true>
 ----
@@ -96,6 +98,7 @@ This means that if you have Neo4j with 3 db instances:
 and you want to enable the Sink plugin on all instance
 you can simply omit any configuration about enabling it, you just need to provide the routing configuration for each instance:
 
+[source]
 ----
 streams.sink.topic.cypher.customersTopic.to.customers=MERGE (c:Customer{customerId: event.customerId}) SET c += event.properties
 streams.sink.topic.cypher.productsTopic.to.products=MERGE (c:Product{productId: event.productId}) SET c += event.properties
@@ -105,6 +108,7 @@ streams.sink.topic.cypher.productsTopic.to.neo4j=MERGE (c:MyLabel{myId: event.my
 Otherwise if you want to enable the Sink plugin only on `customers` and `products` instances
 you can do it in this way:
 
+[source]
 ----
 streams.sink.enabled=false
 streams.sink.enabled.to.customers=true
@@ -115,8 +119,10 @@ streams.sink.topic.cypher.productsTopic.to.products=MERGE (c:Product{productId:
 
 So in general if you have:
 
+[source]
 ----
 streams.sink.enabled=true
 streams.sink.enabled.to.foo=false
 ----
-Then sink is enabled on all databases EXCEPT foo (local overrides global)
+
+Then sink is enabled on all databases EXCEPT foo (local overrides global)

doc/docs/modules/ROOT/pages/consumer.adoc

@@ -1,6 +1,4 @@
-
-[[neo4j_streams_sink]]
-== Neo4j Streams - Sink: Kafka -> Neo4j
+= Neo4j Streams - Sink: Kafka -> Neo4j
 :environment: streams.sink
 :id: streams_sink
 
@@ -10,12 +8,13 @@ ifdef::env-docs[]
 This chapter describes the Neo4j Streams Sink in the Neo4j Streams Library.
 Use this section to configure Neo4j to ingest the data from Kafka into Neo4j.
 --
-endif::env-docs[]
 
+endif::env-docs[]
+[[neo4j_streams_sink]]
 Is the Kafka Sink that ingest the data directly into Neo4j
 
 [[neo4j_streams_sink_howitworks]]
-=== How it works
+== How it works
 
 It works in several ways:
 
@@ -24,7 +23,7 @@ It works in several ways:
 * by providing a pattern extraction to a JSON or AVRO file
 * by managing a CUD file format
 
-==== Cypher Template
+=== Cypher Template
 
 It works with template Cypher queries stored into properties with the following format:
 
@@ -67,7 +66,7 @@ MERGE (n:Label {id: event.id})
     ON CREATE SET n += event.properties
 ----
 
-Where `{events}` is a json list, so continuing with the example above a possible full representation could be:
+Where `\{events}` is a json list, so continuing with the example above a possible full representation could be:
 
 [source,cypher]
 ----
@@ -98,7 +97,7 @@ include::sink-strategies.adoc[]
 include::cud-file-format.adoc[]
 
 [[neo4j_streams_dlq]]
-=== How deal with bad data
+== How deal with bad data
 
 The Neo4j Streams Plugin provides several means to handle processing errors.
 
@@ -194,7 +193,7 @@ Every published record in the `Dead Letter Queue` contains the original record `
 |===
 
 [[neo4j_streams_supported_deserializers]]
-=== Supported Kafka deserializers
+== Supported Kafka deserializers
 
 The Neo4j Streams plugin supports 2 deserializers: