From eec41c3e79d3cfe8611d705e80af8c2b60641683 Mon Sep 17 00:00:00 2001 From: rpaik Date: Wed, 18 Apr 2018 10:56:27 -0700 Subject: Minor edits to release notes and user guides Change-Id: I093fb995f108194367334c4215780b5884d0207a Signed-off-by: rpaik --- docs/release/release-notes/Fraser-release-notes.rst | 10 +++++----- docs/release/userguide/Fraser-userguide.rst | 12 ++++++------ 2 files changed, 11 insertions(+), 11 deletions(-) (limited to 'docs/release') diff --git a/docs/release/release-notes/Fraser-release-notes.rst b/docs/release/release-notes/Fraser-release-notes.rst index 3e864fb..becd2da 100644 --- a/docs/release/release-notes/Fraser-release-notes.rst +++ b/docs/release/release-notes/Fraser-release-notes.rst @@ -4,7 +4,7 @@ .. (c) optionally add copywriters name -This document provides the release notes for Fraser of OPNFV Clover. +This document provides Clover project's release notes for the OPNFV Fraser release. .. contents:: :depth: 3 @@ -25,8 +25,8 @@ Version history Important notes =============== -The OPNFV Clover project for Fraser can ONLY be run on Kubernetes version 1.9.3 or -above +The Clover project for OPNFV Fraser can ONLY be run on Kubernetes version 1.9.3 or +later Summary ======= @@ -61,11 +61,11 @@ Version change Module version changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Fraser marks the first release of OPNFV Clover +OPNFV Fraser marks the first release for Clover Document version changes ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -Fraser marks the first release of OPNFV Clover +OPNFV Fraser marks the first release for Clover Reason for version ^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/release/userguide/Fraser-userguide.rst b/docs/release/userguide/Fraser-userguide.rst index 243c4e1..a15fdc1 100644 --- a/docs/release/userguide/Fraser-userguide.rst +++ b/docs/release/userguide/Fraser-userguide.rst @@ -8,7 +8,7 @@ Clover User Guide (Fraser Release) ================================================================ -This document provides the user guide for Fraser release of Clover. +This document provides the Clover user guide for OPNFV Fraser release. .. contents:: :depth: 3 @@ -18,9 +18,9 @@ This document provides the user guide for Fraser release of Clover. Description =========== -Project Clover was established to investigate best practice to implement, +Project Clover was established to investigate best practices to implement, build, deploy, and operate virtual network functions as cloud native -applications. "Cloud native" has a ever evolving and expanding definition, +applications. "Cloud native" has an ever evolving and expanding definition, and in Clover, the focus is effectively running and operating VNFs built in a micro-service design pattern running on Docker containers and orchestrated by Kubernetes. @@ -57,8 +57,8 @@ What is in Fraser? Usage ===== - * each modules (service mesh, logging, tracing, monitoring) are Python - modules with their own set of library calls / API exposed. The descriptions + * each module (service mesh, logging, tracing, monitoring) is a Python + module with its own set of library calls/ API exposed. The descriptions of these library calls are under doc/developer (TBD) * tools directory contains Python tools for generic use @@ -72,7 +72,7 @@ Usage - user specify via yaml the "success" expectation of v2 (latency, performance, session loss...etc) - Clover tool validates sessions conformance with user defined expectations - - The "commit" action is invoked to move 100% traffic to v2 + - The "commit" action is invoked to move 100% of the traffic to v2 - Clover tool validates traffic conformance with route rules - A fault is injected for the path to the extra service of v2 which adds a one second delay onto the path -- cgit 1.2.3-korg