From 6b4b86c4198df4d992a0969fee7e712656cc83f5 Mon Sep 17 00:00:00 2001 From: Meghajit Mazumdar Date: Mon, 26 Sep 2022 19:23:39 +0530 Subject: [PATCH] docs: add git clone command - add link to quickstart in readme --- README.md | 13 +------------ docs/docs/guides/quickstart.md | 6 +++++- 2 files changed, 6 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 6d15144c7..915a82e7c 100644 --- a/README.md +++ b/README.md @@ -41,20 +41,9 @@ Explore the following resources to get started with Dagger: * [Usecase](https://odpf.github.io/dagger/docs/usecase/overview) describes examples use cases which can be solved via Dagger. ## Running locally -Make sure you have Java8 and local kafka-2.4+ setup pre-installed on your local machine. -```sh -# Clone the repo -$ git clone https://github.com/odpf/dagger.git - -# Build the jar -$ ./gradlew clean build -# Configure env variables -$ cat dagger-core/env/local.properties +Please follow this [Dagger Quickstart Guide](https://odpf.github.io/dagger/docs/guides/quickstart) for setting up a local running Dagger consuming from Kafka. -# Run a Dagger -$ ./gradlew dagger-core:runFlink -``` **Note:** Sample configuration for running a basic dagger can be found [here](https://odpf.github.io/dagger/docs/guides/create_dagger#common-configurations). For detailed configurations, refer [here](https://odpf.github.io/dagger/docs/reference/configuration). Find more detailed steps on local setup [here](https://odpf.github.io/dagger/docs/guides/create_dagger). diff --git a/docs/docs/guides/quickstart.md b/docs/docs/guides/quickstart.md index fa9f719d8..5fd1e852b 100644 --- a/docs/docs/guides/quickstart.md +++ b/docs/docs/guides/quickstart.md @@ -10,7 +10,11 @@ ## Quickstart -1. Clone dagger repository into you local. Git checkout into the main branch. +1. Clone Dagger repository into your local + +```shell +git clone https://github.com/odpf/dagger.git +``` 2. Next, we will generate our proto descriptor set. Ensure you are at the top level directory(`dagger`) and then fire this command ```