You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@systemds.apache.org by ja...@apache.org on 2021/10/28 20:19:54 UTC

[systemds-website] branch master updated: [MINOR] Update instructions and add collapsible md

This is an automated email from the ASF dual-hosted git repository.

janardhan pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/systemds-website.git


The following commit(s) were added to refs/heads/master by this push:
     new 12b3787  [MINOR] Update instructions and add collapsible md
12b3787 is described below

commit 12b3787d3d4f33110290544e3c18ffea9a09fc16
Author: Janardhan Pulivarthi <j1...@protonmail.com>
AuthorDate: Fri Oct 29 01:49:50 2021 +0530

    [MINOR] Update instructions and add collapsible md
    
    * collapsible markdown added to decrease the cognitive load,
    to scan the overall menu with one scan
---
 README.md | 21 ++++++++++++++++++++-
 1 file changed, 20 insertions(+), 1 deletion(-)

diff --git a/README.md b/README.md
index 8e503a5..cec72c3 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,9 @@ sudo npm install -g gulp
 
 ### Download website dependancies
 
+<details><summary>Click to see instructions</summary>
+<p>
+
 ```bash
 npm install
 ```
@@ -48,11 +51,16 @@ gem install jekyll
 If you are still facing the issue, perhaps the discussion
 [here](https://github.com/j143/systemds-website/issues/3) might would give some pointers.
 
+</p>
+</details>
 
 ## Updating the website
 
 After generating files by following above instructions.
 
+<details><summary>Click to see instructions</summary>
+<p>
+
 1. Create a new branch (for example, `update-website`) from the `asf-staging` branch.
 
 ```bash
@@ -74,12 +82,19 @@ git commit -m "Update SystemDS website with latest changes"
 git push https://github.com/<id>/systemds-website update-website
 ```
 
+</p>
+</details>
+  
 An example, [PR#83](https://github.com/apache/systemds-website/pull/83).
 
 ### Release Docs
 
 Instruction for adding release specific version of docs to https://systemds.apache.org/docs
 
+<details><summary>Click to see instructions</summary>
+<p>
+
+
 **Step 0: Prerequisites**
 
 ```sh
@@ -112,7 +127,7 @@ cd systemds-website
 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
+cp -r ../systemds/docs/api content/docs/2.1.0
 ```
 
 Then follow, https://github.com/apache/systemds-website#updating-the-website
@@ -144,6 +159,10 @@ git push origin asf-site
 > Important: Along with this update project metadata by modifying `release_version:` in
 > [_src/_data/project.yml](https://github.com/apache/systemds-website/blob/master/_src/_data/project.yml#L46)
 
+</p>
+</details>  
+
+
 ## How to add new dataset
 
 To add a new dataset,