forked from dbt-labs/docs.getdbt.com
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Adding a note to the readme about explicitly installing homebrew, and possibly needing libvips
- Loading branch information
Showing
1 changed file
with
12 additions
and
10 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -16,16 +16,18 @@ We welcome contributions from community members to this repo: | |
|
|
||
| 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. Clone this repo: `git clone [email protected]:fishtown-analytics/docs.getdbt.com.git` | ||
| 3. `cd` into the repo: `cd docs.getdbt.com` | ||
| 4. `cd` into the `website` subdirectory: `cd website` | ||
| 5. Install the required node packages: `npm install` | ||
| 6. Build the website: `npm start` | ||
| 7. 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. | ||
| 0. If applicable, install [Xcode Command Line Tools](https://developer.apple.com/download/more/); you'll likely need an AppleID for this. You will also need [homebrew](https://brew.sh/). | ||
| 2. Install `node`: `brew install node` | ||
| 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. | ||
| - If you run into an `fatal error: 'vips/vips8' file not found` error when you run `npm install`, you may need to run `brew install vips`. Warning: this one will take a while -- go ahead and grab some coffee! | ||
|
|
||
| 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! | ||
|
|
||
|
|
||