From 967a3d177e96c5e0b1e66c8829b68b13e157fb82 Mon Sep 17 00:00:00 2001
From: Andy Zhang <xiazhang@microsoft.com>
Date: Sun, 6 Jan 2019 11:37:08 +0800
Subject: [PATCH] Update and rename design-goals.md to design.md

---
 docs/{design-goals.md => design.md} | 11 ++++++++++-
 1 file changed, 10 insertions(+), 1 deletion(-)
 rename docs/{design-goals.md => design.md} (59%)

diff --git a/docs/design-goals.md b/docs/design.md
similarity index 59%
rename from docs/design-goals.md
rename to docs/design.md
index a1a8cefc9..ca5e68c0e 100644
--- a/docs/design-goals.md
+++ b/docs/design.md
@@ -1,8 +1,9 @@
 # azurefile CSI driver design goals
-### azurefile CSI driver should be implemented as compatitable as possible with built-in [azurefile](https://kubernetes.io/docs/concepts/storage/volumes/#azurefile) plugin, it has following goals:
+ > azurefile CSI driver is implemented as compatitable as possible with built-in [azurefile](https://kubernetes.io/docs/concepts/storage/volumes/#azurefile) plugin, it has following goals:
 
 Goal | Status | Notes
 --- | --- | --- |
+Use same driver parameters with built-in [azurefile](https://kubernetes.io/docs/concepts/storage/volumes/#azurefile) plugin | Completed | [`file.csi.azure.com` driver parameters](./driver-parameters.md) |
 Support service principal and msi authentication | Completed |  |
 Support both Linux & Windows | In Progress | Windows related work is in progress: [Enable CSI hostpath example on windows](https://github.com/kubernetes-csi/drivers/issues/79) |
 Compatible with original storage class parameters and usage| Completed | There is a little difference in static provision, see [example](https://github.com/andyzhangx/azurefile-csi-driver/blob/master/README.md#example2-azurefile-static-provisioninguse-an-existing-azure-file-share) |
@@ -10,5 +11,13 @@ Support sovereign cloud| Completed |  |
 Support volume size grow| to-do |  |
 Support snapshot | to-do |  |
 
+### Other work items
+work item | Status | Notes
+--- | --- | --- |
+Complete all unit tests | In Progress |  |
+Set up E2E test | to-do |  |
+Implement NodeStage/NodeUnstage functions | to-do | two pods on same node could share same mount |
+Implement azure file csi driver on Windows | to-do |  |
+
 ### Implementation details
 To prevent possible regression issues, azurefile CSI driver use [azure cloud provider](https://github.com/kubernetes/kubernetes/tree/v1.13.0/pkg/cloudprovider/providers/azure) library. Thus, all bug fixes in the built-in azure file plugin would be incorporated into this driver.