[doc] fix path of some doc as code structure refactor (#1465)

* fix dev box dir * fix cluster boot up quick-start path * fix grafana link * fix path of paictl * fix path of maintainnance * fix doc link * fix link of webportal * fix link of hdfs * make path of grafana as relative * make hdfs path as relative * make webportal doc path as relative * fix pylon doc to relative path * fix relative path of etcd
microsoft · Oct 10, 2018 · 2412bba · 2412bba
1 parent 5be7ffe
commit 2412bba
Show file tree

Hide file tree

Showing 7 changed files with 12 additions and 12 deletions.
diff --git a/docs/grafana/README.md b/docs/grafana/README.md
@@ -30,7 +30,7 @@ grafana-port: 3000        # port for grafana
 
 # Deployment
 
-The deployment of web portal goes with the bootstrapping process of the whole PAI cluster, which is described in detail in [Tutorial: Booting up the cluster](https://github.com/Microsoft/pai/blob/master/pai-management/doc/cluster-bootup.md).
+The deployment of web portal goes with the bootstrapping process of the whole PAI cluster, which is described in detail in [Tutorial: Booting up the cluster](../pai-management/doc/cluster-bootup.md).
 
 If you want to redeploy Grafana only, firstly stop it, note to replace `/path/to/cluster-configuration/dir` with your own cluster configuration path:
 
@@ -45,7 +45,7 @@ python paictl.py service start -p /path/to/cluster-configuration/dir -n grafana
 For more details, please refer to [Maintain your service](../pai-management/doc/service-maintain.md).
 # Upgrading
 
-System will automatically pull the latest Grafana image, there is no need to upgrade. If you want to use the specific version of Grafana, you can change the version configuration at the [grafana.yaml.template](https://github.com/Microsoft/pai/blob/dc64643966eaa98a7c854e272e1aa8f2f9b76ca9/pai-management/bootstrap/grafana/grafana.yaml.template#L44) and then redeploy it.
+System will automatically pull the latest Grafana image, there is no need to upgrade. If you want to use the specific version of Grafana, you can change the version configuration at the [grafana.yaml.template](../../src/grafana/deploy/grafana.yaml.template#L44) and then redeploy it.
 # Service Metrics
 
 N/A

diff --git a/docs/job_tutorial.md b/docs/job_tutorial.md
@@ -241,9 +241,9 @@ A distributed TensorFlow job is listed below as an example:
 
 ### Job submission steps <a name="submission"></a>
 
-1. Put the code and data on [HDFS](https://github.com/Microsoft/pai/blob/master/pai-management/doc/hdfs.md)
+1. Put the code and data on [HDFS](../docs/hadoop/hdfs.md)
 
-- Option-1: Use [WebHDFS](https://github.com/Microsoft/pai/blob/master/pai-management/doc/hdfs.md#WebHDFS) to upload your code and data to HDFS on the system. 
+- Option-1: Use [WebHDFS](../docs/hadoop/hdfs.md#WebHDFS) to upload your code and data to HDFS on the system. 
 - Option-2: Use HDFS tools to upload your code and data to HDFS on the system. We upload a [Docker image](https://hub.docker.com/r/paiexample/pai.example.hdfs/) to DockerHub with built-in HDFS support.
     Please refer to the [HDFS commands guide](https://hadoop.apache.org/docs/r2.7.2/hadoop-project-dist/hadoop-hdfs/HDFSCommands.html) for details. 
 

diff --git a/docs/pai-management/doc/cluster-bootup.md b/docs/pai-management/doc/cluster-bootup.md
@@ -172,7 +172,7 @@ cd /pai
 
 # cmd should be executed under pai directory in the dev-box.
 
-python paictl.py config generate -i /pai/deployment/quick-start/quick-start/quick-start.yaml -o ~/pai-config -f
+python paictl.py config generate -i /pai/deployment/quick-start/quick-start.yaml -o ~/pai-config -f
 
 ```
 

diff --git a/docs/pai-management/doc/how-to-setup-dev-box.md b/docs/pai-management/doc/how-to-setup-dev-box.md
@@ -36,7 +36,7 @@ sudo docker run -itd \
 
 # Working in your dev-box
 sudo docker exec -it dev-box /bin/bash
-cd /pai/pai-management
+cd /pai
 
 # Now you are free to configure your cluster and run PAI commands...
 
@@ -52,7 +52,7 @@ cd /pai/pai-management
 git clone https://github.com/Microsoft/pai.git
 
 # Go into the workdir.
-cd pai/pai-management/
+cd pai
 
 # Build your dev-box.
 sudo docker build -t dev-box .
@@ -80,7 +80,7 @@ sudo docker run -itd \
 
 # Working in your dev-box
 sudo docker exec -it dev-box /bin/bash
-cd /pai/pai-management
+cd /pai
 
 # Now you are free to configure your cluster and run PAI commands...
 
@@ -105,4 +105,4 @@ kubectl label --overwrite=true nodes $NODE-IP-ADDRESS dev-box=true
 cd pai/src/dev-box
 
 kubectl create -f dev-box-k8s-deploy.yaml
-```
+```
diff --git a/docs/paictl/paictl-design.md b/docs/paictl/paictl-design.md
@@ -44,7 +44,7 @@
 
 ## paictl service
 
-- paictl will iterate all folder in the path ```pai/pai-management/bootstrap```. If it contains the file ```service.yaml``` and corresponding operation script, paictl will call the script to handle the operator.
+- paictl will iterate all folder in the path ```pai/src```. If it contains the file ```service.yaml``` and corresponding operation script, paictl will call the script to handle the operator.
 
 
 <div  align="center">

diff --git a/docs/pylon/README.md b/docs/pylon/README.md
@@ -58,7 +58,7 @@ And before starting nginx, the `nginx.conf` file must be generated using `python
 
 ### For deploying with PAI
 
-The deployment of Pylon goes with the bootstrapping process of the whole PAI cluster, which is described in detail in [Tutorial: Booting up the cluster](https://github.com/Microsoft/pai/blob/master/pai-management/doc/cluster-bootup.md). To configure Pylon, change the following field(s) in the `pylon` section in [services-configuration.yaml](../../examples/cluster-configuration/services-configuration.yaml) file:
+The deployment of Pylon goes with the bootstrapping process of the whole PAI cluster, which is described in detail in [Tutorial: Booting up the cluster](../pai-management/doc/cluster-bootup.md). To configure Pylon, change the following field(s) in the `pylon` section in [services-configuration.yaml](../../examples/cluster-configuration/services-configuration.yaml) file:
 
 * `server-port`: Integer. The network port to access Pylon. The default value is 80.
 

diff --git a/docs/webportal/README.md b/docs/webportal/README.md
@@ -66,7 +66,7 @@ And the following field could be configured optionally:
 
 ## Deployment
 
-The deployment of web portal goes with the bootstrapping process of the whole PAI cluster, which is described in detail in [Tutorial: Booting up the cluster](https://github.com/Microsoft/pai/blob/master/pai-management/doc/cluster-bootup.md).
+The deployment of web portal goes with the bootstrapping process of the whole PAI cluster, which is described in detail in [Tutorial: Booting up the cluster](../pai-management/doc/cluster-bootup.md).
 
 ---