From 1cee269fe1f807da4967241a735a684a1a1c9fbf Mon Sep 17 00:00:00 2001 From: czgu Date: Fri, 5 Feb 2021 15:41:54 -0500 Subject: [PATCH] Document querybook dev experience on windows (#415) --- docs | 1 - docs_website/docs/setup_guide/quick_setup.md | 7 ++++++- querybook/server/const/path.py | 2 +- 3 files changed, 7 insertions(+), 3 deletions(-) delete mode 120000 docs diff --git a/docs b/docs deleted file mode 120000 index 681e60f3a..000000000 --- a/docs +++ /dev/null @@ -1 +0,0 @@ -docs_website/docs/ \ No newline at end of file diff --git a/docs_website/docs/setup_guide/quick_setup.md b/docs_website/docs/setup_guide/quick_setup.md index 0f6d1d5c9..babf9d604 100644 --- a/docs_website/docs/setup_guide/quick_setup.md +++ b/docs_website/docs/setup_guide/quick_setup.md @@ -12,7 +12,7 @@ sidebar_label: Quick Setup ### System requirements: -- 6GB of free RAM +- 5GB of free RAM (10GB for Windows WSL) - 5GB of disk space ### Kernel Config @@ -25,6 +25,11 @@ Run `sudo sysctl -w vm.max_map_count=262144` to ensure [ElasticSearch](https://w Go to the `Docker Desktop` app -> top right gear icon -> Preferences -> Resources -> Advanced. Make sure your memory limit per app is >= 3GB. +#### Windows +Please install WSL 2 as instructed [here](https://docs.microsoft.com/en-us/windows/wsl/install-win10). Now go to Docker Desktop, Settings > General, and check the box "Use the WSL 2 based Engine". + +Launch WSL shell and run `sudo sysctl -w vm.max_map_count=262144` to ensure [ElasticSearch](https://www.elastic.co/guide/en/elasticsearch/reference/current/vm-max-map-count.html) works. + ## Getting Started After cloning the repo, run the following diff --git a/querybook/server/const/path.py b/querybook/server/const/path.py index be076a3c1..d2c08d718 100644 --- a/querybook/server/const/path.py +++ b/querybook/server/const/path.py @@ -6,4 +6,4 @@ CONFIG_PATH = os.path.join(PROJECT_ROOT_PATH, "./querybook/config") WEBAPP_DIR_PATH = os.path.join(PROJECT_ROOT_PATH, "./dist/webapp/") WEBAPP_INDEX_PATH = os.path.join(WEBAPP_DIR_PATH, "index.html") -CHANGE_LOG_PATH = os.path.join(PROJECT_ROOT_PATH, "./docs/changelog/") +CHANGE_LOG_PATH = os.path.join(PROJECT_ROOT_PATH, "./docs_website/docs/changelog/")