Document querybook dev experience on windows (#415)

pinterest · Feb 5, 2021 · 1cee269 · 1cee269
1 parent cdd9b02
commit 1cee269
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 3 deletions.
diff --git a/docs b/docs
diff --git 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
@@ -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/")