commit | c88c5d0fb0925db1e0117222429c58835bb94a4a | [log] [tgz] |
---|---|---|
author | Janardhan Pulivarthi <j143@protonmail.com> | Wed Jun 30 21:25:29 2021 +0530 |
committer | GitHub <noreply@github.com> | Wed Jun 30 21:25:29 2021 +0530 |
tree | d436cef6bb8bf7a190293edaea64387a47dc4dec | |
parent | ba201151ec9e01c9854cb40df3809b23ae3680c8 [diff] |
[DOCS] Add release specific docs update instructions (#96) * add branch specific instructions
This repository contains the code for the SystemDS main website.
If you would like to develop on the browser:
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.
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
npm install
gulp
If all goes well it open the site in your browser at http://localhost:3000
.
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 asf-staging
branch.git checkout asf-staging git checkout -b update-website
content
folder.cp -r _site/* content/ git add content/* git commit -m "Update SystemDS website with latest changes"
asf-staging
branch.git push https://github.com/<id>/systemds-website update-website
An example, PR#83.
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
To add a new dataset,
<dataset-name>.md
file in the _src/_datasets
folder._src/assets/datasets/<dataset-name>
folder.And follow the Updating the website procedure.