[yunikorn-site] branch master updated: [YUNIKORN-1291] Expose message design doc (#179)

[wi...@apache.org]

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

wilfreds pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/yunikorn-site.git


The following commit(s) were added to refs/heads/master by this push:
     new 0dc945756 [YUNIKORN-1291] Expose message design doc (#179)
0dc945756 is described below

commit 0dc945756a2e3e358cd79427b13f6452b28415cc
Author: Manikandan R <ma...@gmail.com>
AuthorDate: Thu Aug 25 12:34:32 2022 +1000

    [YUNIKORN-1291] Expose message design doc (#179)
    
    The interface message simplification design document was added but never
    exposed on the website. Add it to the sidebar to make it viewable.
    
    Fixes typos in the document
    
    Closes: #179
    
    Signed-off-by: Wilfred Spiegelenburg <wi...@apache.org>
---
 docs/design/cache_removal.md                    |  5 +++++
 docs/design/interface_message_simplification.md | 10 +++++-----
 sidebars.js                                     |  1 +
 3 files changed, 11 insertions(+), 5 deletions(-)

diff --git a/docs/design/cache_removal.md b/docs/design/cache_removal.md
index 9e6c4d468..f78ba07c4 100644
--- a/docs/design/cache_removal.md
+++ b/docs/design/cache_removal.md
@@ -21,6 +21,11 @@ title: Scheduler cache removal design
  * limitations under the License.
  -->
 
+:::caution
+The Interface Message definitions described in this design doc has undergone major refactoring to reduce the complexity. [YUNIKORN-337](https://issues.apache.org/jira/browse/YUNIKORN-337) was committed and simplified the message communication between Core and Shim to greater extent. 
+See [Simplifying Interface Messages and Breaking Shim build dependency on Core](interface_message_simplification.md) to know the updated message definitions.
+:::
+
 # Proposal to combine Cache and Scheduler's implementation in the core
 This document describes the current state of the scheduler and cache implementation.
 It describes the changes planned based on the analysis that was done of the current behaviour.
diff --git a/docs/design/interface_message_simplification.md b/docs/design/interface_message_simplification.md
index 22ffa5a73..b6766ced4 100644
--- a/docs/design/interface_message_simplification.md
+++ b/docs/design/interface_message_simplification.md
@@ -1,6 +1,6 @@
 ---
-id: interface_message_simplication
-title: Simplyfing Interface Messages
+id: interface_message_simplification
+title: Simplifying Interface Messages
 ---
 
 <!--
@@ -21,7 +21,7 @@ title: Simplyfing Interface Messages
  * limitations under the License.
  -->
 
-# Simplyfing Interface Messages and Breaking Shim build dependency on Core
+# Simplifying Interface Messages and Breaking Shim build dependency on Core
 
 # Proposal
 This document describes a) complexity hidden behind existing Interface messages and 
@@ -39,7 +39,7 @@ The current interface allows us to only send one message between a shim and the
 The complexity is however hidden in the message itself. Every message serves multiple purposes and when the message is received the core and shim need to unpack it and process each part separately and for certain parts in a real specific order.
 Because the message serves a number of purposes it has a large overhead. This might not show up in the code directly as the heavy lifting is done in the generated code. It will show up in the amount of data as a message, even if it does not have all fields, still needs to be encoded in a way that it unpacks correctly on the other side.
 
-## Simplfying Interface Messages
+## Simplifying Interface Messages
 
 Proposal is to split the one large message into 3 separate messages - one for each entity:
 
@@ -306,4 +306,4 @@ Moved all plugins from core to appropriate place in SI under ResourceManagerCall
 a single common interface.
 
 ### Phase 2
-Please refer https://issues.apache.org/jira/browse/YUNIKORN-930 for more details
\ No newline at end of file
+Please refer https://issues.apache.org/jira/browse/YUNIKORN-930 for more details
diff --git a/sidebars.js b/sidebars.js
index ff4964315..b5492fac5 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -65,6 +65,7 @@ module.exports = {
                     'design/k8shim',
                     'design/scheduler_plugin',
                     'design/gang_scheduling',
+                    'design/interface_message_simplification',
                     'design/cache_removal',
                     'design/generic_resource',
                     'design/namespace_resource_quota',