- Node
- Fork the repository
- Clone your fork including submodules
git clone –recusive-submodulesN.B. If you don’t clone the submodules, when you run
make localyou will get an error similar to[15:57:41.334] FATAL (antora): Cannot find module '/Users/alexseymour/git/rancher-product-docs/product-docs-common/extensions/dynamic-loading-attributes/load-global-site-attributes.js'in this instance you can clone the submodules from within the working directory withgit submodule update --init --recursive - Run
make environmentto install required dependencies - Run
make localto build the site locally into build/site. Open build/site/index.html to view. - Run
make previewto run a local http server serving the site on port 8080