[GitHub] [systemml] j143 commented on a change in pull request #877: SystemDS Documentation

[GitBox <gi...@apache.org>]

j143 commented on a change in pull request #877: SystemDS Documentation
URL: https://github.com/apache/systemml/pull/877#discussion_r405240804
 
 

 ##########
 File path: README.md
 ##########
 @@ -17,26 +17,49 @@ limitations under the License.
 {% endcomment %}
 -->
 
-# Apache SystemML Documentation
+# Apache SystemDS Documentation
 
-The primary SystemML documentation is written in markdown (*.md) and can be converted to HTML using
+The primary SystemDS documentation is written in markdown (*.md) and can be converted to HTML using
 [Jekyll](http://jekyllrb.com).
 
-Jekyll (and optionally Pygments) can be installed on the Mac OS in the following manner.
+## Ubuntu Install
+
+1. Install Ruby development environment [Jekyll on Ubuntu](https://jekyllrb.com/docs/installation/ubuntu/).
+2. Install Jekyll inside the Ruby environnement.
+
+   - `gem install jekyll jekyll-redirect-from bundler pygments.rb`
+   - To do this you might need to change permissions on folders `/var/lib/gems` and `/var/lib/gems/2.5.0`.
+   - The Pygments package is optional, and does require sudo permissions.
+
+3. Install python dependencies (Optionally).
+
+   - `pip install Pygments`
 
-    $ brew install ruby
-    $ gem install jekyll
-    $ gem install jekyll-redirect-from
-    $ gem install bundler
-    $ brew install python
-    $ pip install Pygments
-    $ gem install pygments.rb
+4. Launch the Documentation locally
+
+   - `jekyll serve -w`
+   - This is done from the root of the gh-pages branch of the system.
+   - The serving will per default be on localhost port 4000 [Link](http://localhost:4000)
+
+## Mac Install (Depricated)
 
 Review comment:
   _Deprecated_ is more popular though.

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services