Fixing some of the linting erorrs

.github/workflows/proofreading-vale.yml

@@ -13,19 +13,18 @@ jobs:
       - name: Checkout
         uses: actions/checkout@692973e3d937129bcbf40652eb9f2f61becf3332 # v4.1.7
 
-
       - name: Harden Runner
         uses: step-security/harden-runner@91182cccc01eb5e619899d80e4e971d6181294a7 # v2.10.1
         with:
           egress-policy: audit
 
-
       - name: Run Vale
         uses: errata-ai/vale-action@91ac403e8d26f5aa1b3feaa86ca63065936a85b6 # reviewdog
         env:
           REVIEWDOG_GITHUB_API_TOKEN: ${{ secrets.VALE_GITHUB_TOKEN }}
         with:
           files: '["content", "README.md"]'
           # github-pr-check, github-pr-review, github-check
+          # more info on these: https://github.com/reviewdog/reviewdog#reporters 
           reporter: github-pr-check
           token: ${{secrets.VALE_GITHUB_TOKEN}}

.vale.ini

@@ -15,6 +15,8 @@ Vocab = Nephio
 [*.md]
 BasedOnStyles = Vale, proselint, alex
 
+SkippedScopes = iframe
+
 # based on https://github.com/errata-ai/Hugo/blob/main/Hugo/.vale.ini
 # Exclude `{{< ... >}}`, `{{% ... %}}`, [Who]({{< ... >}})
 TokenIgnores = ({{[%<] .* [%>]}}.*?{{[%<] ?/.* [%>]}}), \

.vale/config/vocabularies/Nephio/accept.txt

@@ -1,4 +1,5 @@
 # Accepted words (other acronyms must be explained)
+Ansible
 API
 APIs
 apiserver
@@ -7,6 +8,7 @@ ASNs
 [Aa]utoscaling
 cabundle
 [Cc]onfigmap
+[Cc]loudified
 CLI
 CRD
 CRDs
@@ -17,6 +19,7 @@ Gitea
 GitHub
 GitLab
 Graphviz
+[Hh]ostname
 [Hh]omebrew
 [Kk]pt
 [Kk]ptfile
@@ -30,8 +33,14 @@ NFDeployment
 NFs
 [Mm]akefile
 Multus
+[Mm]ultivendor
+[Mm]ulticloud
+OAuth
 OCI
 [Oo]nboarding
+[Oo]nboarded
+Okta
+[Pp]arameterization
 parameterRef
 passwordless
 [Pp]kgserver
@@ -44,8 +53,15 @@ sudo
 TLS
 [Tt]riage
 [Tt]ko
+[Tt]oolchain
 [Uu]ntar
+VirtualBox
 VM
 VMs
-VSCode
-VSphere
+VS Code
+vSphere
+WebUI
+xApps
+
+# Nephio contributors mentioned in the docs
+Tal Liron

content/en/docs/architecture.md

@@ -21,7 +21,7 @@ The system context view gives a high level perspective of the Nephio software sy
 
 ![System Landscape](/static/images/architecture/level2-nephio-container.png)
 
-Nephio is an amalgamation of software systems, so a system landscape provides a high-level view of how those software systems interoperate.
+Nephio is an amalgamation of software systems, so a system landscape provides a high-level view of how those software systems operate together.
 
 ## Component Views
 

content/en/docs/guides/install-guides/common-dependencies.md

@@ -12,7 +12,7 @@ installation, the CRDs that come along with them are necessary.
 
 {{% alert title="Note" color="primary" %}}
 
-If you want to use a version other than that of `v3.0.0` of Nephio `catalog` repo, then replace the `@origin/v3.0.0` suffix on the package URLs on the `kpt pkg get` commands below with the tag/branch of the version you wish to use.
+If you want to use a version other than that of `v3.0.0` of Nephio `catalog` repository, then replace the `@origin/v3.0.0` suffix on the package URLs on the `kpt pkg get` commands below with the tag/branch of the version you wish to use.
 
 While using KPT you can [either pull a branch or a tag](https://kpt.dev/book/03-packages/01-getting-a-package) from a git repository. By default it pulls the tag. In case, you have branch with the same name as a tag then to:
 
@@ -51,7 +51,7 @@ kpt live apply resource-backend --reconcile-timeout=15m --output=table
 ## Setup a Downstream Git Repository 
 
 Nephio needs a git repository (as a source of truth) to store the packages 
-which are getting deployed or are already deployed on the cluster. Either you can use Github/Gitlab or Gitea. If you want to use [Gitea](https://about.gitea.com/), 
+which are getting deployed or are already deployed on the cluster. Either you can use GitHub, GitLab or Gitea. If you want to use [Gitea](https://about.gitea.com/), 
 then you can follow below steps:
 
 ```bash

content/en/docs/guides/install-guides/demo-vagrant-windows.md

@@ -6,14 +6,14 @@ weight: 6
 ---
 
 {{% pageinfo %}}
-This page is draft and the separation of the content to different categories is not clearly done. 
+This page is draft and the separation of the content to different categories is not done. 
 {{% /pageinfo %}}
 
 
 ## Steps
 
 - Install git
-- Install virtualbox
+- Install VirtualBox
 - Install [vagrant](https://developer.hashicorp.com/vagrant/docs/installation)
 - open git bash
 - `git clone https://github.com/nephio-project/test-infra.git && cd test-infra/e2e/provision`
@@ -32,7 +32,7 @@ the Vagrant.configure:
 
 `config.vm.network "private_network", ip: "192.168.50.4", virtualbox__intnet: true`
 
-But the easiest way is to force the port-forwarding as shown before:
+The easiest way is to force the port-forwarding as shown before:
 
 `vagrant ssh -- -L 7007:localhost:7007 -L 3000:172.18.0.200:3000`
 

content/en/docs/guides/install-guides/webui.md

@@ -6,26 +6,26 @@ weight: 6
 ---
 
 {{% pageinfo %}}
-This page is draft and the separation of the content to different categories is not clearly done. 
+This page is draft and the separation of the content to different categories is not clear. 
 {{% /pageinfo %}}
 
 
 ## Nephio WebUI
 
-To install the WebUI, we simply install a different kpt package. First, we pull the package locally:
+To install the WebUI, we install a different kpt package. First, we pull the package locally:
 
 ```bash
 kpt pkg get --for-deployment https://github.com/nephio-project/nephio-packages.git/nephio-webui@origin/v3.0.0
 ```
 
 Before we apply it to the cluster, however, we should configure it.
 
-By default, it expects the webui to be reached via `http://localhost:7007`. If you plan to expose the webui via a load
+By default, it expects the WebUI to be reached via `http://localhost:7007`. If you plan to expose the WebUI via a load
 balancer service instead, then you need to configure the scheme, hostname, port, and service. Note that if you wish to
 use HTTPS, you should set the `scheme` to `https`, but you will need to terminate the TLS at the load balancer as the
 container currently only supports HTTP.
 
-This information is captured in the application ConfigMap for the webui, which is generated by a KRM function. We can
+This information is captured in the application ConfigMap for the WebUI, which is generated by a KRM function. We can
 change the values in `nephio-webui/gen-configmap.yaml` just using a text editor (change the `hostname` and `port` values
 under `params:`), and those will take effect later when we run `kpt fn render`. As an alternative to a text editor, you
 can run these commands:
@@ -43,15 +43,15 @@ or run:
 kpt fn eval nephio-webui --image gcr.io/kpt-fn/search-replace:v0.2.0 --match-kind Service -- 'by-path=spec.type' 'put-value=LoadBalancer'
 ```
 
-In the default configuration, the Nephio WebUI *is wide open with no authentication*. The webui itself authenticates to
-the cluster using a static service account, which is bound to the cluster admin role. Any user accessing the webui is
+In the default configuration, the Nephio WebUI *is wide open with no authentication*. The WebUI itself authenticates to
+the cluster using a static service account, which is bound to the cluster admin role. Any user accessing the WebUI is
 *acting as a cluster admin*.
 
 This configuration is designed for *testing and development only*. You must not use this configuration in any other
 situation, and even for testing and development it must not be exposed on the internet (for example, via a LoadBalancer
 service).
 
-Configuring authentication for the WebUI is very specific to the particular cluster environment. Guides for different
+Configuring authentication for the WebUI is specific to the particular cluster environment. Guides for different
 environments are below:
 
 - [Google OAuth or OIDC](/content/en/docs/guides/install-guides/webui-auth-gcp.md)

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

@@ -65,8 +65,8 @@ The following limitations need to be borne in mind:
 
 * For infrastructure automation, only the creation of KIND clusters is
   supported.
-* Intercluster networking is not dynamic. Therefore, as more clusters are
-  deployed, some manual tweaking will be needed for intercluster communications.
+* 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 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

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

@@ -52,7 +52,7 @@ The following functionalities are supported:
   * API changes 
   * Generalization 
   * Parameterization
-  * Reuse of params 
+  * Reuse of parameters
 * Multicloud support
   * Sandbox
   * GCP
@@ -65,7 +65,7 @@ The following functionalities are supported:
   * Porch is now part of Nephio and is hosted in the Nephio repository.
   * Stability.
   * Security.
-  * Repo watcher changes.
+  * Repository watcher changes.
 * Documentation
   * New web-based documentation.
 * Experimental
@@ -129,11 +129,11 @@ The following limitations need to be borne in mind:
   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.
-* During specialization, we may have duplicate parameterRef extensions, leading to failed deployments
+* During specialization, we may have duplicate parameterRef extensions, leading to unsuccesfull deployments
   (the wrong configurations are generated). The current workaround is to redeploy the package. The bug is
   due to the NFDeploy reconciliation not being idempotent.
 
 * The free5GC operator may create duplicate entries in the SMF function configuration. This will not do
   any harm, but is nevertheless incorrect.
-* Links in the documentation may not render in Github, due to the limitations of the tool being used for
+* Links in the documentation may not render in GitHub, due to the limitations of the tool being used for
   web-based documentation.

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

@@ -45,11 +45,11 @@ UI received dependency refresh, new Tabs component and security vulnerabilities
   * Fixes, Security patches and enhancements to Porch. See [Appendix](#appendix) for details.
   * The Porch development environment is much improved, with a tutorial, script support, and makefile targets available. Developers can now
     * Run Porch locally on Kind
-    * Run the Porch Server or Porch controllers in vscode towards a local Kind porch installation
+    * Run the Porch Server or Porch controllers in VS Code towards a local Kind porch installation
     * Run the end to end tests locally
     * Work on Linux or MacOS locally or using a VM
   * The Porch documentation was improved with the addition of a Porch tutorial, which steps the user through the main Porch use cases. Documentation on how to use Porchctl was also added
-  * The Porch build and test toolchain was heavily augmented. Among them was stepping the Go version to 1.22, adding Github actions to build the latest Porch and Porchctl images, support for running the Porch/Porchctl tests locally, and stepping the versions of various dependencies.
+  * The Porch build and test toolchain was heavily augmented. Among them was stepping the Go version to 1.22, adding GitHub actions to build the latest Porch and Porchctl images, support for running the Porch/Porchctl tests locally, and stepping the versions of various dependencies.
 
 * Documentation
   * Improvements in aesthetics and bug fixes
@@ -61,7 +61,7 @@ UI received dependency refresh, new Tabs component and security vulnerabilities
 * Nephio experimental
   * [Ytt-declarative-configuration](https://github.com/nephio-experimental/ytt-declarative-configuration) added. This is a generic KPT Function that utilizes the power YTT to achieve higher-level intent automation, reducing complexities and costs associated with infrastructure provisioning.
   This simplifies deployment and management for the operator by enabling YTT’s templating capabilities to configure network functions.
-  * [Tko](https://github.com/nephio-experimental/tko) is a self-contained playground for new ideas for Nephio’s future. It stores all data in a traditional SQL backend by default (including support for planetary-scale databases, such as Spanner), validates all KRM before allowing it to be stored in the backend, implements a minimalistic plugin system (included is an SDK for Python-based plugins as well as support for kpt functions), includes a topology plugin (with support for TOSCA) as well as native Helm support, and implements a more declarative specialization workflow. Also includes web and terminal UIs (TUI).
+  * [Tko](https://github.com/nephio-experimental/tko) is a self-contained playground for new ideas for Nephio’s future. It stores all data in a traditional SQL backend by default (including support for planetary-scale databases, such as Spanner), validates all KRM before allowing it to be stored in the backend, implements a minimalistic plugin system (included is an SDK for Python-based plugins as well as support for kpt functions), includes a topology plugin (with support for TOSCA) as well as native Helm support, and implements a more declarative specialization workflow. Also includes web and terminal user interfaces (UIs) (TUI).
 
 * Security
   * OpenSSF best practices score improved from 3.6 to 7.6
@@ -114,7 +114,7 @@ UI received dependency refresh, new Tabs component and security vulnerabilities
   * Using the default exponential back-off in case of errors instead of a constant 30 sec retry, see https://github.com/nephio-project/porch/pull/76
   * Showing kpt package rendering errors via the status of PackageVariant, see https://github.com/nephio-project/porch/pull/75
   * Support for new field selectors: spec.workspaceName and spec.lifecycle on PackageRevision resources, see https://github.com/nephio-project/porch/pull/70
-  * Caching in the case of multiple Repository resources pointing to the same git repo is fixed, see https://github.com/nephio-project/porch/pull/68
+  * Caching in the case of multiple Repository resources pointing to the same git repository is fixed, see https://github.com/nephio-project/porch/pull/68
   * The PackageRevision's metadata.uid field is now unique, see https://github.com/nephio-project/porch/pull/61
   * Caching for packageRevisionResources is removed, they should not have been cached, see https://github.com/nephio-project/porch/pull/55
   * Pod templating for function runner is introduced, see https://github.com/nephio-project/porch/pull/54
@@ -125,10 +125,10 @@ UI received dependency refresh, new Tabs component and security vulnerabilities
   * Better unit testing for rpkg commands, see https://github.com/nephio-project/porch/pull/33
   * Porchctl rpkg commands now print to stdout on normal completion and stderr on errors, see https://github.com/nephio-project/porch/pull/30
 * Porch Security Improvements
-  * TSupport for cabundle tls for git repo comms, see https://github.com/nephio-project/porch/pull/58
-  * TConfiguration of an external webhook and associated certs for resource deletion is now supported https://github.com/nephio-project/porch/pull/53
-  * TMissing repository RBAC roles for porch controllers were added, see https://github.com/nephio-project/porch/pull/56
-  * TThe porch namespace in the generated cert/webhook can now be configured https://github.com/nephio-project/porch/pull/26
+  * Support for CA bundle TLS for git reporepository communications, see https://github.com/nephio-project/porch/pull/58
+  * Configuration of an external webhook and associated certs for resource deletion is now supported https://github.com/nephio-project/porch/pull/53
+  * Missing repository RBAC roles for porch controllers were added, see https://github.com/nephio-project/porch/pull/56
+  * The porch namespace in the generated cert/webhook can now be configured https://github.com/nephio-project/porch/pull/26