If you would like to develop on the browser:
Install node.js and npm.
Recommended: Node 16.x, npm 8.x
We use Gulp to compile Sass and JS as well as run the Jekyll build. It can be installed with npm as:
sudo npm install -g gulp
📝If you are upgrading build system, checkout notes on upgrades.
If all goes well it open the site in your browser at
Error: spawn jekyll.bat ENOENT can be resolved by
gem install jekyll
If you are still facing the issue, perhaps the discussion here might would give some pointers.
After generating files by following above instructions.
update-website) from the
git checkout asf-staging git checkout -b update-website
cp -r _site/* content/ git add content/* git commit -m "Update SystemDS website with latest changes"
git push https://github.com/<id>/systemds-website update-website
Instruction for adding release specific version of docs to https://systemds.apache.org/docs
Step 0: Prerequisites
git clone https://github.com/apache/systemds git clone https://github.com/apache/systemds-website
generate docs with as per https://github.com/apache/systemds/tree/main/docs
1.1. API Documentation
# In this case the release tag is 2.1.0-rc3 git checkout 2.1.0-rc3 cd systemds/docs ./updateAPI.sh
1.2. Documentation website
# Build jekyll based docs jekyll serve -w
copy the contents to
cd systemds-website # create a new directory with release no. mkdir content/docs/2.1.0 # copy the files in docs/_site folder to 2.1.0 cp -r ../systemds/docs/_site/* content/docs/2.1.0
Open a PR against
Website Preview at https://systemds.staged.apache.org
Production release via
asf-site branch. For this approval from the team is recommended.
# apply asf-staging commits onto asf-site git rebase asf-staging asf-site git push origin asf-site
Important: Along with this update project metadata by modifying
And Update links in the documentation page as
To add a new dataset,
<dataset-name>.md file in the
And follow the Updating the website procedure.
And follow follow, Updating the website procedure.