Prune dependency warnings and update readme instructions.

dbirks · Sep 25, 2020 · 8ca3799 · 8ca3799
1 parent 451f381
commit 8ca3799
Show file tree

Hide file tree

Showing 3 changed files with 73 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -12,14 +12,21 @@ We welcome contributions from community members to this repo:
 - **New documentation**: If you contributed code in [dbt-core](https://github.com/fishtown-analytics/dbt), we encourage you to also write the docs here!
 - **Refactors**: At this time, we are unable to support community members who wish to re-write sections of docs.getdbt.com. We hope to change this in the future!
 
-If you are contributing significant changes, it may be worth setting up the repo to run locally, as follows:
-1. Ensure node is installed: `brew install node`
-2. Clone this repo: `git clone [email protected]:fishtown-analytics/docs.getdbt.com.git`
-3. `cd` into the repo: `cd docs.getdbt.com`
-3. And then `cd` into the `website` subdirectory: `cd website`
-4. Install the required node packages: `npm install`
-5. Build the website: `npm start`
-6. Before pushing your changes to a branch, check that all links work by using the `make build` script.
+### Running the Docs site locally
+
+We recommend locally rendering changes made to the docs site so you can review your proposed modifications. Our setup instructions use [homebrew](https://brew.sh/):
+
+0. If applicable, install [Xcode CLTs](https://developer.apple.com/download/more/); you'll likely need an AppleID for this.
+1. Install `node`: `brew install node`
+2. Install `yarn`: `brew install yarn`
+3. Clone this repo: `git clone [email protected]:fishtown-analytics/docs.getdbt.com.git`
+4. `cd` into the repo: `cd docs.getdbt.com`
+5. `cd` into the `website` subdirectory: `cd website`
+6. Install the required node packages: `npm install`
+7. Build the website: `npm start`
+8. Before pushing your changes to a branch, check that all links work by using the `make build` script.
+
+Advisory: Currently an `npm install` produces a number of depedency warnings, in particular several claiming that `docusaurus/core` is missing. Rest assured, this message is a red herring. As of writing this, no 2.0.0 package exists, so you won't have much luck trying to install it. Feel free to ignore those warnings.
 
 You can also check out [this Loom video](https://www.loom.com/share/7037780b86eb4f16953664b8f15f1e21) that I recorded for co-workers — it covers setting up docs.getdbt.com locally, and adding a page with links and images. Heads up — this was very much something I did on the fly, so is not super polished!
 

diff --git a/website/package-lock.json b/website/package-lock.json
diff --git a/website/package.json b/website/package.json
@@ -12,6 +12,7 @@
     "classnames": "^2.2.6",
     "color": "^3.1.2",
     "core-js": "^3.6.4",
+    "file-loader": "^6.1.0",
     "mobx": "^4.15.4",
     "react": "^16.13.1",
     "react-dom": "^16.13.0",