SUBMARINE-1256. Organize website document

website/docs/community/README.md

@@ -30,7 +30,7 @@ You can reach out to the community members via any one of the following ways:
   :::
   ![slack_search_submarine](/img/slack_search_submarine.png)
   ![slack_join_submarine](/img/slack_join_submarine.png)
-- Zoom: [https://cloudera.zoom.us/j/880548968](https://cloudera.zoom.us/j/880548968)
+- Zoom: [https://cloudera.zoom.us/j/97264903288](https://cloudera.zoom.us/j/97264903288)
 
 - Sync Up: [https://docs.google.com/document/d/16pUO3TP4SxSeLduG817GhVAjtiph9HYpRHo_JgduDvw/edit](https://docs.google.com/document/d/16pUO3TP4SxSeLduG817GhVAjtiph9HYpRHo_JgduDvw/edit)
 
@@ -48,7 +48,7 @@ If you want to work on a new idea of relatively small scope:
 
 3. Submit a [pull request of Submarine](https://github.com/apache/submarine) containing a tested change.
 
-Contributions are welcomed and greatly appreciated. See [CONTRIBUTING](contributing) for details on submitting patches and the contribution workflow.
+Contributions are welcomed and greatly appreciated. See [CONTRIBUTING](contributing.md) for details on submitting patches and the contribution workflow.
 
 ## How Do I Become a Committer?
 

website/docs/community/contributing.md

@@ -27,7 +27,7 @@ There are several ways to contribute to Submarine:
 * The document [How It Works](http://www.apache.org/foundation/how-it-works.html) can help you understand Apache Software Foundation further.
 
 ## Build Submarine
-* [Build From Code](https://github.com/apache/submarine/blob/master/website/docs/devDocs/BuildFromCode.md)
+* [Build From Code](../devDocs/BuildFromCode.md)
 
 ## Creating patches
 Submarine follows [Fork & Pull](https://github.com/sevntu-checkstyle/sevntu.checkstyle/wiki/Development-workflow-with-Git:-Fork,-Branching,-Commits,-and-Pull-Request) model.

website/docs/devDocs/Development.md

@@ -18,7 +18,7 @@ title: Development Guide
 -->
 
 # Project Overview
-The document [Submarine Local Deployment](../gettingStarted/localDeployment.md) shows how to deploy the Submarine service to your Kubernetes cluster. The Submarine service consists mainly of nine components, and you can check them with the following command:
+The document [Submarine Quickstart](../gettingStarted/quickstart.md) shows how to deploy the Submarine service to your Kubernetes cluster. The Submarine service consists mainly of nine components, and you can check them with the following command:
 
 ```
 kubectl get pods -n ${your_namespace}
@@ -105,7 +105,7 @@ Checkstyle plugin may help to detect violations directly from the IDE.
 
 1. Deploy the Submarine
 
-   Follow [Getting Started/Submarine Local Deployment](../gettingStarted/localDeployment.md), and make sure you can connect to `http://localhost:32080` in the browser.
+   Follow [Getting Started/Quickstart](../gettingStarted/quickstart.md), and make sure you can connect to `http://localhost:32080` in the browser.
 
 2. Install the dependencies
 

website/docs/devDocs/IntegrationTestE2E.md

@@ -21,7 +21,7 @@ title: How to Run Frontend Integration Test
 
 ## Run E2E test locally
 
-1. Ensure you have setup the submarine locally. If not, you can refer to `Submarine Local Deployment`.
+1. Ensure you have setup the submarine locally. If not, you can refer to [Quickstart](../gettingStarted/quickstart.md).
 
 2. Forward port
 

website/docs/gettingStarted/helm.md

@@ -1,5 +1,5 @@
 ---
-title: Deploy Submarine with Helm
+title: Custom Configuation
 ---
 
 <!--
@@ -20,40 +20,7 @@ KIND, either express or implied.  See the License for the
 specific language governing permissions and limitations
 under the License.
 -->
-# Deploy Submarine with Helm
-With the help of [Helm](https://helm.sh/), users can deploy Submarine service to Kubernetes in one command. 
-Check [helm-charts/submarine](https://github.com/apache/submarine/tree/master/helm-charts/submarine) for more details.
-
-## Prerequisite
-* Install Helm v3: https://helm.sh/docs/intro/install/ 
-* A Kubernetes environment (ex: minikube or kind)
-
-## Deploy Submarine to Kubernetes
-```bash
-git clone https://github.com/apache/submarine.git
-cd submarine
-helm install submarine ./helm-charts/submarine
-```
-* With these commands, the Submarine service will be deployed to the "default" namespace.
-* The first time installation will take about 10 mins because the docker images are pulled from [apache/submarine](https://hub.docker.com/r/apache/submarine) on DockerHub.
-
-
-## Verify installation
-```bash
-kubectl get all
-```
-* TODO: screenshot
-
-## Uninstall Submarine
-```bash
-helm uninstall submarine
-
-# Check
-helm ls 
-``` 
-
-# Helm chart configuation (values.yaml)
-## Volume Type
+## Helm Chart Volume Type
 Submarine can support various [volume types](https://kubernetes.io/docs/concepts/storage/volumes/#nfs), currently including hostPath (default) and NFS. It can be easily configured in the `./helm-charts/submarine/values.yaml`, or you can override the default values in `values.yaml` by [helm CLI](https://helm.sh/docs/helm/helm_install/).
 
 #### hostPath
@@ -145,4 +112,39 @@ http://127.0.0.1:32080
 If minikube is installed, use the following command to find the URL to the Submarine server.
 ```
 $ minikube service submarine-traefik --url
-```
+```
+
+## Kubernetes Dashboard (optional)
+
+### Deploy
+To deploy Dashboard, execute the following command:
+```
+kubectl apply -f https://raw.githubusercontent.com/kubernetes/dashboard/v2.0.0-beta8/aio/deploy/recommended.yaml
+```
+
+### Create RBAC
+Run the following commands to grant the cluster access permission of dashboard:
+```
+kubectl create serviceaccount dashboard-admin-sa
+kubectl create clusterrolebinding dashboard-admin-sa --clusterrole=cluster-admin --serviceaccount=default:dashboard-admin-sa
+```
+
+### Get access token (optional)
+If you want to use the token to login the dashboard, run the following commands to get key:
+```
+kubectl get secrets
+# select the right dashboard-admin-sa-token to describe the secret
+kubectl describe secret dashboard-admin-sa-token-6nhkx
+```
+
+### Start dashboard service
+```
+kubectl proxy
+```
+
+Now access Dashboard at:
+> http://localhost:8001/api/v1/namespaces/kubernetes-dashboard/services/https:kubernetes-dashboard:/proxy/
+
+Dashboard screenshot:
+
+![](/img/kind-dashboard.png)

website/docs/gettingStarted/quickstart.md

@@ -29,7 +29,7 @@ This document gives you a quick view on the basic usage of Submarine platform. Y
 
 1. Prerequisite
 
-- Check [dependency page](https://github.com/apache/submarine/blob/master/website/docs/devDocs/Dependencies.md) for the compatible version
+- Check [dependency page](../devDocs/Dependencies.md) for the compatible version
 - [kubectl](https://kubernetes.io/docs/tasks/tools/install-kubectl/)
 - [helm](https://helm.sh/docs/intro/install/) (Helm v3 is minimum requirement.)
 - [minikube](https://minikube.sigs.k8s.io/docs/start/).

website/docs/userDocs/api/experiment-template.md

@@ -66,7 +66,7 @@ POST /api/v1/template
 
 #### **EnvironmentSpec**
 
-See more details in [environment api](https://submarine.apache.org/docs/userDocs/api/environment).
+See more details in [environment api](environment.md).
 
 #### **ExperimentTaskSpec**
 

website/docs/userDocs/api/experiment.md

@@ -56,7 +56,7 @@ There are two types of environment: Anonymous and Predefined.
 - Anonymous environment: only specify `dockerImage` in environment spec. The container will be built on the docker image.
 - Embedded environment: specify `name` in environment spec. The container will be built on the existing environment (including dockerImage and kernalSpec).
 
-See more details in [environment api](https://submarine.apache.org/docs/userDocs/api/environment).
+See more details in [environment api](environment.md).
 
 #### **ExperimentTaskSpec**
 
@@ -212,7 +212,7 @@ curl -X POST -H "Content-Type: application/json" -d '
 }
 ' http://127.0.0.1:32080/api/v1/experiment
 ```
-Above example assume environment "my-submarine-env" already exists in Submarine. Please refer Environment API Reference doc to [environment rest api](https://submarine.apache.org/docs/userDocs/api/environment).
+Above example assume environment "my-submarine-env" already exists in Submarine. Please refer Environment API Reference doc to [environment rest api](environment.md).
 
 **response**
 

website/docs/userDocs/api/notebook.md

@@ -49,7 +49,7 @@ NotebookSpec in request body.
 
 #### **EnvironmentSpec**
 
-See more details in [environment api](https://submarine.apache.org/docs/userDocs/api/environment).
+See more details in [environment api](environment.md).
 
 #### **NotebookPodSpec**
 

website/docs/userDocs/submarine-sdk/experiment-client.md

@@ -29,7 +29,7 @@ Client of a submarine server that creates and manages experients and logs.
 
 Create an experiment.
 > **Parameters**
-  - **experiment_spec**: Submarine experiment spec. More detailed information can be found at [Experiment API](https://submarine.apache.org/docs/userDocs/api/experiment).
+  - **experiment_spec**: Submarine experiment spec. More detailed information can be found at [Experiment API](../api/experiment.md).
 
 > **Returns**: The detailed info about the submarine experiment.
 
@@ -69,7 +69,7 @@ client.create_experiment({
 Patch an experiment.
 > **Parameters**
   - **id**: Submarine experiment id. 
-  - **experiment_spec**: Submarine experiment spec. More detailed information can be found at [Experiment API](https://submarine.apache.org/docs/userDocs/api/experiment).
+  - **experiment_spec**: Submarine experiment spec. More detailed information can be found at [Experiment API](../api/experiment.md).
 
 
 > **Returns**