This is an automated email from the ASF dual-hosted git repository.
pingsutw pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/submarine.git
The following commit(s) were added to refs/heads/master by this push:
new 70268139 SUBMARINE-1256. Organize website document
70268139 is described below
commit 70268139a65b5b96280b47b31bcc22c85a0b5a56
Author: jeff-901 <[email protected]>
AuthorDate: Thu Apr 14 10:34:03 2022 +0800
SUBMARINE-1256. Organize website document
### What is this PR for?
See the tasks.
### What type of PR is it?
Improvement
### Todos
* [x] - Remove unused or outdated document
* [x] - Add tab for hidden document
* [x] - Change web page url to relative md link
* [x] - Update invalid link
### What is the Jira issue?
https://issues.apache.org/jira/browse/SUBMARINE-1256
### How should this be tested?
### Screenshots (if appropriate)
### Questions:
* Do the license files need updating? No
* Are there breaking changes for older versions? No
* Does this need new documentation? No
Author: jeff-901 <[email protected]>
Signed-off-by: Kevin <[email protected]>
Closes #926 from jeff-901/SUBMARINE-1256 and squashes the following commits:
1147ed24 [jeff-901] fix versions link
d096394f [jeff-901] fix link
0e808056 [jeff-901] update document
---
website/docs/community/README.md | 4 +-
website/docs/community/contributing.md | 2 +-
website/docs/devDocs/Development.md | 4 +-
website/docs/devDocs/IntegrationTestE2E.md | 2 +-
website/docs/gettingStarted/helm.md | 74 +++++++-------
website/docs/gettingStarted/kind.md | 74 --------------
website/docs/gettingStarted/localDeployment.md | 112 ---------------------
website/docs/gettingStarted/quickstart.md | 2 +-
website/docs/userDocs/api/experiment-template.md | 2 +-
website/docs/userDocs/api/experiment.md | 4 +-
website/docs/userDocs/api/notebook.md | 2 +-
.../userDocs/submarine-sdk/experiment-client.md | 4 +-
website/sidebars.js | 4 +-
website/src/pages/versions.js | 6 +-
.../version-0.6.0/community/README.md | 2 +-
.../version-0.6.0/community/contributing.md | 2 +-
.../gettingStarted/localDeployment.md | 1 -
.../version-0.6.0/gettingStarted/quickstart.md | 2 +-
.../userDocs/api/experiment-template.md | 2 +-
.../version-0.6.0/userDocs/api/experiment.md | 4 +-
.../version-0.6.0/userDocs/api/notebook.md | 2 +-
.../userDocs/submarine-sdk/experiment-client.md | 4 +-
22 files changed, 66 insertions(+), 249 deletions(-)
diff --git a/website/docs/community/README.md b/website/docs/community/README.md
index 07880b1d..bb98d0c5 100644
--- a/website/docs/community/README.md
+++ b/website/docs/community/README.md
@@ -30,7 +30,7 @@ You can reach out to the community members via any one of the
following ways:
:::
-- 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?
diff --git a/website/docs/community/contributing.md
b/website/docs/community/contributing.md
index a81c83e0..218eb997 100644
--- a/website/docs/community/contributing.md
+++ b/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.
diff --git a/website/docs/devDocs/Development.md
b/website/docs/devDocs/Development.md
index 51edd56b..54b63cb4 100644
--- a/website/docs/devDocs/Development.md
+++ b/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
diff --git a/website/docs/devDocs/IntegrationTestE2E.md
b/website/docs/devDocs/IntegrationTestE2E.md
index 69a84274..7f64c5f3 100644
--- a/website/docs/devDocs/IntegrationTestE2E.md
+++ b/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
diff --git a/website/docs/gettingStarted/helm.md
b/website/docs/gettingStarted/helm.md
index a33cefa2..2a96d05d 100644
--- a/website/docs/gettingStarted/helm.md
+++ b/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
-```
\ No newline at end of file
+```
+
+## 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:
+
+
diff --git a/website/docs/gettingStarted/kind.md
b/website/docs/gettingStarted/kind.md
deleted file mode 100644
index 36b5c9aa..00000000
--- a/website/docs/gettingStarted/kind.md
+++ /dev/null
@@ -1,74 +0,0 @@
----
-title: Setup a Kubernetes cluster using KinD
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-
-## Create Kubernetes cluster with KinD
-We recommend users developing Submarine with minikube. However,
[`KinD`](https://kind.sigs.k8s.io/) is also an option to setup a Kubernetes
cluster on your local machine.
-
-Run the following command, and specify the KinD version and Kubernetes version
[`here`](../devDocs/Dependencies).
-```bash
-# Download the specific version of KinD (must >= v0.6.0)
-export KIND_VERSION=v0.11.1
-curl -Lo ./kind
https://github.com/kubernetes-sigs/kind/releases/download/${KIND_VERSION}/kind-linux-amd64
-# Make the binary executable
-chmod +x ./kind
-# Move the binary to your executable path
-sudo mv ./kind /usr/local/bin/
-# Create cluster with specific version of kubernetes
-export KUBE_VERSION=v1.15.12
-kind create cluster --image kindest/node:${KUBE_VERSION}
-```
-
-## 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:
-
-
diff --git a/website/docs/gettingStarted/localDeployment.md
b/website/docs/gettingStarted/localDeployment.md
deleted file mode 100644
index bf5cdce3..00000000
--- a/website/docs/gettingStarted/localDeployment.md
+++ /dev/null
@@ -1,112 +0,0 @@
----
-title: Submarine Local Deployment
-slug: /
----
-
-<!--
-Licensed to the Apache Software Foundation (ASF) under one
-or more contributor license agreements. See the NOTICE file
-distributed with this work for additional information
-regarding copyright ownership. The ASF licenses this file
-to you under the Apache License, Version 2.0 (the
-"License"); you may not use this file except in compliance
-with the License. You may obtain a copy of the License at
-
- http://www.apache.org/licenses/LICENSE-2.0
-
-Unless required by applicable law or agreed to in writing,
-software distributed under the License is distributed on an
-"AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
-KIND, either express or implied. See the License for the
-specific language governing permissions and limitations
-under the License.
--->
-
-## Prerequisite
-
-- [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/).
-
-## Deploy Kubernetes Cluster
-
-```
-$ minikube start --vm-driver=docker --cpus 8 --memory 4096 --disk-size=20G
--kubernetes-version v1.21.2
-```
-
-## Install Submarine on Kubernetes
-
-```
-$ git clone https://github.com/apache/submarine.git
-$ cd submarine
-$ helm install submarine ./helm-charts/submarine
-```
-
-```
-NAME: submarine
-LAST DEPLOYED: Fri Jan 29 05:35:36 2021
-NAMESPACE: default
-STATUS: deployed
-REVISION: 1
-TEST SUITE: None
-```
-
-## Verify installation
-
-Once you got it installed, check with below commands and you should see
similar outputs:
-
-```bash
-$ kubectl get pods
-```
-
-```bash
-NAME READY STATUS RESTARTS
AGE
-notebook-controller-deployment-5db8b6cbf7-k65jm 1/1 Running 0
5s
-pytorch-operator-7ff5d96d59-gx7f5 1/1 Running 0
5s
-submarine-database-8d95d74f7-ntvqp 1/1 Running 0
5s
-submarine-server-b6cd4787b-7bvr7 1/1 Running 0
5s
-submarine-traefik-9bb6f8577-66sx6 1/1 Running 0
5s
-tf-job-operator-7844656dd-lfgmd 1/1 Running 0
5s
-```
-
-:::warning
-Note that if you encounter below issue when installation:
-:::
-
-```bash
-Error: rendered manifests contain a resource that already exists.
-Unable to continue with install: existing resource conflict: namespace: ,
name: podgroups.scheduling.incubator.k8s.io, existing_kind:
apiextensions.k8s.io/v1beta1, Kind=CustomResourceDefinition, new_kind:
apiextensions.k8s.io/v1beta1, Kind=CustomResourceDefinition
-```
-
-It might be caused by the previous installed submarine charts. Fix it by
running:
-
-```bash
-$ kubectl delete crd/tfjobs.kubeflow.org && kubectl delete
crd/podgroups.scheduling.incubator.k8s.io && kubectl delete
crd/pytorchjobs.kubeflow.org
-```
-
-## Access Submarine in a Cluster
-
-```bash
-# #Listen on port 32080 on all addresses, forwarding to 80 in the pod
-# Method1 -- using minikube ip + NodePort
-$ minikube ip # you'll get the IP address of minikube, ex: 192.168.49.2
-
-# Method2 -- using port-forwarding
-$ kubectl port-forward --address 0.0.0.0 service/submarine-traefik 32080:80
-```
-
-## Open Workbench in the browser.
-
-Open http://{minikube ip}:32080(from Method1), ex: http://192.168.49.2:32080
-
-or http://127.0.0.1:32080 (from Method 2).
-
-The default username and password is `admin` and `admin`
-
-
-
-## Uninstall Submarine
-
-```bash
-$ helm delete submarine
-```
diff --git a/website/docs/gettingStarted/quickstart.md
b/website/docs/gettingStarted/quickstart.md
index 877de7d4..b1ffc4d7 100644
--- a/website/docs/gettingStarted/quickstart.md
+++ b/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/).
diff --git a/website/docs/userDocs/api/experiment-template.md
b/website/docs/userDocs/api/experiment-template.md
index 76dbed5c..0ea1bd7b 100644
--- a/website/docs/userDocs/api/experiment-template.md
+++ b/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**
diff --git a/website/docs/userDocs/api/experiment.md
b/website/docs/userDocs/api/experiment.md
index 87b8019e..645c52e3 100644
--- a/website/docs/userDocs/api/experiment.md
+++ b/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**
diff --git a/website/docs/userDocs/api/notebook.md
b/website/docs/userDocs/api/notebook.md
index 380eaa8f..3c356dad 100644
--- a/website/docs/userDocs/api/notebook.md
+++ b/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**
diff --git a/website/docs/userDocs/submarine-sdk/experiment-client.md
b/website/docs/userDocs/submarine-sdk/experiment-client.md
index 096a0a99..4b0d031b 100644
--- a/website/docs/userDocs/submarine-sdk/experiment-client.md
+++ b/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**
diff --git a/website/sidebars.js b/website/sidebars.js
index d0a5bf3e..b1a38c87 100644
--- a/website/sidebars.js
+++ b/website/sidebars.js
@@ -23,9 +23,9 @@ module.exports = {
Introduction: [],
"Getting Started": [
"gettingStarted/quickstart",
- // "gettingStarted/localDeployment",
"gettingStarted/notebook",
- // "gettingStarted/python-sdk",
+ "gettingStarted/python-sdk",
+ "gettingStarted/helm",
],
"User Docs": [
{
diff --git a/website/src/pages/versions.js b/website/src/pages/versions.js
index 737a3dfb..232034ab 100644
--- a/website/src/pages/versions.js
+++ b/website/src/pages/versions.js
@@ -37,6 +37,8 @@ function Version() {
);
const repoUrl =
`https://github.com/${siteConfig.organizationName}/${siteConfig.projectName}`;
console.log(siteConfig);
+ console.log(latestVersion);
+ console.log(currentVersion);
return (
<Layout
title="Versions"
@@ -55,7 +57,7 @@ function Version() {
<tr>
<th>{latestVersion.label}</th>
<td>
- <Link to={latestVersion.path}>Documentation</Link>
+ <Link to={latestVersion.path + "/" +
latestVersion.mainDocId}>Documentation</Link>
</td>
<td>
<a
href={`/releases/submarine-release-${latestVersion.name}`}>
@@ -80,7 +82,7 @@ function Version() {
<tr>
<th>{currentVersion.label}</th>
<td>
- <Link to={currentVersion.path}>Documentation</Link>
+ <Link to={currentVersion.path + "/" +
currentVersion.mainDocId}>Documentation</Link>
</td>
<td>
<Link to={repoUrl}>Source code</Link>
diff --git a/website/versioned_docs/version-0.6.0/community/README.md
b/website/versioned_docs/version-0.6.0/community/README.md
index c2cfd318..d2361d49 100644
--- a/website/versioned_docs/version-0.6.0/community/README.md
+++ b/website/versioned_docs/version-0.6.0/community/README.md
@@ -28,7 +28,7 @@ You can reach out to the community members via any one of the
following ways:
+ Slack User:
[https://the-asf.slack.com/submarine-user/](https://the-asf.slack.com/submarine-user/)
-+ 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)
diff --git a/website/versioned_docs/version-0.6.0/community/contributing.md
b/website/versioned_docs/version-0.6.0/community/contributing.md
index a81c83e0..218eb997 100644
--- a/website/versioned_docs/version-0.6.0/community/contributing.md
+++ b/website/versioned_docs/version-0.6.0/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.
diff --git
a/website/versioned_docs/version-0.6.0/gettingStarted/localDeployment.md
b/website/versioned_docs/version-0.6.0/gettingStarted/localDeployment.md
index 338f2f27..18a53812 100644
--- a/website/versioned_docs/version-0.6.0/gettingStarted/localDeployment.md
+++ b/website/versioned_docs/version-0.6.0/gettingStarted/localDeployment.md
@@ -1,6 +1,5 @@
---
title: Submarine Local Deployment
-slug: /
---
<!--
diff --git a/website/versioned_docs/version-0.6.0/gettingStarted/quickstart.md
b/website/versioned_docs/version-0.6.0/gettingStarted/quickstart.md
index 2912e240..41aa39ef 100644
--- a/website/versioned_docs/version-0.6.0/gettingStarted/quickstart.md
+++ b/website/versioned_docs/version-0.6.0/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/).
diff --git
a/website/versioned_docs/version-0.6.0/userDocs/api/experiment-template.md
b/website/versioned_docs/version-0.6.0/userDocs/api/experiment-template.md
index 76dbed5c..0ea1bd7b 100644
--- a/website/versioned_docs/version-0.6.0/userDocs/api/experiment-template.md
+++ b/website/versioned_docs/version-0.6.0/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**
diff --git a/website/versioned_docs/version-0.6.0/userDocs/api/experiment.md
b/website/versioned_docs/version-0.6.0/userDocs/api/experiment.md
index 87b8019e..645c52e3 100644
--- a/website/versioned_docs/version-0.6.0/userDocs/api/experiment.md
+++ b/website/versioned_docs/version-0.6.0/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**
diff --git a/website/versioned_docs/version-0.6.0/userDocs/api/notebook.md
b/website/versioned_docs/version-0.6.0/userDocs/api/notebook.md
index 380eaa8f..3c356dad 100644
--- a/website/versioned_docs/version-0.6.0/userDocs/api/notebook.md
+++ b/website/versioned_docs/version-0.6.0/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**
diff --git
a/website/versioned_docs/version-0.6.0/userDocs/submarine-sdk/experiment-client.md
b/website/versioned_docs/version-0.6.0/userDocs/submarine-sdk/experiment-client.md
index 096a0a99..4b0d031b 100644
---
a/website/versioned_docs/version-0.6.0/userDocs/submarine-sdk/experiment-client.md
+++
b/website/versioned_docs/version-0.6.0/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**
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
