Merge pull request #99 from data-catering/feature/clean-docs

Update links to use current repo instead of data-caterer-example repo

Author: pflooky

docs/docs/advanced.md

@@ -65,9 +65,9 @@ You can alter the `status` field in the account data to only generate `open` acc
 and define a foreign key between Postgres and parquet to ensure the same `account_id` is being used.  
 Then in the parquet task, define 1 to 10 transactions per `account_id` to be generated.
 
-[Postgres account generation example task](https://github.com/data-catering/data-caterer-example/blob/main/docker/data/custom/task/jdbc/postgres/postgres-account-task.yaml)  
-[Parquet transaction generation example task](https://github.com/data-catering/data-caterer-example/blob/main/docker/data/custom/task/file/parquet/parquet-transaction-task.yaml)  
-[Plan](https://github.com/data-catering/data-caterer-example/blob/main/docker/data/custom/plan/scenario-based.yaml)
+[Postgres account generation example task](https://github.com/data-catering/data-caterer/blob/main/example/docker/data/custom/task/jdbc/postgres/postgres-account-task.yaml)  
+[Parquet transaction generation example task](https://github.com/data-catering/data-caterer/blob/main/example/docker/data/custom/task/file/parquet/parquet-transaction-task.yaml)  
+[Plan](https://github.com/data-catering/data-caterer/blob/main/example/docker/data/custom/plan/scenario-based.yaml)
 
 ## Cloud storage
 

docs/docs/configuration.md

@@ -11,7 +11,7 @@ metadata gets saved.
 
 These configurations are defined from within your Java or Scala class via `configuration` or for YAML file setup,
 `application.conf` file as seen 
-[**here**](https://github.com/data-catering/data-caterer-example/blob/main/docker/data/custom/application.conf).
+[**here**](https://github.com/data-catering/data-caterer/blob/main/example/docker/data/custom/application.conf).
 
 ## Flags
 
@@ -109,7 +109,7 @@ Enable fast generation to maximize throughput. This automatically disables slowe
 sink metadata, unique checks, save reports, validations, alerts) and applies runtime optimizations (e.g. lower shuffle
 partitions, enable AQE, Kryo serializer) and increases `numRecordsPerBatch`.
 
-[:material-run-fast: Scala Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/scala/io/github/datacatering/plan/FastGenerationAndReferencePlanRun.scala) | [:material-coffee: Java Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/java/io/github/datacatering/plan/FastGenerationAndReferenceJavaPlanRun.java)
+[:material-run-fast: Scala Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/scala/io/github/datacatering/plan/FastGenerationAndReferencePlanRun.scala) | [:material-coffee: Java Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/java/io/github/datacatering/plan/FastGenerationAndReferenceJavaPlanRun.java)
 
 === "Java"
 

docs/docs/connection.md

@@ -534,7 +534,7 @@ found [**here**](https://spark.apache.org/docs/latest/structured-streaming-kafka
 
 When defining your schema for pushing data to Kafka, it follows a specific top level schema.  
 An example can be
-found [**here**](https://github.com/data-catering/data-caterer-example/blob/main/docker/data/custom/task/kafka/kafka-account-task.yaml)
+found [**here**](https://github.com/data-catering/data-caterer/blob/main/example/docker/data/custom/task/kafka/kafka-account-task.yaml)
 . You can define the key, value, headers, partition or topic by following the linked schema.
 
 ### JMS

docs/docs/deployment.md

@@ -19,7 +19,7 @@ Run the OS native application from [downloading the specific OS application here
 ## Docker
 
 To package up your class along with the Data Caterer base image, you can follow
-the [Dockerfile that is created for you here](https://github.com/data-catering/data-caterer-example/blob/main/Dockerfile).
+the [Dockerfile that is created for you here](https://github.com/data-catering/data-caterer/blob/main/example/Dockerfile).
 
 Then you can run the following:
 
@@ -30,13 +30,14 @@ docker build -t <my_image_name>:<my_image_tag> .
 
 ## Helm
 
-[Link to sample helm on GitHub here](https://github.com/data-catering/data-caterer-example/tree/main/helm/data-caterer)
+[Link to sample helm on GitHub here](https://github.com/data-catering/data-caterer/tree/main/example/helm/data-caterer)
 
 Update
-the [configuration](https://github.com/data-catering/data-caterer-example/blob/main/helm/data-caterer/templates/configuration.yaml)
+the [configuration](https://github.com/data-catering/data-caterer/blob/main/example/helm/data-caterer/templates/configuration.yaml)
 to your own data connections and configuration or own image created from above.
 
 ```shell
-git clone git@github.com:data-catering/data-caterer-example.git
-helm install data-caterer ./data-caterer-example/helm/data-caterer
+git clone git@github.com:data-catering/data-caterer.git
+    cd data-caterer/example
+helm install data-caterer ./data-caterer/example/helm/data-caterer
 ```

docs/docs/generator/data-generator.md

@@ -60,7 +60,7 @@ Förlåt", "你好吗", "Nhà vệ sinh ở đâu", "こんにちは", "नम
 
 #### Sample
 
-[:material-run-fast: Scala Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/scala/io/github/datacatering/plan/DocumentationPlanRun.scala) | [:material-coffee: Java Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/java/io/github/datacatering/plan/DocumentationJavaPlanRun.java)
+[:material-run-fast: Scala Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/scala/io/github/datacatering/plan/DocumentationPlanRun.scala) | [:material-coffee: Java Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/java/io/github/datacatering/plan/DocumentationJavaPlanRun.java)
 
 === "Java"
 
@@ -643,7 +643,7 @@ You can control behavior at the step level for generation.
 
 Disable data generation for specific steps when you want to use them only for reference in foreign key relationships.
 
-[:material-run-fast: Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/scala/io/github/datacatering/plan/FastGenerationAndReferencePlanRun.scala)
+[:material-run-fast: Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/scala/io/github/datacatering/plan/FastGenerationAndReferencePlanRun.scala)
 
 === "Java"
 
@@ -688,7 +688,7 @@ Disable data generation for specific steps when you want to use them only for re
 
 Control data partitioning and parallelism for improved performance with large datasets.
 
-[:material-run-fast: Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/scala/io/github/datacatering/plan/FastGenerationAndReferencePlanRun.scala)
+[:material-run-fast: Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/scala/io/github/datacatering/plan/FastGenerationAndReferencePlanRun.scala)
 
 === "Java"
 
@@ -727,7 +727,7 @@ Control data partitioning and parallelism for improved performance with large da
 
 Use existing data as reference instead of generating new data for a step. This is useful when you want to reference real data in foreign key relationships.
 
-[:material-run-fast: Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/scala/io/github/datacatering/plan/FastGenerationAndReferencePlanRun.scala)
+[:material-run-fast: Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/scala/io/github/datacatering/plan/FastGenerationAndReferencePlanRun.scala)
 
 === "Java"
 
@@ -760,7 +760,7 @@ Use existing data as reference instead of generating new data for a step. This i
 
 For databases that support primary key positions and clustering order (like Cassandra), you can specify the order of primary keys and clustering keys.
 
-[:material-run-fast: Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/scala/io/github/datacatering/plan/FastGenerationAndReferencePlanRun.scala)
+[:material-run-fast: Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/scala/io/github/datacatering/plan/FastGenerationAndReferencePlanRun.scala)
 
 === "Java"
 
@@ -809,7 +809,7 @@ For databases that support primary key positions and clustering order (like Cass
 
 Data Caterer supports complex SQL expressions for generating sophisticated data relationships and calculations. SQL expressions are evaluated after all non-SQL fields have been generated.
 
-[:material-run-fast: Scala Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/scala/io/github/datacatering/plan/DocumentationPlanRun.scala) | [:material-coffee: Java Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/java/io/github/datacatering/plan/DocumentationJavaPlanRun.java)
+[:material-run-fast: Scala Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/scala/io/github/datacatering/plan/DocumentationPlanRun.scala) | [:material-coffee: Java Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/java/io/github/datacatering/plan/DocumentationJavaPlanRun.java)
 
 ### Array Operations and Aggregations
 

docs/docs/guide/data-source/database/bigquery.md

@@ -21,24 +21,27 @@ for the tables you configure.
 
 ## Get Started
 
-First, we will clone the data-caterer-example repo which will already have the base project setup required.
+First, we will clone the data-caterer repo which will already have the base project setup required.
 
 === "Java"
 
     ```shell
-    git clone git@github.com:data-catering/data-caterer-example.git
+    git clone git@github.com:data-catering/data-caterer.git
+    cd data-caterer/example
     ```
 
 === "Scala"
 
     ```shell
-    git clone git@github.com:data-catering/data-caterer-example.git
+    git clone git@github.com:data-catering/data-caterer.git
+    cd data-caterer/example
     ```
 
 === "YAML"
 
     ```shell
-    git clone git@github.com:data-catering/data-caterer-example.git
+    git clone git@github.com:data-catering/data-caterer.git
+    cd data-caterer/example
     ```
 
 === "UI"
@@ -348,7 +351,7 @@ To tell Data Caterer that we want to run with the configurations along with the
 
 ### Run
 
-Now we can run via the script `./run.sh` that is in the top level directory of the `data-caterer-example` to run the
+Now we can run via the script `./run.sh` that is in the top level directory of the `data-caterer/example` folder to run the
 class we just
 created.
 

docs/docs/guide/data-source/database/cassandra.md

@@ -9,7 +9,7 @@ image: "https://data.catering/diagrams/logo/data_catering_logo.svg"
 Creating a data generator for Cassandra. You will build a Docker image that will be able to populate data in Cassandra
 for the tables you configure.
 
-[:material-run-fast: Scala Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/scala/io/github/datacatering/plan/CassandraPlanRun.scala) | [:material-coffee: Java Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/java/io/github/datacatering/plan/CassandraJavaPlanRun.java) | [:material-file-yaml-outline: Basic YAML](https://github.com/data-catering/data-caterer-example/blob/main/docker/data/custom/task/cassandra) | [:material-file-yaml-outline: Advanced YAML](https://github.com/data-catering/data-caterer-example/blob/main/docker/data/custom/task/cassandra/advanced-cassandra-task.yaml)
+[:material-run-fast: Scala Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/scala/io/github/datacatering/plan/CassandraPlanRun.scala) | [:material-coffee: Java Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/java/io/github/datacatering/plan/CassandraJavaPlanRun.java) | [:material-file-yaml-outline: Basic YAML](https://github.com/data-catering/data-caterer/blob/main/example/docker/data/custom/task/cassandra) | [:material-file-yaml-outline: Advanced YAML](https://github.com/data-catering/data-caterer/blob/main/example/docker/data/custom/task/cassandra/advanced-cassandra-task.yaml)
 
 ## Requirements
 
@@ -21,24 +21,27 @@ for the tables you configure.
 
 ## Get Started
 
-First, we will clone the data-caterer-example repo which will already have the base project setup required.
+First, we will clone the data-caterer repo which will already have the base project setup required.
 
 === "Java"
 
     ```shell
-    git clone git@github.com:data-catering/data-caterer-example.git
+    git clone git@github.com:data-catering/data-caterer.git
+    cd data-caterer/example
     ```
 
 === "Scala"
 
     ```shell
-    git clone git@github.com:data-catering/data-caterer-example.git
+    git clone git@github.com:data-catering/data-caterer.git
+    cd data-caterer/example
     ```
 
 === "YAML"
 
     ```shell
-    git clone git@github.com:data-catering/data-caterer-example.git
+    git clone git@github.com:data-catering/data-caterer.git
+    cd data-caterer/example
     ```
 
 === "UI"
@@ -405,7 +408,7 @@ To tell Data Caterer that we want to run with the configurations along with the
 
 ### Run
 
-Now we can run via the script `./run.sh` that is in the top level directory of the `data-caterer-example` to run the class we just
+Now we can run via the script `./run.sh` that is in the top level directory of the `data-caterer/example` folder to run the class we just
 created.
 
 === "Java"

docs/docs/guide/data-source/database/mysql.md

@@ -9,7 +9,7 @@ image: "https://data.catering/diagrams/logo/data_catering_logo.svg"
 Creating a data generator for MySQL. You will build a Docker image that will be able to populate data in MySQL
 for the tables you configure.
 
-[:material-run-fast: Scala Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/scala/io/github/datacatering/plan/MySqlPlanRun.scala) | [:material-coffee: Java Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/java/io/github/datacatering/plan/MySqlJavaPlanRun.java) | [:material-file-yaml-outline: YAML Example](https://github.com/data-catering/data-caterer-example/blob/main/docker/data/custom/task/jdbc/mysql)
+[:material-run-fast: Scala Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/scala/io/github/datacatering/plan/MySqlPlanRun.scala) | [:material-coffee: Java Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/java/io/github/datacatering/plan/MySqlJavaPlanRun.java) | [:material-file-yaml-outline: YAML Example](https://github.com/data-catering/data-caterer/blob/main/example/docker/data/custom/task/jdbc/mysql)
 
 ## Requirements
 
@@ -20,24 +20,27 @@ for the tables you configure.
 
 ## Get Started
 
-First, we will clone the data-caterer-example repo which will already have the base project setup required.
+First, we will clone the data-caterer repo which will already have the base project setup required.
 
 === "Java"
 
     ```shell
-    git clone git@github.com:data-catering/data-caterer-example.git
+    git clone git@github.com:data-catering/data-caterer.git
+    cd data-caterer/example
     ```
 
 === "Scala"
 
     ```shell
-    git clone git@github.com:data-catering/data-caterer-example.git
+    git clone git@github.com:data-catering/data-caterer.git
+    cd data-caterer/example
     ```
 
 === "YAML"
 
     ```shell
-    git clone git@github.com:data-catering/data-caterer-example.git
+    git clone git@github.com:data-catering/data-caterer.git
+    cd data-caterer/example
     ```
 
 === "UI"
@@ -374,7 +377,7 @@ To tell Data Caterer that we want to run with the configurations along with the
 
 ### Run
 
-Now we can run via the script `./run.sh` that is in the top level directory of the `data-caterer-example` to run the
+Now we can run via the script `./run.sh` that is in the top level directory of the `data-caterer/example` folder to run the
 class we just
 created.
 

docs/docs/guide/data-source/database/postgres.md

@@ -9,7 +9,7 @@ image: "https://data.catering/diagrams/logo/data_catering_logo.svg"
 Creating a data generator for Postgres. You will build a Docker image that will be able to populate data in Postgres
 for the tables you configure.
 
-[:material-run-fast: Scala Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/scala/io/github/datacatering/plan/PostgresPlanRun.scala) | [:material-coffee: Java Example](https://github.com/data-catering/data-caterer-example/blob/main/src/main/java/io/github/datacatering/plan/PostgresJavaPlanRun.java) | [:material-file-yaml-outline: YAML Example](https://github.com/data-catering/data-caterer-example/blob/main/docker/data/custom/task/jdbc/postgres)
+[:material-run-fast: Scala Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/scala/io/github/datacatering/plan/PostgresPlanRun.scala) | [:material-coffee: Java Example](https://github.com/data-catering/data-caterer/blob/main/example/src/main/java/io/github/datacatering/plan/PostgresJavaPlanRun.java) | [:material-file-yaml-outline: YAML Example](https://github.com/data-catering/data-caterer/blob/main/example/docker/data/custom/task/jdbc/postgres)
 
 ## Requirements
 
@@ -20,24 +20,27 @@ for the tables you configure.
 
 ## Get Started
 
-First, we will clone the data-caterer-example repo which will already have the base project setup required.
+First, we will clone the data-caterer repo which will already have the base project setup required.
 
 === "Java"
 
     ```shell
-    git clone git@github.com:data-catering/data-caterer-example.git
+    git clone git@github.com:data-catering/data-caterer.git
+    cd data-caterer/example
     ```
 
 === "Scala"
 
     ```shell
-    git clone git@github.com:data-catering/data-caterer-example.git
+    git clone git@github.com:data-catering/data-caterer.git
+    cd data-caterer/example
     ```
 
 === "YAML"
 
     ```shell
-    git clone git@github.com:data-catering/data-caterer-example.git
+    git clone git@github.com:data-catering/data-caterer.git
+    cd data-caterer/example
     ```
 
 === "UI"
@@ -374,7 +377,7 @@ To tell Data Caterer that we want to run with the configurations along with the
 
 ### Run
 
-Now we can run via the script `./run.sh` that is in the top level directory of the `data-caterer-example` to run the
+Now we can run via the script `./run.sh` that is in the top level directory of the `data-caterer/example` folder to run the
 class we just
 created.