Skip to content

Commit 1f0a8a1

Browse files
Narosgunnarmorling
authored andcommitted
DBZ-3626 Renaming master branches to main
Unlike other repositories, we decided to use gh-pages as the new deployment branch for the website rather than master.
1 parent 4d4cdff commit 1f0a8a1

File tree

49 files changed

+101
-101
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

49 files changed

+101
-101
lines changed

.github/workflows/gh-pages-deployment.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -19,5 +19,5 @@ jobs:
1919
with:
2020
github_token: ${{ secrets.GITHUB_TOKEN }}
2121
publish_dir: ./_site
22-
publish_branch: master
22+
publish_branch: gh-pages
2323
cname: debezium.io

ANTORA.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ content:
5757
- url: https://github.com/debezium/debezium.git
5858
start_path: documentation
5959
branches:
60-
- 'master'
60+
- 'main'
6161
- '0.9'
6262
- '0.8'
6363
```
@@ -72,7 +72,7 @@ content:
7272
- url: https://github.com/debezium/debezium.git
7373
start_path: documentation
7474
branches:
75-
- 'master'
75+
- 'main'
7676
tags:
7777
- '0.9.5.Final'
7878
- '0.8.3.Final'

CONTRIBUTING.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -340,7 +340,7 @@ At the time of writing the following table illustrates the mappings:
340340

341341
|Branch|Debezium Version|Antora Version|
342342
|---|---|---|
343-
|master|1.2.x|master|
343+
|main|1.2.x|main|
344344
|1.2|1.2.x|1.2|
345345
|1.1|1.1.x|1.1|
346346
|1.0|1.0.x|1.0|
@@ -355,7 +355,7 @@ Be sure when a new major/minor release is added that a new `releases/<major>.</m
355355

356356
#### Edit documentation
357357

358-
Documentation for Debezium is now split between this repository and the [main codebase](https://www.github.com/debezium/debezium.git) repository. Please see [DOCUMENTATION.md](http://www.github.com/debezium/debezium/tree/master/DOCUMENTATION.md) in the main codebase repository for details about Antora and how the documentation should be updated.
358+
Documentation for Debezium is now split between this repository and the [main codebase](https://www.github.com/debezium/debezium.git) repository. Please see [DOCUMENTATION.md](http://www.github.com/debezium/debezium/tree/main/DOCUMENTATION.md) in the main codebase repository for details about Antora and how the documentation should be updated.
359359

360360
Note: There are two Antora playbook configuration files used by this repository, `playbook.yml` and `playbook_author.yml`. It is important that these two files be kept in sync and the only difference between them should be `content.sources[0].url` which controls how each playbook obtains a reference to the Debezium main code repository.
361361

README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
This is the source code for the [Debezium website](https://debezium.io/). This is based on [templates](https://github.com/rhmwes/community-theme) created by the Red Hat upstream community using [Jekyll](https://jekyllrb.com/).
99

1010
For publishing the Debezium reference documentation, the [Antora](https://antora.org/) tool is used,
11-
which produces the documentation based on [AsciiDoc files](https://github.com/debezium/debezium/tree/master/documentation) in different branches of the Debezium main code repository.
11+
which produces the documentation based on [AsciiDoc files](https://github.com/debezium/debezium/tree/main/documentation) in different branches of the Debezium main code repository.
1212
The rendered HTML pages are added as-is to the website generated with Jekyll.
1313
Please see [ANTORA.md](./ANTORA.md) to learn more.
1414

@@ -136,4 +136,4 @@ Use Git on your local machine to commit the changes to the site's codebase to yo
136136
As soon as you passes the pull request a GitHub action generates the link for preview the change in surge.sh. When a pull request is closed the surge preview instance will be torn down.
137137
### 7. Publish the website
138138

139-
Review the pull request and merge onto the `develop` branch. The [GitHub Actions](https://github.com/features/actions) will then build the `develop` branch and, if successful, store the generated site in the `master` branch and publish to GitHub Pages.
139+
Review the pull request and merge onto the `develop` branch. The [GitHub Actions](https://github.com/features/actions) will then build the `develop` branch and, if successful, store the generated site in the `gh-pages` branch and publish to GitHub Pages.

_posts/2016-04-15-parsing-ddl.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -44,9 +44,9 @@ Since we couldn't find a useful 3rd party open source library, we chose to creat
4444
* Support customization through subclassing: be able to easily override narrow portions of the logic without having to copy lots of code.
4545
* Make it easy to develop, debug, and test parsers.
4646

47-
The resulting framework includes a tokenizer that converts one or more DDL statements in a string into a rewindable sequence of tokens, where each token represents punctuation, quoted strings, case-insentivie words and symbols, numbers, keywords, comments, and terminating characters (such as `;` for MySQL). The DDL parser, then, walks the token stream looking for patterns using a simple and easy to read fluent API, calling methods on itself to process the various sets of tokens. The parser also uses an internal https://github.com/debezium/debezium/blob/master/debezium-core/src/main/java/io/debezium/relational/ddl/DataTypeParser.java[data type parser] for processing SQL data type expressions, such as `INT`, `VARCHAR(64)`, `NUMERIC(32,3)`, `TIMESTAMP(8) WITH TIME ZONE`.
47+
The resulting framework includes a tokenizer that converts one or more DDL statements in a string into a rewindable sequence of tokens, where each token represents punctuation, quoted strings, case-insentivie words and symbols, numbers, keywords, comments, and terminating characters (such as `;` for MySQL). The DDL parser, then, walks the token stream looking for patterns using a simple and easy to read fluent API, calling methods on itself to process the various sets of tokens. The parser also uses an internal https://github.com/debezium/debezium/blob/main/debezium-core/src/main/java/io/debezium/relational/ddl/DataTypeParser.java[data type parser] for processing SQL data type expressions, such as `INT`, `VARCHAR(64)`, `NUMERIC(32,3)`, `TIMESTAMP(8) WITH TIME ZONE`.
4848

49-
The https://github.com/debezium/debezium/blob/master/debezium-connector-mysql/src/main/java/io/debezium/connector/mysql/MySqlDdlParser.java[MySqlDdlParser] class extends a https://github.com/debezium/debezium/blob/master/debezium-core/src/main/java/io/debezium/relational/ddl/DdlParser.java[base class] and provides all of the MySQL-specific parsing logic. For example, the DDL statements:
49+
The https://github.com/debezium/debezium/blob/main/debezium-connector-mysql/src/main/java/io/debezium/connector/mysql/MySqlDdlParser.java[MySqlDdlParser] class extends a https://github.com/debezium/debezium/blob/master/debezium-core/src/main/java/io/debezium/relational/ddl/DdlParser.java[base class] and provides all of the MySQL-specific parsing logic. For example, the DDL statements:
5050

5151
[source,sql]
5252
----
@@ -251,7 +251,7 @@ create_definition:
251251

252252
The `CREATE` literal was already consumed before our `parseCreateTable` begins, so it first tries to consume the `TEMPORARY` literal if available, the `TABLE` literal, the `IF NOT EXISTS` fragment if avaialble, and then consumes and parses the qualified name of the table. If the statement includes `LIKE otherTable`, it uses the `databaseTables` (which is the reference to our `Tables` object) to overwrite the definition of the named table with that of the referenced table. Otherwise, it obtains an editor for the new table, and then (like the grammar rules) parses a list of _create_definition_ fragments, followed by _table_options_, _partition_options_, and possibly a _select_statement_.
253253

254-
Take a look at the full https://github.com/debezium/debezium/blob/master/debezium-connector-mysql/src/main/java/io/debezium/connector/mysql/MySqlDdlParser.java[MySqlDdlParser] class to see far more details.
254+
Take a look at the full https://github.com/debezium/debezium/blob/main/debezium-connector-mysql/src/main/java/io/debezium/connector/mysql/MySqlDdlParser.java[MySqlDdlParser] class to see far more details.
255255

256256
== Wrap up
257257

_posts/2017-06-12-debezium-0-5-1-released.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ This may require an adjustment of your filters if you indeed wanted to capture a
1818

1919
+++<!-- more -->+++
2020

21-
Please refer to the https://github.com/debezium/debezium/blob/master/CHANGELOG.md#051[changelog] for an overview of all the 29 issues fixed in Debezium 0.5.1.
21+
Please refer to the https://github.com/debezium/debezium/blob/main/CHANGELOG.md#051[changelog] for an overview of all the 29 issues fixed in Debezium 0.5.1.
2222

2323
The Docker image containing https://hub.docker.com/r/debezium/connect/[Kafka Connect and all the Debezium 0.5.x connectors]
2424
as well as the image containing https://hub.docker.com/r/debezium/postgres/[Postgres and the Debezium logical decoding plug-in] have been updated to 0.5.1, too.

_posts/2017-08-17-debezium-0-5-2-is-out.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Finally, we've spent some time to extend the documentation on some things not co
2929
The Avro converter itself has also been added to the Debezium Docker image for Kafka Connect, so you can use it right away
3030
* https://debezium.io/docs/configuration/topic-routing/[Topic Routing] describes how to use Debezium's `ByLogicalTableRouter` single message transformation (SMT) for routing the change events from multiple tables into a single topic, which for instance is very useful when working with sharded tables
3131

32-
Please refer to the https://github.com/debezium/debezium/blob/master/CHANGELOG.md#052[changelog] for an overview of all the 19 issues fixed in Debezium 0.5.2.
32+
Please refer to the https://github.com/debezium/debezium/blob/main/CHANGELOG.md#052[changelog] for an overview of all the 19 issues fixed in Debezium 0.5.2.
3333

3434
The following people from the community have sent in pull requests for this release:
3535
https://github.com/emrul[Emrul Islam], https://github.com/ekreiser[Eric S. Kreiser], https://github.com/xenji[Mario Mueller], https://github.com/mcapitanio[Matteo Capitanio], https://github.com/omarsmak[Omar Al-Safi] and https://github.com/Satyajitv[Satyajit Vegesna].

_posts/2017-09-21-debezium-0-6-0-released.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -19,12 +19,12 @@ Also the Debezium Docker images have been updated do that version (https://issue
1919
You should make sure to read the Kafka https://kafka.apache.org/documentation/#upgrade[update guide] when upgrading from an earlier version.
2020

2121
To improve integration with existing Kafka sink connectors such as the https://docs.confluent.io/current/connect/connect-jdbc/docs/sink_connector.html[JDBC sink connector] or the https://docs.confluent.io/current/connect/connect-elasticsearch/docs/elasticsearch_connector.html[Elasticsearch] connector,
22-
Debezium provides a new https://github.com/debezium/debezium/blob/master/debezium-core/src/main/java/io/debezium/transforms/UnwrapFromEnvelope.java[single message transformation] (https://issues.redhat.com/projects/DBZ/issues/DBZ-226[DBZ-226]).
22+
Debezium provides a new https://github.com/debezium/debezium/blob/main/debezium-core/src/main/java/io/debezium/transforms/UnwrapFromEnvelope.java[single message transformation] (https://issues.redhat.com/projects/DBZ/issues/DBZ-226[DBZ-226]).
2323
This SMT converts Debezium's CDC event structure into a more conventional structure commonly used in other sink and non-CDC source connectors where the message represents the state of the inserted or updated row, or null in the case of a deleted row.
2424
This lets your for instance capture the changes from a table in MySQL and update a corresponding table in a Postgres database accordingly.
2525
We'll provide a complete example showing the usage of that new SMT in the next few days.
2626

27-
If you are doing the Debezium link:/docs/tutorial/[tutorial], you will like the new https://github.com/debezium/debezium-examples/tree/master/tutorial[Docker Compose set-up] provided in the examples repo (https://issues.redhat.com/browse/DBZ-127[DBZ-127]).
27+
If you are doing the Debezium link:/docs/tutorial/[tutorial], you will like the new https://github.com/debezium/debezium-examples/tree/main/tutorial[Docker Compose set-up] provided in the examples repo (https://issues.redhat.com/browse/DBZ-127[DBZ-127]).
2828
This lets you start all the required Docker containers with a single command.
2929

3030
== New connector features

_posts/2017-09-25-streaming-to-another-database.adoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -44,12 +44,12 @@ Figure 2: A Simplified topology
4444
====
4545

4646
== Configuration
47-
We will use this https://github.com/debezium/debezium-examples/tree/master/unwrap-smt[compose] for a fast deployment of the demo.
47+
We will use this https://github.com/debezium/debezium-examples/tree/main/unwrap-smt[compose] for a fast deployment of the demo.
4848
The deployment consists of following Docker images:
4949

5050
* https://hub.docker.com/r/debezium/zookeeper/[Apache ZooKeeper]
5151
* https://hub.docker.com/r/debezium/kafka/[Apache Kafka]
52-
* An https://github.com/debezium/debezium-examples/tree/master/unwrap-smt/debezium-jdbc[enriched] Kafka Connect / Debezium https://hub.docker.com/r/debezium/connect/[image] with changes
52+
* An https://github.com/debezium/debezium-examples/tree/main/unwrap-smt/debezium-jdbc[enriched] Kafka Connect / Debezium https://hub.docker.com/r/debezium/connect/[image] with changes
5353
** PostgreSQL JDBC driver placed into `/kafka/libs` directory
5454
** https://docs.confluent.io/current/connect/connect-jdbc/docs/index.html[Kafka Connect JDBC Connector] (developed by https://www.confluent.io/[Confluent]) placed into `/kafka/connect/kafka-connect-jdbc` directory
5555
* Pre-populated MySQL used in our link:docs/tutorial[tutorial]

_posts/2017-10-26-debezium-0-6-1-released.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Thanks a lot to https://github.com/vultron81[Ben Williams] who contributed this
3131

3232
== New example Docker images and Docker Compose files
3333

34-
In the https://github.com/debezium/debezium-examples/[Debezium examples repository] we now provide https://github.com/debezium/debezium-examples/tree/master/tutorial[Docker Compose files] which let you run the tutorial with all the three databases we currently support, MySQL, Postgres and MongoDB.
34+
In the https://github.com/debezium/debezium-examples/[Debezium examples repository] we now provide https://github.com/debezium/debezium-examples/tree/main/tutorial[Docker Compose files] which let you run the tutorial with all the three databases we currently support, MySQL, Postgres and MongoDB.
3535

3636
Just choose the Compose file for your preferred database and get a all the required components (ZooKeeper, Apache Kafka, Kafka Connect and the database) running within a few seconds.
3737

_posts/2017-11-15-debezium-0-6-2-released.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -45,7 +45,7 @@ Before, it could happen that single messages got lost during snapshotting which
4545

4646
== Examples and Docker Images
4747

48-
We have expanded our examples repository with https://github.com/debezium/debezium-examples/tree/master/tutorial#using-mysql-and-the-avro-message-format[an Avro example],
48+
We have expanded our examples repository with https://github.com/debezium/debezium-examples/tree/main/tutorial#using-mysql-and-the-avro-message-format[an Avro example],
4949
which may be interesting to you if you'd like to not work with JSON messages but rather the compact Avro binary format and the Confluent schema registry.
5050

5151
As a part of our release process we are now creating https://issues.redhat.com/projects/DBZ/issues/DBZ-418[micro tags] for our Docker images for every released version.

_posts/2018-01-17-streaming-to-elasticsearch.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -48,12 +48,12 @@ Figure 2: A simplified topology
4848

4949
== Configuration
5050

51-
We will use this https://github.com/debezium/debezium-examples/tree/master/unwrap-smt[Docker Compose file] for a fast deployment of the demo.
51+
We will use this https://github.com/debezium/debezium-examples/tree/main/unwrap-smt[Docker Compose file] for a fast deployment of the demo.
5252
The deployment consists of the following Docker images:
5353

5454
* https://hub.docker.com/r/debezium/zookeeper/[Apache ZooKeeper]
5555
* https://hub.docker.com/r/debezium/kafka/[Apache Kafka]
56-
* An https://github.com/debezium/debezium-examples/tree/master/unwrap-smt/debezium-jdbc[enriched] Kafka Connect / Debezium https://hub.docker.com/r/debezium/connect/[image] with a few changes:
56+
* An https://github.com/debezium/debezium-examples/tree/main/unwrap-smt/debezium-jdbc[enriched] Kafka Connect / Debezium https://hub.docker.com/r/debezium/connect/[image] with a few changes:
5757
** PostgreSQL JDBC driver placed into _/kafka/libs_ directory
5858
** The Confluent JDBC connector placed into _/kafka/connect/kafka-connect-jdbc_ directory
5959
* Pre-populated MySQL as used in our link:/docs/tutorial/[tutorial]
@@ -281,5 +281,5 @@ We managed to keep the same identifier across all systems which allows us to cor
281281
Propagating data changes from a primary database in near realtime to a search engine such as Elasticsearch enables many interesting use cases.
282282
Besides different applications of fulltext search one could for instance also think about creating dashboards and all kinds of visualizations using https://www.elastic.co/de/products/kibana[Kibana], to gain further insight into the data.
283283

284-
If you'd like to try out this set-up yourself, just clone the project from our https://github.com/debezium/debezium-examples/tree/master/unwrap-smt[examples repo].
284+
If you'd like to try out this set-up yourself, just clone the project from our https://github.com/debezium/debezium-examples/tree/main/unwrap-smt[examples repo].
285285
In case you need help, have feature requests or would like to share your experiences with this pipeline, please let us know in the comments below.

_posts/2018-03-08-creating-ddd-aggregates-with-debezium-and-kafka-streams.adoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ using the https://kafka.apache.org/documentation/streams/[Kafka Streams API].
6868

6969
== Capturing Change Events from a Data Source
7070

71-
The complete source code for this blog post is provided in the Debezium https://github.com/debezium/debezium-examples/tree/master/kstreams[examples repository] on GitHub.
71+
The complete source code for this blog post is provided in the Debezium https://github.com/debezium/debezium-examples/tree/main/kstreams[examples repository] on GitHub.
7272
Begin by cloning this repository and changing into the _kstreams_ directory:
7373

7474
[source,shell]

_posts/2018-05-24-querying-debezium-change-data-eEvents-with-ksql.adoc

+3-3
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ There is a `1:n` relation between `customers` and `orders`, modelled by the `pur
4141

4242
== Configuration
4343

44-
We are going to use a https://github.com/debezium/debezium-examples/blob/master/ksql/docker-compose.yaml[Docker Compose file] for the deployment of the environment.
44+
We are going to use a https://github.com/debezium/debezium-examples/blob/main/ksql/docker-compose.yaml[Docker Compose file] for the deployment of the environment.
4545
The deployment consists of the following Docker images:
4646

4747
* https://hub.docker.com/r/debezium/zookeeper/[Apache ZooKeeper]
@@ -294,7 +294,7 @@ So the final result of the select after the database is modified is
294294
We have successfully started a KSQL instance. We have mapped KSQL streams to Debezium topics filled by Debezium and made a join between them.
295295
We have also discussed the problem of repartioning in streaming applications.
296296

297-
If you'd like to try out this example with Avro encoding and schema registry then you can use our https://github.com/debezium/debezium-examples/blob/master/tutorial/docker-compose-mysql-avro.yaml[Avro example].
298-
Also for further details and more advanced usages just refer to the KSQL https://github.com/confluentinc/ksql/blob/master/docs/syntax-reference.md[syntax reference].
297+
If you'd like to try out this example with Avro encoding and schema registry then you can use our https://github.com/debezium/debezium-examples/blob/main/tutorial/docker-compose-mysql-avro.yaml[Avro example].
298+
Also for further details and more advanced usages just refer to the KSQL https://github.com/confluentinc/ksql/blob/main/docs/syntax-reference.md[syntax reference].
299299

300300
In case you need help, have feature requests or would like to share your experiences with this example, please let us know in the comments below.

0 commit comments

Comments
 (0)