This is an automated email from the ASF dual-hosted git repository.
janardhan pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/systemds-website.git
The following commit(s) were added to refs/heads/main by this push:
new 811abe7 [DOCS] Notes on tech stack maintenance and upgrade (#109)
811abe7 is described below
commit 811abe7100d0ba538c220a99786f372c6c538a60
Author: Janardhan Pulivarthi <[email protected]>
AuthorDate: Fri Nov 19 03:49:47 2021 +0530
[DOCS] Notes on tech stack maintenance and upgrade (#109)
* remove deprecated docs
* add minor tweaks in README
---
CONTRIBUTING.md | 85 +++++++++++++++++++++++++++++++--------------------------
README.md | 10 +++----
2 files changed, 52 insertions(+), 43 deletions(-)
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ebbdb03..086384a 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,57 +1,66 @@
-# Update and Commit workflow (Deprecated)
-## Prerequisites
+## Notes on the Website technology stack
-Read through [Apache Version control
infrastructure](https://infra.apache.org/version-control.html)
+For smooth upgrade of tech stack the following notes would help
+with understanding which technologies we are using and how to
+maintain or upgrade them.
-Note: Commit access to the apache svn repository is required.
+### Susy 2
-### shell or Windows Powershell
+[Susy 2](https://susy.readthedocs.io/) is no longer maintained.
+This is deprecated around 2017. Susy 3 exists but it is better to
+move to another type of grid system.
-```powershell
-F:\Repo> git clone https://github.com/apache/systemds-website
-F:\Repo> svn checkout https://svn.apache.org/repos/asf/systemds
systemds-website-svn
-F:\Repo> ls
-systemds-website
-systemds-website-svn
-```
+It is used in `_src/_sass/layout/_config.scss`
+as [global defaults](https://susy.readthedocs.io/settings/#global-defaults)
-### Build website contents
+```scss
-```Powershell
-F:\Repo\systemds-website> npm install
-F:\Repo\systemds-website> gulp
+$susy: (
+ columns: 12,
+ gutters: 1.953125,
+ math: fluid,
+ output: float,
+ gutter-position: inside
+);
```
-### Copy the website contents to svn repo
+> **Recommendation:** Investigate whether we could use a more stable grid
+> system.
-- on Powershell
-```Powershell
-F:\Repo\systemds-website-svn\site> Copy-Item -Path
F:\Repo\systemds-website\_site -Recurse -Container:$false
-```
+### GulpJs
-- Instead of `Copy-Item -Path .. -Recurse`, one could simply use `cp` on a
`linux` based system. On Linux
+We are already using the latest version. Website at https://gulpjs.com/
-```bash
-F:\Repo\systemds-website-svn\site> cp -r F:\Repo\systemds-website\_site
-```
+[version 4.0.2](https://github.com/gulpjs/gulp/releases/tag/v4.0.2) was
release in May 2019.
+There are documentation related commits in the gulp repo in the last six
months.
+
+### NodeJs
+
+16.x is currently used. 16.x will be end of life by 2022.
+
+see [nodejs release policy](https://nodejs.org/en/about/releases/)
+
+> **Recommendation:** Try to switch to nodejs 18.x in future.
+
+### CSS dependencies
+
+[noUiSlider](https://github.com/leongersen/noUiSlider) is a javascript library
for range
+slider. Version used in this project 8.3.0 - 2016-02-14 17:37:20. The latest
version is
+15.5.0 (Oct 2021).
+
+> **Recommendation:** Check whether this library is used and upgrade to the
latest
-
+[normalize.css](https://github.com/necolas/normalize.css) is v3.0.3 (2015) to
this project.
-**see Changes:**
-See modifications, to see only the expected changes were made. (If there are
changes to other files simply do
-not add them!).
-
+> **Recommendation:** Upgrade to 8.0.1 version last released Nov 2018
-**svn commit:**
-Select `svn commit` option, after right clicking the `systemml-website-svn`
folder.
-And add message based on the commits.
-
+### Javascript dependencies
-Provide your apache credentials, that you normally use to push for git
repositories.
-
+Jquery
-This would update the website.
+1. `_src/_scripts/jquery-2.1.1.min.js`, version v2.1.1 (2014). Upgrade to
[latest version](https://github.com/jquery/jquery)
+2. `_src/_scripts/jquery.fitvids.js`, version v1.1 (2013). For fitting the
video. If possible avoid this one.
+3. `_src/assets/css/jquery-ui.css`, version v1.12.1 (2017-05-24). Upgrade to
[latest version](https://github.com/jquery/jquery-ui/releases).
-**ProTip:** Always do a sanity check by knowing what all files changed
diff --git a/README.md b/README.md
index 1d04c9a..37c13e7 100644
--- a/README.md
+++ b/README.md
@@ -1,7 +1,5 @@
# Apache SystemDS Website
-This repository contains the code for the SystemDS [main
website](https://systemds.apache.org).
-
> If you would like to develop on the browser:
>
> [](https://gitpod.io/#https://github.com/apache/systemds-website)
@@ -10,19 +8,21 @@ This repository contains the code for the SystemDS [main
website](https://system
### Node.js and npm
-In order to build this project you will need the latest version of [node.js
and npm](https://nodejs.org/).
-Detailed instructions for download and installation can be found
[here](https://github.com/nodejs/node#download).
+Install [node.js and npm](https://nodejs.org/).
Recommended: Node 16.x, npm 8.x
### Gulp
-We use Gulp to compile Sass and JS as well as run the Jekyll build. You can
install it with npm:
+We use Gulp to compile Sass and JS as well as run the Jekyll build. It can be
+installed with npm as:
```bash
sudo npm install -g gulp
```
+📝If you are upgrading build system, checkout [notes on
upgrades](https://github.com/apache/systemds-website/blob/main/CONTRIBUTING.md#notes-on-the-website-technology-stack).
+
## Building the website
<details><summary>Click to see instructions</summary>
