doc(readme): polish readme and scheduling proposal

kubewharf · Feb 27, 2023 · 6c7fa07 · 6c7fa07
1 parent cd563f9
commit 6c7fa07
Show file tree

Hide file tree

Showing 8 changed files with 8 additions and 8 deletions.
diff --git a/README.md b/README.md
@@ -36,7 +36,7 @@ Since Kubewharf enhanced kubernetes is developed based on specific versions of u
 
 ## Getting started
 
-Katalyst provides several example yaml to demonstrate the common use cases. For more information, please refer to [tutorials](./docs/tutorial/collocation.md).
+Katalyst provides several example yaml to demonstrate the common use cases. For more information, please refer to [tutorials](./docs/tutorial/colocation.md).
 
 ## Community
 

diff --git a/README.zh.md b/README.zh.md
@@ -33,7 +33,7 @@ Katalyst 基于 Kubewharf 增强版 Kubernetes 发行版进行开发， 请参
 
 ## 示例
 
-Katalyst 提供了丰富的样例为您展示相关的使用；相关内容将在后续补充
+Katalyst 提供了丰富的样例为您展示相关的使用；详细内容请参考 [tutorials](./docs/tutorial/colocation.md)。
 
 ## 社区
 

diff --git a/docs/proposals/scheduling/20220913-katalyst-scheduler-design.md b/docs/proposals/scheduling/20220913-katalyst-scheduler-design.md
@@ -153,7 +153,7 @@ unit when scheduling and allocating resources, so that some NUMA nodes will be d
 
 <div align="center">
   <picture>
-    <img src="/docs/imgs/scheduler-overall-arch.jpg" width=50% title="Scheduler Overall Architecture" loading="eager" />
+    <img src="./scheduler-overall-arch.jpg" width=50% title="Scheduler Overall Architecture" loading="eager" />
   </picture>
 </div>
 
@@ -270,7 +270,7 @@ events are registered to the informer.
 
 <div align="center">
   <picture>
-    <img src="/docs/imgs/scheduler-fit-plugin.jpg" width=80% title="QoSAwareNodeResourcesFit Plugin" loading="eager" />
+    <img src="./scheduler-fit-plugin.jpg" width=80% title="QoSAwareNodeResourcesFit Plugin" loading="eager" />
   </picture>
 </div>
 
@@ -320,7 +320,7 @@ We will implement the following extension points:
 
 <div align="center">
   <picture>
-    <img src="/docs/imgs/scheduler-balanced-plugin.jpg" width=80% title="QoSAwareNodeResourcesBalancedAllocation Plugin" loading="eager" />
+    <img src="./scheduler-balanced-plugin.jpg" width=80% title="QoSAwareNodeResourcesBalancedAllocation Plugin" loading="eager" />
   </picture>
 </div>
 

diff --git a/docs/imgs/scheduler-balanced-plugin.jpg → .../scheduling/scheduler-balanced-plugin.jpg b/docs/imgs/scheduler-balanced-plugin.jpg → .../scheduling/scheduler-balanced-plugin.jpg
diff --git a/docs/imgs/scheduler-fit-plugin.jpg → ...osals/scheduling/scheduler-fit-plugin.jpg b/docs/imgs/scheduler-fit-plugin.jpg → ...osals/scheduling/scheduler-fit-plugin.jpg
diff --git a/docs/imgs/scheduler-overall-arch.jpg → ...als/scheduling/scheduler-overall-arch.jpg b/docs/imgs/scheduler-overall-arch.jpg → ...als/scheduling/scheduler-overall-arch.jpg
diff --git a/docs/roadmap.md b/docs/roadmap.md
@@ -10,7 +10,7 @@ This roadmap defines the core functionalities and features that katalyst plans t
       <th align="right">Milestone breakdown</th>
     </tr>
     <tr>
-      <td>Collocation for Pods with all QoS</td>
+      <td>Colocation for Pods with all QoS</td>
       <td>
         <ul>
           <li>Improve the isolation mechanism</li>

diff --git a/docs/tutorial/collocation.md → docs/tutorial/colocation.md b/docs/tutorial/collocation.md → docs/tutorial/colocation.md
@@ -1,5 +1,5 @@
-# Tutorial - katalyst collocation best-practices
-This guide introduces best-practices for collocation in katalyst with an end-to-end example. Follow the steps below to take a glance at the integrated functionality, and then you can replace the sample yamls with your workload when applying the system in your own production environment.
+# Tutorial - katalyst colocation best-practices
+This guide introduces best-practices for colocation in katalyst with an end-to-end example. Follow the steps below to take a glance at the integrated functionality, and then you can replace the sample yamls with your workload when applying the system in your own production environment.
 
 ## Prerequisite
 Please make sure you have deployed all pre-dependent components before moving on to the next step.