docs: Update the instructions for how to build the docs#9829
docs: Update the instructions for how to build the docs#9829joelostblom wants to merge 5 commits into
Conversation
| vega: 6.2.0 | ||
| vega-lite: 6.4.2 | ||
| vega-embed: 7.1.0 | ||
| vega-tooltip: 1.1.0 |
There was a problem hiding this comment.
These were automatically updated when I build the docs. Not sure if we want them here or in a separate PR.
| ```sh | ||
| brew install node | ||
| ``` | ||
| 1. Make sure you have [node.js](https://nodejs.org/en/) installed using any method you prefer (e.g. a cross-platform package manager like [mise](https://mise.jdx.dev/lang/node.html), or an installation method specific to your OS such as [homebrew](http://brew.sh) for Mac users). |
There was a problem hiding this comment.
I struggled a bit to have my node and ruby setup work well on PopOS (Ubuntu derivative). I tried a few package managers and mise ended up working well for me (and it has binary installations which was convenient), so I included it here but I'm open to mention anything else that is considered more appropriate.
There was a problem hiding this comment.
I've never heard of or used it but happy to include a ref if it worked for you.
| pushd site && bundle install && popd | ||
| ``` | ||
| ```sh | ||
| bundle install --gemfile site/Gemfile |
There was a problem hiding this comment.
This is the only command I changed to be consistent with the change in package.json
| "build:toc": "npm run build:jekyll && scripts/generate-toc", | ||
| "build:site": "rollup -c site/rollup.config.js", | ||
| "build:jekyll": "pushd site && bundle exec jekyll build -q && popd", | ||
| "build:jekyll": "BUNDLE_GEMFILE=site/Gemfile bundle exec jekyll build -q --source site", |
There was a problem hiding this comment.
I repeatedly would get errors from pushd and popd when trying to build the site, so I changed for this approach that ran smoothly for me.
There was a problem hiding this comment.
Thanks for the simplification.
| ```sh | ||
| git clone https://github.com/vega/vega-lite.git | ||
| cd vega-lite | ||
| npm install |
There was a problem hiding this comment.
Most of these changes are just indentation to make it clearer what belongs to which bullet point
| gem install bundler -v "$(grep -A 1 "BUNDLED WITH" Gemfile.lock | tail -n 1)" | ||
| ``` | ||
| ```sh | ||
| gem install bundler -v "$(grep -A 1 "BUNDLED WITH" Gemfile.lock | tail -n 1)" |
There was a problem hiding this comment.
Is this needed? It seems like bundle is detecting the installed version in the lock file automatically?
| ```sh | ||
| brew install node | ||
| ``` | ||
| 1. Make sure you have [node.js](https://nodejs.org/en/) installed using any method you prefer (e.g. a cross-platform package manager like [mise](https://mise.jdx.dev/lang/node.html), or an installation method specific to your OS such as [homebrew](http://brew.sh) for Mac users). |
There was a problem hiding this comment.
I've never heard of or used it but happy to include a ref if it worked for you.
| "build:toc": "npm run build:jekyll && scripts/generate-toc", | ||
| "build:site": "rollup -c site/rollup.config.js", | ||
| "build:jekyll": "pushd site && bundle exec jekyll build -q && popd", | ||
| "build:jekyll": "BUNDLE_GEMFILE=site/Gemfile bundle exec jekyll build -q --source site", |
There was a problem hiding this comment.
Thanks for the simplification.
2 participants
Update the contributing notes about how to build the documentation. See inline comments.
Checklist
npm testruns successfullysite/docs/+ examples.Tips: