Language corrections to R1 Release Notes. (#152)

Signed-off-by: Michael Greaves <[email protected]>

content/en/docs/release-notes/R1.md

@@ -7,93 +7,104 @@ weight: 1
 
 ## Prerequisites
 
-Please refer to the [Install Guide](/content/en/docs/guides/install-guides/_index.md)
-for the prerequisites on supported environments.
+Refer to the [Install Guide](/content/en/docs/guides/install-guides/_index.md)
+for the prerequisites for the supported environments.
 
-## Support Matrix
+## Support matrix
 
-The sandbox environment requires a physical or virtual machine with:
+The sandbox environment requires a physical or virtual machine with the following:
 - Ubuntu-20.04-focal Linux
 - 8 cores
 - 32 GB memory
 - 200 GB disk size
 - default user with sudo passwordless permissions
 
 This install has been verified on VMs running on Google Cloud, OpenStack, AWS,
-vSphere, and Azure. It has been verified on Vagrant VMs running on Windows and
-Linux.
+vSphere, and Azure. It has also been verified on Vagrant VMs running on Windows
+and Linux.
 
 For non-sandbox installations, any conforming Kubernetes cluster is sufficient
-for the Management cluster.
+for the management cluster.
 
 ## Features
 
 ### API
 
-CRDs provided for UPF, SMF and AMF 5G Core services
+CRDs are provided for UPF, SMF, and AMF 5G Core services.
 
 ### Web UI
 
-Basic web UI to view and manage the packages and resources within them.
+Nephio has a basic Web UI to view and manage the packages, as well as the
+resources contained in the packages.
 
 ### Packages
 
-* Kpt packages for all [free5GC](https://free5gc.org/) services
-* Packages for the core Nephio services
-* Packages for the Cluster API services for cluster creation
-* Packages for the dependent services
+The following packages are supported:
+
+* Kpt packages for all [free5GC](https://free5gc.org/) services.
+* Packages for the core Nephio services.
+* Packages for the Cluster API services for cluster creation.
+* Packages for the dependent services.
 
 ### Functionalities
 
-* Create Kubernetes clusters. This functionality is based on the Cluster API. At
-  this time only KIND cluster creation is supported.
-* Fully automated deployment of UPF, SMF and AMF services of
+The following functionalities are supported:
+
+* Create Kubernetes clusters. This functionality is based on the Cluster API.
+  At this time, only Kubernetes in Docker (KIND) cluster creation is supported.
+* Fully automated deployment of UPF, SMF, and AMF services of
   [free5GC](https://free5gc.org/). These are deployed on multiple clusters
-  based on user's intent expressed via the CRDs.
+  based on the user's intent, expressed via the CRDs.
 * Deployment of other free5GC functions.
-* Auto scaling up of the UPF, SMF and AMF services based on changes to the capacity
+* Autoscaling up of the UPF, SMF, and AMF services based on changes to the capacity
   requirements expressed as user intent.
 
 ## Limitations
 
-* For infrastructure automation, only creation of KIND clusters is
+The following limitations need to be borne in mind:
+
+* For infrastructure automation, only the creation of KIND clusters is
   supported.
-* Inter-cluster networking is not dynamic so as more clusters are
+* Inter-cluster networking is not dynamic. Therefore, as more clusters are
   deployed, some manual tweaking will be needed for inter-cluster communications.
-* Provisioning of VLAN interfaces on nodes is manual at this time.
+* Provisioning of VLAN interfaces on nodes is currently performed manually.
 * Feedback of workload deployments from workload clusters to the Management
-  cluster is limited. You may need to connect directly to the Workload cluster
+  cluster is limited. You may need to connect directly to the workload cluster
   via kubectl to debug any deployment issues.
-* Web UI features are limited to view/edit of packages and resources in those
-  packages and their deployment. Additional features will be added
-  in subsequent releases.
-* When the capacities of the UPF,SMF and AMF NFs are changed, the free5GC Operator on the
-  Workload cluster will instantiate a new POD with correspondingly modified
-  resources (CPU, memory etc.) During this process, the pod will restart. This is a
-  limitation of free5GC.
+* Web UI features are limited to the viewing and editing of packages, as well as
+  the resources in those packages and their deployment. Additional features will
+  be added in subsequent releases.
+* When the capacities of the UPF, SMF, and AMF NFs are changed, the free5GC
+  Operator on the workload cluster will instantiate a new POD with correspondingly
+  modified resources (CPU, memory, and so on) During this process, the POD will
+  restart. This is a limitation of free5GC.
 * Only Gitea works with automated cluster provisioning to create new
   repositories and join them to Nephio. To use a different Git provider, you
-  must manually provision cluster repositories, register them to the Nephio
-  management server, and set up Config Sync on the Workload cluster.
-* The WebUI does not require authentication in the current demo configuration.
-  Testing of the WebUI with authentication configured has not been done at this
-  time.
-* The WebUI only shows resources in the default namespace.
-* While many types of Git authentication are supported, the testing was only
+  must manually provision the cluster repositories, register them to the Nephio
+  management server, and set up Config Sync on the workload cluster.
+* In the current demo configuration, the Web UI does not require authentication.
+  Testing of the Web UI with authentication configured has not yet been done.
+* The Web UI only shows resources in the default namespace.
+* While many types of Git authentication are supported, testing has only been
   done with token-based Git authentication in Gitea.
 
-## Known Issues and Workarounds
+## Known issues and workarounds
 
 * When deploying the sandbox environment on an Ubuntu VM running on OpenStack,
   the deployment may fail. Reinstalling the packages will get around this issue.
-* Occasionally packages may take a long time to be approved by the auto-approval
-  controller. If they seem stuck, restarting Porch and the Nephio controllers
-  may help:
+* Packages may take time to be approved by the auto-approval controller. If they
+  appear to have frozen, it may help to restart Porch and the Nephio controllers
+  using the following commands:
+
   ```bash
   kubectl -n porch-system rollout restart deploy porch-server
   kubectl -n nephio-system rollout restart deploy nephio-controller
   ```
-* Occasional calls to `kpt alpha rpkg copy` may fail with a message like
+* Occasional calls to `kpt alpha rpkg copy` may fail with the following message,
+  or similar:
+
   `Error: Internal error occurred: error applying patch: conflict: fragment line
-  does not match src line`. Try again in a little while, this may clear up on
-  its own. Restarting Porch may also help.
+  does not match src line`.
+
+  If such a message appears, then retry in a little while, as this error may
+  resolve itself. Restarting Porch may also help.