From 71565d58f4569678d01ccd0c18e294e81b3da1b4 Mon Sep 17 00:00:00 2001
From: hackerwins <susukang98@gmail.com>
Date: Wed, 6 Jan 2021 05:32:30 +0900
Subject: [PATCH] Adjust sections and add template

---
 design/peer-awareness.md | 47 +++++++++++++++++++++++++++++++++-------
 design/template.md       | 28 ++++++++++++++++++++++++
 2 files changed, 67 insertions(+), 8 deletions(-)
 create mode 100644 design/template.md

diff --git a/design/peer-awareness.md b/design/peer-awareness.md
index ef8f9acb9..6ae3757a9 100644
--- a/design/peer-awareness.md
+++ b/design/peer-awareness.md
@@ -1,12 +1,30 @@
+---
+title: peer-awareness
+target-version: 0.1.2
+---
+
 # Peer Awareness
 
-Target version: Yorkie 0.1.2
+## Summary
+
+We will provide Peer Awareness which is a simple algorithm that manages end-user
+status like who is connected and metadata like username or email address and etc.
+For example, users can implement a list of people participating in the editing,
+such as a box in the top right of Google Docs.
+
+### Goals
 
-## Use case
+Implement Peer Awareness and provide API to users to use the feature. The goal of
+the first version is to implement simple functionality and check usability.
 
-When multiple users edit a single document, the users want to know who is connected and what is being edited by the peers. For example, in Google Docs, the ID and profile of the user editing together are displayed in the upper-right.
+### Non-Goals
 
-## How to use
+The first version does not implement complex features such as dynamic metadata
+updates.
+
+## Proposal details
+
+### How to use
 
 Users can pass metadata along with client options when creating a client.
 
@@ -25,7 +43,8 @@ const doc = yorkie.createDocument('examples', 'codemirror');
 await client.attach(doc);
 ```
 
-When a new peer registers or leaves, `peers-changed` event is fired, and the other peer's clientID and metadata can be obtained from the event.
+When a new peer registers or leaves, `peers-changed` event is fired, and the
+other peer's clientID and metadata can be obtained from the event.
 
 ```typescript
 client.subscribe((event) => {
@@ -38,7 +57,7 @@ client.subscribe((event) => {
 });
 ```
 
-## How does it work?
+### How does it work?
 
 ```
  +--Client "A"----+                      +--Agent-----------------+
@@ -54,11 +73,23 @@ client.subscribe((event) => {
  +----------------+                      +------------------------+
 ```
 
-When a client attaches documents, a stream is connected between agent and the client through WatchDocuments API. This will update the map of clients that are watching the documents in PubSub. When the stream disconnects or a new connection is made, `DOCUMENTS_UNWATCHED` or `DOCUMENTS_WATCHED` event is delivered to other clients who are watching the document together.
+When a client attaches documents, a stream is connected between agent and
+the client through WatchDocuments API. This will update the map of clients that
+are watching the documents in PubSub. When the stream disconnects or a new connection
+is made, `DOCUMENTS_UNWATCHED` or `DOCUMENTS_WATCHED` event is delivered to other clients
+who are watching the document together.
+
+### Risks and Mitigation
 
-Client Metadata is managed inside the instance of the Client and is not stored persistently in Yorkie. The reasons are as follows:
+The first version is missing the ability to dynamically update metadata and
+propagate it to other peers. Client Metadata is managed inside the instance of the Client
+and is not stored persistently in Yorkie. The reasons are as follows:
 
+ - The goal of the first version is to check the usability of the feature.
  - Metadata's primary "source of truth" location is user's DB, and it is simply passed to Yorkie.
  - All other locations of the metadata in Yorkie just refer back to the primary "source of truth" location.
  - We can prevent increasing management points caused by storing metadata in MongoDB.
 
+In the future, if the users needs arise, we may need to implement the ability to
+dynamically update metadata and propagates it to peers. We might consider
+treating it as a Yorkie Document that has logical clocks, not a normal map in PubSub.
diff --git a/design/template.md b/design/template.md
new file mode 100644
index 000000000..b192c1919
--- /dev/null
+++ b/design/template.md
@@ -0,0 +1,28 @@
+---
+title: feature-name
+target-version: X.X.X
+---
+
+# Feature Name
+
+## Summary
+
+Write a brief description of the feature here.
+
+### Goals
+
+List the specific goals of the proposal. How will we know that this has succeeded?
+
+### Non-Goals
+
+What is out of scope for this proposal? Listing non-goals helps to focus discussion
+and make progress.
+
+## Proposal details
+
+This is where we detail how to use the feature with snippet or API and describe
+the internal implementation.
+
+### Risks and Mitigation
+
+What are the risks of this proposal and how do we mitigate.