Flink SQL clone instructions (#7) (#66)

* fix: add repo clone instructions to Flink tutorials * fix: improve header font in Flink SQL run instructions
confluentinc · Aug 30, 2024 · 4ba3350 · 4ba3350
1 parent 4df8a09
commit 4ba3350
Show file tree

Hide file tree

Showing 17 changed files with 461 additions and 241 deletions.
diff --git a/aggregating-count/flinksql/README.md b/aggregating-count/flinksql/README.md
@@ -38,14 +38,21 @@ against Flink and Kafka running in Docker, or with Confluent Cloud.
 <details>
   <summary>Flink Table API-based test</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * Java 17, e.g., follow the OpenJDK installation instructions [here](https://openjdk.org/install/) if you don't have Java. 
   * Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
 
-  #### Run the test
+  ### Run the test
 
-Run the following command to execute [FlinkSqlAggregatingCountTest#testCountAggregation](src/test/java/io/confluent/developer/FlinkSqlAggregatingCountTest.java):
+  Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
+
+  ```shell
+  git clone [email protected]:confluentinc/tutorials.git
+  cd tutorials
+  ```
+
+  Run the following command to execute [FlinkSqlAggregatingCountTest#testCountAggregation](src/test/java/io/confluent/developer/FlinkSqlAggregatingCountTest.java):
 
   ```plaintext
   ./gradlew clean :aggregating-count:flinksql:test
@@ -58,14 +65,21 @@ Run the following command to execute [FlinkSqlAggregatingCountTest#testCountAggr
 <details>
   <summary>Flink SQL Client CLI</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
   * [Docker Compose](https://docs.docker.com/compose/install/). Ensure that the command `docker compose version` succeeds.
 
-  #### Run the commands
+  ### Run the commands
+
+  Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
+
+  ```shell
+  git clone [email protected]:confluentinc/tutorials.git
+  cd tutorials
+  ```
 
-  First, start Flink and Kafka:
+  Start Flink and Kafka:
 
   ```shell
   docker compose -f ./docker/docker-compose-flinksql.yml up -d
@@ -123,11 +137,11 @@ Run the following command to execute [FlinkSqlAggregatingCountTest#testCountAggr
 
   ```plaintext
              title tickets_sold
-  ---------------- -----------
-            Aliens           1
-          Die Hard           3
-  The Big Lebowski           2
-     The Godfather           4
+  ---------------- ------------
+            Aliens            1
+          Die Hard            3
+  The Big Lebowski            2
+     The Godfather            4
   ```
 
   When you are finished, clean up the containers used for this tutorial by running:
@@ -141,12 +155,12 @@ Run the following command to execute [FlinkSqlAggregatingCountTest#testCountAggr
 <details>
   <summary>Confluent Cloud</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * A [Confluent Cloud](https://confluent.cloud/signup) account
   * A Flink compute pool created in Confluent Cloud. Follow [this](https://docs.confluent.io/cloud/current/flink/get-started/quick-start-cloud-console.html) quick start to create one.
 
-  #### Run the commands
+  ### Run the commands
 
   In the Confluent Cloud Console, navigate to your environment and then click the `Open SQL Workspace` button for the compute
   pool that you have created.

diff --git a/aggregating-minmax/flinksql/README.md b/aggregating-minmax/flinksql/README.md
@@ -41,14 +41,21 @@ against Flink and Kafka running in Docker, or with Confluent Cloud.
 <details>
   <summary>Flink Table API-based test</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * Java 17, e.g., follow the OpenJDK installation instructions [here](https://openjdk.org/install/) if you don't have Java. 
   * Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
 
-  #### Run the test
+  ### Run the test
 
-Run the following command to execute [FlinkSqlAggregatingMinMaxTest#testMinMax](src/test/java/io/confluent/developer/FlinkSqlAggregatingMinMaxTest.java):
+  Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
+
+  ```shell
+  git clone [email protected]:confluentinc/tutorials.git
+  cd tutorials
+  ```
+
+  Run the following command to execute [FlinkSqlAggregatingMinMaxTest#testMinMax](src/test/java/io/confluent/developer/FlinkSqlAggregatingMinMaxTest.java):
 
   ```plaintext
   ./gradlew clean :aggregating-minmax:flinksql:test
@@ -61,14 +68,21 @@ Run the following command to execute [FlinkSqlAggregatingMinMaxTest#testMinMax](
 <details>
   <summary>Flink SQL Client CLI</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
   * [Docker Compose](https://docs.docker.com/compose/install/). Ensure that the command `docker compose version` succeeds.
 
-  #### Run the commands
+  ### Run the commands
+
+  Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
+
+  ```shell
+  git clone [email protected]:confluentinc/tutorials.git
+  cd tutorials
+  ```
 
-  First, start Flink and Kafka:
+  Start Flink and Kafka:
 
   ```shell
   docker compose -f ./docker/docker-compose-flinksql.yml up -d
@@ -146,12 +160,12 @@ Run the following command to execute [FlinkSqlAggregatingMinMaxTest#testMinMax](
 <details>
   <summary>Confluent Cloud</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * A [Confluent Cloud](https://confluent.cloud/signup) account
   * A Flink compute pool created in Confluent Cloud. Follow [this](https://docs.confluent.io/cloud/current/flink/get-started/quick-start-cloud-console.html) quick start to create one.
 
-  #### Run the commands
+  ### Run the commands
 
   In the Confluent Cloud Console, navigate to your environment and then click the `Open SQL Workspace` button for the compute
   pool that you have created.

diff --git a/cumulating-windows/flinksql/README.md b/cumulating-windows/flinksql/README.md
@@ -54,14 +54,21 @@ against Flink and Kafka running in Docker, or with Confluent Cloud.
 <details>
   <summary>Flink Table API-based test</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * Java 17, e.g., follow the OpenJDK installation instructions [here](https://openjdk.org/install/) if you don't have Java. 
   * Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
 
-  #### Run the test
+  ### Run the test
 
-Run the following command to execute [FlinkSqlCumulatingWindowTest#testCumulatingWindows](src/test/java/io/confluent/developer/FlinkSqlCumulatingWindowTest.java):
+  Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
+
+  ```shell
+  git clone [email protected]:confluentinc/tutorials.git
+  cd tutorials
+  ```
+
+  Run the following command to execute [FlinkSqlCumulatingWindowTest#testCumulatingWindows](src/test/java/io/confluent/developer/FlinkSqlCumulatingWindowTest.java):
 
   ```plaintext
   ./gradlew clean :cunulating-windows:flinksql:test
@@ -74,14 +81,21 @@ Run the following command to execute [FlinkSqlCumulatingWindowTest#testCumulatin
 <details>
   <summary>Flink SQL Client CLI</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
   * [Docker Compose](https://docs.docker.com/compose/install/). Ensure that the command `docker compose version` succeeds.
 
-  #### Run the commands
+  ### Run the commands
+
+  Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
+
+  ```shell
+  git clone [email protected]:confluentinc/tutorials.git
+  cd tutorials
+  ```
 
-  First, start Flink and Kafka:
+  Start Flink and Kafka:
 
   ```shell
   docker compose -f ./docker/docker-compose-flinksql.yml up -d
@@ -161,12 +175,12 @@ Run the following command to execute [FlinkSqlCumulatingWindowTest#testCumulatin
 <details>
   <summary>Confluent Cloud</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * A [Confluent Cloud](https://confluent.cloud/signup) account
   * A Flink compute pool created in Confluent Cloud. Follow [this](https://docs.confluent.io/cloud/current/flink/get-started/quick-start-cloud-console.html) quick start to create one.
 
-  #### Run the commands
+  ### Run the commands
 
   In the Confluent Cloud Console, navigate to your environment and then click the `Open SQL Workspace` button for the compute
   pool that you have created.

diff --git a/deduplication-windowed/flinksql/README.md b/deduplication-windowed/flinksql/README.md
@@ -50,14 +50,21 @@ against Flink and Kafka running in Docker, or with Confluent Cloud.
 <details>
   <summary>Flink Table API-based test</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * Java 11, e.g., follow the OpenJDK installation instructions [here](https://openjdk.org/install/) if you don't have Java. 
   * Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
 
-  #### Run the test
+  ### Run the test
 
-Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistinct](src/test/java/io/confluent/developer/FlinkSqlFindingDistinctTest.java):
+  Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
+
+  ```shell
+  git clone [email protected]:confluentinc/tutorials.git
+  cd tutorials
+  ```
+
+  Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistinct](src/test/java/io/confluent/developer/FlinkSqlFindingDistinctTest.java):
 
   ```plaintext
   ./gradlew clean :deduplication-windowed:flinksql:test
@@ -70,14 +77,21 @@ Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistin
 <details>
   <summary>Flink SQL Client CLI</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
   * [Docker Compose](https://docs.docker.com/compose/install/). Ensure that the command `docker compose version` succeeds.
 
-  #### Run the commands
+  ### Run the commands
+
+  Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
+
+  ```shell
+  git clone [email protected]:confluentinc/tutorials.git
+  cd tutorials
+  ```
 
-  First, start Flink and Kafka:
+  Start Flink and Kafka:
 
   ```shell
   docker compose -f ./docker/docker-compose-flinksql.yml up -d
@@ -154,12 +168,12 @@ Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistin
 <details>
   <summary>Confluent Cloud</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * A [Confluent Cloud](https://confluent.cloud/signup) account
   * A Flink compute pool created in Confluent Cloud. Follow [this](https://docs.confluent.io/cloud/current/flink/get-started/quick-start-cloud-console.html) quick start to create one.
 
-  #### Run the commands
+  ### Run the commands
 
   In the Confluent Cloud Console, navigate to your environment and then click the `Open SQL Workspace` button for the compute
   pool that you have created.

diff --git a/deduplication/flinksql/README.md b/deduplication/flinksql/README.md
@@ -46,14 +46,21 @@ against Flink and Kafka running in Docker, or with Confluent Cloud.
 <details>
   <summary>Flink Table API-based test</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * Java 17, e.g., follow the OpenJDK installation instructions [here](https://openjdk.org/install/) if you don't have Java. 
   * Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
 
-  #### Run the test
+  ### Run the test
 
-Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistinct](src/test/java/io/confluent/developer/FlinkSqlFindingDistinctTest.java):
+  Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
+
+  ```shell
+  git clone [email protected]:confluentinc/tutorials.git
+  cd tutorials
+  ```
+
+  Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistinct](src/test/java/io/confluent/developer/FlinkSqlFindingDistinctTest.java):
 
   ```plaintext
   ./gradlew clean :deduplication:flinksql:test
@@ -66,14 +73,21 @@ Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistin
 <details>
   <summary>Flink SQL Client CLI</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * Docker running via [Docker Desktop](https://docs.docker.com/desktop/) or [Docker Engine](https://docs.docker.com/engine/install/)
   * [Docker Compose](https://docs.docker.com/compose/install/). Ensure that the command `docker compose version` succeeds.
 
-  #### Run the commands
+  ### Run the commands
+
+  Clone the `confluentinc/tutorials` GitHub repository (if you haven't already) and navigate to the `tutorials` directory:
+
+  ```shell
+  git clone [email protected]:confluentinc/tutorials.git
+  cd tutorials
+  ```
 
-  First, start Flink and Kafka:
+  Start Flink and Kafka:
 
   ```shell
   docker compose -f ./docker/docker-compose-flinksql.yml up -d
@@ -145,12 +159,12 @@ Run the following command to execute [FlinkSqlFindingDistinctTest#testFindDistin
 <details>
   <summary>Confluent Cloud</summary>
 
-  #### Prerequisites
+  ### Prerequisites
 
   * A [Confluent Cloud](https://confluent.cloud/signup) account
   * A Flink compute pool created in Confluent Cloud. Follow [this](https://docs.confluent.io/cloud/current/flink/get-started/quick-start-cloud-console.html) quick start to create one.
 
-  #### Run the commands
+  ### Run the commands
 
   In the Confluent Cloud Console, navigate to your environment and then click the `Open SQL Workspace` button for the compute
   pool that you have created.