From a43895ac969c47d64a044ad2e8f458af082423d8 Mon Sep 17 00:00:00 2001 From: Douglas Wade Date: Fri, 7 Apr 2017 11:03:23 -0700 Subject: [PATCH] Document LOCAL_DOCS for website (#909) --- CONTRIBUTING.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 921ec6e02..dcb01047a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -136,6 +136,15 @@ CI test target runs many packages' tests simultaneously, so its important that every server starts on a unique port. You can find the manifest in the docs. +If you're making changes to the website, you'll want it to use the docs that are +checked out on disk, rather than on github (we get the markdown directly from +github so we don't have to reploy the site every time we update the docs). You +can do this by setting the `LOCAL_DOCS` environment variable. + +```sh +LOCAL_DOCS=1 npm start +``` + ## Contributor License Agreement To get started, please [sign the Contributor License