Apache SystemDS Website

Clone this repo:
  1. 9f5107f [SYSTEMDS-3053] Do not run Action workflow for doc changes by Janardhan Pulivarthi · 3 weeks ago master
  2. 4a9a39d [DOCS] Add note on project metadata for release_version by Janardhan Pulivarthi · 4 weeks ago
  3. 9eba20a [MINOR] Update project release version by Janardhan Pulivarthi · 4 weeks ago
  4. 26d4026 [DOCS] Website staging and production sync instructions by Janardhan Pulivarthi · 4 weeks ago
  5. 6d7b3b7 [MINOR] update links in documentation page by Janardhan Pulivarthi · 4 weeks ago

Apache SystemDS Website

This repository contains the code for the SystemDS main website.

If you would like to develop on the browser:

Open in Gitpod online

Dependencies

Node.js and npm

In order to build this project you will need the latest version of node.js and npm. Detailed instructions for download and installation can be found here.

Gulp

We use Gulp to compile Sass and JS as well as run the Jekyll build. You can install it with npm:

sudo npm install -g gulp

Building the website

Download website dependancies

npm install

Build website contents

gulp

If all goes well it open the site in your browser at http://localhost:3000.

Troubleshooting

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.

Updating the website

After generating files by following above instructions.

  1. Create a new branch (for example, update-website) from the asf-staging branch.
git checkout asf-staging
git checkout -b update-website
  1. Copy the generated files to the website content folder.
cp -r _site/* content/
git add content/*
git commit -m "Update SystemDS website with latest changes"
  1. Add changes to the personal fork and create a PR against asf-staging branch.
git push https://github.com/<id>/systemds-website update-website

An example, PR#83.

Release Docs

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

Step 1:

generate docs with as per https://github.com/apache/systemds/tree/master/docs


# In this case the release tag is 2.1.0-rc3 git checkout 2.1.0-rc3 cd systemds/docs ./updateAPI.sh

Step 2:

copy the contents to systemds-website repo

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

Then follow, https://github.com/apache/systemds-website#updating-the-website

Step 3:

Open a PR against asf-staging branch.

Example PR: https://github.com/apache/systemds-website/pull/94

Website Preview at https://systemds.staged.apache.org

Step 4:

Production release via asf-site branch. For this approval from the team is recommended.

Example PR: https://github.com/apache/systemds-website/pull/95

Now, sync asf-staging and asf-site as:

# 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 release_version: in _src/_data/project.yml

How to add new dataset

To add a new dataset,

  1. create <dataset-name>.md file in the _src/_datasets folder.
  2. Upload dataset files to _src/assets/datasets/<dataset-name> folder.

And follow the Updating the website procedure.