Merge branch 'main' into grammar_corrections

.github/workflows/check-links-md.yml

@@ -6,7 +6,7 @@ on:
 
 jobs:
   docs:
-    runs-on: ubuntu-latest
+    runs-on: ubuntu-22.04
     steps:
     - name: Check out repository code
       uses: actions/checkout@v4

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

@@ -1,4 +1,5 @@
 # Accepted words (other acronyms must be explained)
+amfName
 Ansible
 Anthos
 API
@@ -7,6 +8,7 @@ apiserver
 ASN
 ASNs
 [Aa]utomations
+authProvider
 [Aa]utoscaling
 backtrackVal
 [Bb]ool
@@ -49,8 +51,8 @@ GVKs
 [Hh]ostname
 [Hh]omebrew
 html
-http
-https
+HTTP
+HTTPS
 JFrog
 JSON
 [Kk]pt
@@ -71,6 +73,7 @@ MetalLB
 Nephio
 nerdctl
 Netlify
+networkName
 NF
 NFDeploy
 NFDeployment
@@ -116,12 +119,14 @@ repoTest
 [Rr]pkg
 [Rr]oot[Ss]ync
 [Rr]ollout
+sbi
 SDK
 starlark
 stdout
 stderr
 [Ss]udo
 [Ss]ubpackage
+SSH
 [Sp]pecializer
 TLS
 [Tt]riage
@@ -136,6 +141,7 @@ URIs
 upsertRepo
 upstreamlock
 [Uu]ntar
+[Uu]ndeploy
 [Uu]tils
 validator
 vCPU
@@ -149,6 +155,7 @@ vSphere
 wantErr
 WebUI
 xApps
+XXFDeployment
 YAML
 
 # Nephio contributors mentioned in the docs

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*
+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

content/en/docs/guides/install-guides/install-on-byoc.md

@@ -22,7 +22,7 @@ your environment and choices.
  - *kpt* [installed](https://kpt.dev/installation/kpt-cli) on your workstation
    (version v1.0.0-beta.43 or later)
  - *porchctl* [installed](/content/en/docs/porch/user-guides/porchctl-cli-guide.md) on your workstation
- - Sudo-less *docker*, *podman*, or *nerdctl*. If using *podman* or *nerdctl*,
+ - Sudo-less *docker*, *Podman*, or *nerdctl*. If using *Podman* or *nerdctl*,
    you must set the
 [`KPT_FN_RUNTIME`](https://kpt.dev/reference/cli/fn/render/?id=environment-variables)
 environment variable.
@@ -125,9 +125,9 @@ If you wish to avoid running `kubectl port-forward`, the use of Kubernetes Ingre
 ### Nephio WebUI Authentication and Authorization
 
 In the default configuration, the Nephio WebUI **is wide open with no
-authentication**. The webui itself authenticates to the cluster using a static
+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**.
+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

content/en/docs/guides/install-guides/web-ui/_index.md

@@ -13,12 +13,12 @@ kpt pkg get --for-deployment https://github.com/nephio-project/nephio-packages.g
 
 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 the *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:
@@ -36,8 +36,8 @@ 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

content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md

@@ -10,7 +10,7 @@ weight: 7
 When used with the WebUI running in a GKE cluster, the users authorization roles will be automatically synchronized
 based upon their IAM roles in GCP.
 
-If you are not exposing the webui on a load balancer IP address, but are instead using `kubectl port-forward`, you
+If you are not exposing the WebUI on a load balancer IP address, but are instead using `kubectl port-forward`, you
 should use *http*, *localhost* and *7007* for the SCHEME, HOSTNAME and PORT; otherwise, use the scheme, DNS name
 and port as it will be seen by your browser. You can leave the port off if it is 443 for HTTPS or 80 for HTTP.
 
@@ -25,7 +25,7 @@ client ID and secret:
 4. Click **Create Credentials** and choose **OAuth client ID**
 5. Configure an OAuth consent screen, if required
 
-   - For scopes, select *openid*, *auth/userinfo.email*, *auth/userinfo.profile*, and *auth/cloud-platform*.
+   - For scopes, select *OpenID*, *auth/userinfo.email*, *auth/userinfo.profile*, and *auth/cloud-platform*.
    - Add any users that will want access to the UI if using External user type
 
 6. Set **Application Type** to *Web Application* with these settings:
@@ -49,15 +49,15 @@ kubectl create secret generic -n nephio-webui nephio-google-oauth-client --from-
 
 ## Enable Google OAuth
 
-The *webui* package has a function that will configure the package for authentication with different services. Edit the
+The *WebUI* package has a function that will configure the package for authentication with different services. Edit the
 *set-auth.yaml* file to set the authProvider field to *google* or run the following command:
 
 ```bash
 kpt fn eval nephio-webui --image gcr.io/kpt-fn/search-replace:v0.2.0 --match-name set-auth -- 'by-path=authProvider' 'put-value=google'
 ```
 ## Enable OIDC with Google
 
-The *webui* package has a function that will configure the package for authentication with different services. Edit the
+The *WebUI* package has a function that will configure the package for authentication with different services. Edit the
 *set-auth.yaml* file to set the authProvider field to *oidc* and the oidcTokenProvider to *google*, or run the following
 commands:
 

content/en/docs/guides/install-guides/web-ui/webui-auth-okta.md

@@ -60,7 +60,7 @@ kubectl create secret generic -n nephio-webui nephio-okta-oauth-client \
 
 ## Enable the WebUI Auth Provider
 
-The *webui* package has a function that will configure the package for authentication with different services. Edit the
+The *WebUI* package has a function that will configure the package for authentication with different services. Edit the
 *set-auth.yaml* file to set the authProvider field to *oidc* and the oidcTokenProvider to *okta*, or run the following
 commands: