Updating readme with additional instructions
@@ -13,21 +13,20 @@ You should also visit [DataHub Architecture](docs/architecture/architecture.md)
This repository contains the complete source code to be able to build DataHub's frontend & backend services.
## Quickstart
-1. Install [docker](https://docs.docker.com/install/) and [docker-compose](https://docs.docker.com/compose/install/).
+1. Install [docker](https://docs.docker.com/install/) and [docker-compose](https://docs.docker.com/compose/install/). Make sure to configure Docker to allocate enough hardware resources for Docker engine. Tested & confirmed config: 4 CPUs, 8GB RAM, 2GB Swap area.
2. Clone this repo.
3. Open Docker either from the command line or the Desktop app and ensure it is up and running then `cd` into the cloned `datahub` repo.
4. Run below command to download and run all Docker containers in your local:
```
cd docker/quickstart && docker-compose pull && docker-compose up --build
```
-5. After you have all Docker containers running in your machine:
-
- Switch to a new terminal, `cd` into the clone repo and run below command to ingest provided sample data to DataHub:
+This step takes long time and it might be hard to figure out when DataHub is fully up. You can refer to [this guide](https://github.com/linkedin/datahub/blob/master/docs/debugging.md#how-can-i-confirm-if-all-docker-containers-are-running-as-expected-after-a-quickstart) to confirm DataHub is up and running.
+5. At this point, you should be able to start `DataHub` by opening [http://localhost:9001](http://localhost:9001) in your browser. You can sign in using `datahub` as both username and password. However, there is no data just yet.
+6. To ingest [provided](https://github.com/linkedin/datahub/blob/master/metadata-ingestion/mce-cli/bootstrap_mce.dat) sample data to DataHub, switch to a new terminal, `cd` into the cloned `datahub` repo, and run below command:
```
docker build -t ingestion -f docker/ingestion/Dockerfile . && cd docker/ingestion && docker-compose up
```
- > Note : If ingestion command is not run, you may not have enough sample data to explore the application and its features.
-6. Finally, you can start `DataHub` by opening [http://localhost:9001](http://localhost:9001) in your browser. You can sign in using `datahub` as both username and password.
+After running this, you should be able to see sample data in DataHub.
Refer to [debugging guide](docs/debugging.md) if you have issues in any of the above steps.
