Reorganize change logs, licenses, and community outreach activities

CentaurusInfra · Apr 6, 2020 · a6d8e8e · a6d8e8e
1 parent f59d14c
commit a6d8e8e
Show file tree

Hide file tree

Showing 9 changed files with 394 additions and 42 deletions.
diff --git a/docs/CHANGELOG/CHANGELOG-0.1.md b/docs/CHANGELOG/CHANGELOG-0.1.md
@@ -0,0 +1,7 @@
+### Summary
+
+This release is our very first release of Mizar including:
+
+ *  A basic implementation of the data plane and a mini controller;
+ *  Create and deletion of VPC/subnet/ports objects.
+ *  Initial automated test and deployment scripts.
diff --git a/docs/CHANGELOG/CHANGELOG-0.2.md b/docs/CHANGELOG/CHANGELOG-0.2.md
@@ -0,0 +1,23 @@
+### Summary
+
+This release primarily introduces the beta implementation of direct-path (fast-path),
+and scaled endpoints. The releases also provides hooks within the data-plane to
+support extensibility at various stages of the packet processing pipeline.
+
+### Breaking Changes
+
+This release does not involve breaking changes to existing
+integrations.
+
+### Data Plane
+
+ 1. Fast path (beta)
+ 1. Scaled endpoint (beta)
+ 1. Performance improvements
+ 1. Extensible packet processing pipeline support
+
+### Documentation
+ 1. Components name changes proposal
+
+### Continuous Integration
+ * Codedeploy support
diff --git a/docs/releases/release-notes.md → docs/CHANGELOG/CHANGELOG-0.3.md b/docs/releases/release-notes.md → docs/CHANGELOG/CHANGELOG-0.3.md
@@ -1,43 +1,3 @@
-<!--
-SPDX-License-Identifier: MIT
-Copyright (c) 2020 The Authors.
-
-Authors: Sherif Abdelwahab <@zasherif>
-         Phu Tran          <@phudtran>
-
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:The above copyright
-notice and this permission notice shall be included in all copies or
-substantial portions of the Software.THE SOFTWARE IS PROVIDED "AS IS",
-WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED
-TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
-FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
-THE USE OR OTHER DEALINGS IN THE SOFTWARE.
--->
-
-## Release 0.1 (09/30/2019)
-
- *  A basic implementation of the data plane and a mini controller;
- *  Create and deletion of VPC/subnet/ports objects.
- *  Initial automated test and deployment scripts.
-
-## Release 0.5 (12/30/2019)
-
- * Fast path (beta)
- * Scaled endpoint (beta)
- * Components name changes
- * Performance improvements
- * Extensible packet processing pipeline support
- * Codedeploy support
-
-## Release 0.7 (03/30/2020)
-
 ### Summary
 
 This release introduces a new management plane for Mizar, designed and

diff --git a/docs/licenses/gpl.md b/docs/licenses/gpl.md
diff --git a/docs/licenses/license.md b/docs/licenses/license.md
@@ -0,0 +1,2 @@
+1. [Dataplane license](gpl.md)
+1. [Management Plane license](mit.md)
diff --git a/docs/licenses/mit.md b/docs/licenses/mit.md
@@ -0,0 +1,7 @@
+# Released under MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
diff --git a/docs/talks/Mizar-research-v3.pdf → docs/outreach/Mizar-research-v3.pdf b/docs/talks/Mizar-research-v3.pdf → docs/outreach/Mizar-research-v3.pdf
diff --git a/docs/outreach/community.md b/docs/outreach/community.md
@@ -0,0 +1,10 @@
+## Chronology of Socialization Activities
+- **ICNP 2019 Networking Conference (October 7-10, 2019, Chicago, Illinois, USA)**: Displayed Mizar networking open source project details as part of Futurewei booth during the conference. Also, socialized Mizar project with various professors and researchers. Scheduled follow on detail sessions during the subsequent weeks.
+- **Open Source Summit Europe 2019 (October 28-30, 2019, Lyon, France)**: Met Linux Foundation executives for socializing Mizar project as well as possibility of landing Mizar as an official Linux Foundation project. They seem to be open to our proposal. They asked us to firstly sync. up with Network Service Mesh (NSM) folks for possible synergy & their feedback.
+- **Socialization with various Universities**: Mizar networking open source project overview session with professors & researchers from various universities. We went over the possible collaboration areas researchers/academia can get involved in.
+- **KubeCon North America (November 18-21, 2019, San Diego, USA)**: Displayed Mizar networking open source project details as part of Futurewei booth during the conference. Also, socialized Mizar project with eBPF/XDP community members.
+- **Network Service Mesh (NSM) Discussion**: Mizar networking open source project overview session with NSM folks. They provided a very positive feedback and liked our project. It seems that there is good synergy with regards to integrating Mizar data plane with Network Service Mesh project.
+
+### Talks and Videos:
+- [Research Slides](./Mizar-research-v3.pdf)
+- [Mizar Biweekly Open Source Community Meeting 04/02/2020](https://www.youtube.com/playlist?list=PL_7gYB_Le9d31Bpd3ZfyNE-c3AY-fYYw1)
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -27,9 +27,13 @@ nav:
         - 'Control Workflows': 'design/mp_workflows.md'
         - 'IP Address Management': 'design/mp_ipam.md'
         - 'Other Data-plane support': 'design/mp_dpsupport.md'
+    - Releases:
+        - '0.3': 'CHANGELOG/CHANGELOG-0.3.md'
+        - '0.2': 'CHANGELOG/CHANGELOG-0.2.md'
+        - '0.1': 'CHANGELOG/CHANGELOG-0.1.md'
     - About:
-        #- 'License': 'license.md'
+        - 'Licenses': 'licenses/license.md'
         - 'Use Cases': 'releases/use_cases.md'
-        - 'Release Notes': 'releases/release-notes.md'
         - 'Roadmap' : 'releases/roadmap.md'
+        - 'Outreach': 'outreach/community.md'
     - 'Frequently Asked Questions': 'user/faq.md'
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,2 @@
		1. [Dataplane license](gpl.md)
		1. [Management Plane license](mit.md)