Helm to codegen

.linkspector.yml

@@ -10,4 +10,6 @@ aliveStatusCodes:
 ignorePatterns:
   - pattern: "^http://localhost.*$"
   - pattern: "^http://HOSTNAME:PORT.*$"
-
+replacementPatterns:
+  - pattern: ".md#.*$"
+    replacement: ".md"

.wordlist.txt

@@ -1,3 +1,4 @@
+aab
 AAC
 abcdef
 acat
@@ -9,6 +10,7 @@ ackage
 acm
 addons
 Addr
+ade
 adecc
 adetalhouet
 adf
@@ -46,11 +48,13 @@ backends
 bae
 balancer
 bazelbuild
+bbae
 bbd
 bbf
 bcbd
 bcdfbf
 bce
+bcfa
 bd
 bdb
 bdd
@@ -61,9 +65,11 @@ bedc
 benchmarking
 bfb
 bfd
+bfdddbbf
 bfe
 bffe
 BFVa
+blockquote
 bmc
 bool
 bootstrappackages
@@ -89,6 +95,7 @@ ccd
 cdd
 cea
 cecf
+cee
 cfb
 cfcfdcf
 Cfg
@@ -194,6 +201,7 @@ ead
 eadd
 ealenn
 eb
+ebeeffd
 eca
 ecc
 ecd
@@ -243,6 +251,7 @@ fcf
 fdb
 fdec
 fdf
+fecd
 ffa
 ffc
 ffcd
@@ -397,6 +406,8 @@ lfnetworking
 LIBDIR
 Libvirt
 lifecycle
+linkinspector
+linkspector
 linkThroughput
 linkTitle
 linuxfoundation
@@ -470,6 +481,8 @@ networkconfigs
 networkFeatureSupport
 networkinstances
 networkName
+nfdeploy
+NFDeploy
 NFDeploymentStatus
 nfm
 nfpb
@@ -528,6 +541,7 @@ otel
 PackageDeployment
 packageExpr
 packageNames
+packagerev
 PackageRevision
 PackageRevisionResources
 PackageRevisions
@@ -538,6 +552,7 @@ packagevariantset
 PackageVariantSets
 pageinfo
 parameterization
+parameterRef
 params
 passwordless
 paymentservice
@@ -551,11 +566,13 @@ PLiW
 plmnSupportList
 pluggable
 pluralsight
+pmnmd
 PNG
 pocs
 podIP
 podman
 popd
+porchctl
 postdeploy
 Postgres
 pq
@@ -586,6 +603,7 @@ ReadWriteOnce
 REcb
 recommendationservice
 reconciler
+reconcilerinterface
 reconcilers
 reconfigures
 redfish
@@ -695,6 +713,7 @@ UI
 UID
 uint
 UIs
+umbrelladocs
 undeploy
 Undeploys
 updateStrategy
@@ -749,6 +768,7 @@ wq
 wr
 wts
 wttp
+wtzlx
 wzmz
 xargs
 xc

README.md

@@ -11,32 +11,29 @@ site. The content of this repo (especially this) branch will be a bit chaotic du
 
 ### Setting up the environment
 
-1 The site is using Hugo as the documentation generating engine, therefore you need to install Hugo. As the Docsy
+1. The site is using Hugo as the documentation generating engine, therefore you need to install Hugo. As the Docsy
   template that we use requires transforming Sass to CSS, you will need to install the *extended* version of Hugo.
   Link to installation instructions is [here](https://gohugo.io/installation/linux/). To ensure that you have the
   *extended* version of Hugo, run `hugo version`. The version string should have the word extended in it (Or `hugo
   version | grep extended` should not be an empty line).
-2 Some functions of the theme generation are using NPM packages, therefore NodeJS and NPM will be needed. For
+2. Some functions of the theme generation are using NPM packages, therefore NodeJS and NPM will be needed. For
   compatibility reasons a Node version of at least v16.20.2 is needed. To install this version of NodeJS, follow the
   instructions from [deb.nodesource.com](http://deb.nodesource.com/) and set the `NODE_MAJOR=20`.
-3 Install the npm dependencies with `npm install`
+3. Install the npm dependencies with `npm install`
 
 ### Build the docs locally
 
 To build and see the documentation locally run `hugo serve`. To double-check if the site will build on Netifly run `hugo
 --gc --minify`.
 
 
-# Nephio R1
+# Nephio
 
-Welcome to the R1 release of Nephio. Please use the documentation links below to
-learn more about Nephio R1, or checkout our [Learning Nephio with
-R1](https://wiki.nephio.org/display/HOME/Learning+with+Nephio+R1) series, which
-includes a [demo video](https://youtu.be/mFl71sy2Pdc) and short articles about
-different aspects of R1.
+Welcome to Nephio! Please use the documentation links below to
+learn more about Nephio, or check out our [Learning Nephio](https://wiki.nephio.org/display/HOME/Learning+with+Nephio+R1) series. The video series includes a [demo video](https://youtu.be/mFl71sy2Pdc) and short articles about different aspects of Nephio.
 
 ## User Documentation
-* [Release Notes](/content/en/docs/release-notes)
+* [Release Notes for each Nephio release](/content/en/docs/release-notes)
 * [Demo Sandbox Environment Installation](/content/en/docs/guides/install-guides/_index.md)
 * [Quick Start Exercises](/content/en/docs/guides/user-guides/_index.md)
 * [User Guide](/content/en/docs/guides/user-guides/_index.md)
@@ -47,7 +44,7 @@ different aspects of R1.
 * [Developer Guide](/content/en/docs/guides/contributor-guides/_index.md)
 * [Project Resources](https://github.com/nephio-project/docs/blob/main/resources.md)
 
-## About Nephio R1
+## About Nephio
 
 Our mission is "to deliver carrier-grade, simple, open, Kubernetes-based cloud
 native intent automation and common automation templates that materially
@@ -122,16 +119,16 @@ This challenge is currently left to ad hoc processes that differ across
 organizations. Nephio is working on how to structure the intent to make it
 manageable using data management techniques.
 
-This release of Nephio focuses:
+The releases of Nephio to date focus on:
 - Demonstrating the core Nephio principles such as Configuration-as-Data and
   leveraging the intent-driven, active-reconciliation nature of Kubernetes.
 - Infrastructure orchestration/automation using controllers based on
   the Cluster API. At this time only KIND cluster creation is supported.
 - Orchestration/automation of 5G core network functions deployment and
   management. This release focuses on network functions from
-  [free5gc](https://free5gc.org/).
+  [free5gc](https://free5gc.org/) and [OAI](https://openairinterface.org/).
 
-While the current release uses Cluster API, KIND, and free5gc for demonstration
+While the releases to date use Cluster API, KIND, free5gc and OAI for demonstration
 purposes, the exact same principles and even code can be used for managing other
 infrastructure and network functions. The *uniformity in systems* principle
 means that as long as something is manageable via the Kubernetes Resource Model,

content/en/docs/_index.md

@@ -5,7 +5,7 @@ menu: {main: {weight: 20}}
 weight: 1
 ---
 
-# About Nephio R1
+# About Nephio
 
 Our mission is "to deliver carrier-grade, simple, open, Kubernetes-based cloud
 native intent automation and common automation templates that materially
@@ -85,11 +85,10 @@ This release of Nephio focuses:
   leveraging the intent-driven, active-reconciliation nature of Kubernetes.
 - Infrastructure orchestration/automation using controllers based on
   the Cluster API. At this time only KIND cluster creation is supported.
-- Orchestration/automation of 5G core network functions deployment and
-  management. This release focuses on network functions from
-  [free5gc](https://free5gc.org/).
+- Orchestration/automation of 5G Core and RAN network functions deployment and
+  management. 
 
-While the current release uses Cluster API, KIND, and free5gc for demonstration
+While the current releases uses Cluster API, KIND, and free5gc/OAI for demonstration
 purposes, the exact same principles and even code can be used for managing other
 infrastructure and network functions. The *uniformity in systems* principle
 means that as long as something is manageable via the Kubernetes Resource Model,

content/en/docs/abbreviations.md

@@ -5,16 +5,20 @@ weight: 3
 ---
 
 This page gives brief explanations of abbreviations used in the Nephio project. See also the
-[Nephio Glossary]({{< ref "glossary.md" >}}) for more detailed descriptions of Nephio related terms.
+[Nephio Glossary](/content/en/docs/glossary.md) for more detailed descriptions of Nephio related terms.
 
-## Nephio related abbreviations
+## Nephio Related Abbreviations
 * NF: Network Function
 * PV: Package Variant
 * PVS: Package Variant Set
 
-## free5gc related abbreviations
+## 5G 3GPP Related Abbreviations
 * AMF: Access and Mobility Management Function
-* DNN: Data Network Name
-* NAD: Network Attachment Definition
 * SMF: Session Management Function
 * UPF: User Plane Function
+* AUSF: Authentication Server Function
+* NRF: Network Repository Function
+* UDR: Unified Data Repository
+* UDM: Unified Data Management
+* DNN: Data Network Name
+* NAD: Network Attachment Definition

content/en/docs/apis.md

@@ -0,0 +1,8 @@
+---
+title: "API Specifications"
+type: docs
+weight: 5
+description: Reference for the Nephio APIs
+---
+
+{{< iframe src="https://doc.crds.dev/github.com/nephio-project/[email protected]" sub="https://doc.crds.dev/github.com/nephio-project/[email protected]">}}

content/en/docs/guides/contributor-guides/_index.md

@@ -7,9 +7,5 @@ weight: 3
 
 # Developer guide
 
-This developer guide is for for people who want to write code for the Nephio project. This document is written as an
-extension of the [Kubernetes Developer Guides](https://github.com/kubernetes/community/tree/master/contributors/devel#the-process-of-developing-and-contributing-code-to-the-kubernetes-project)
-and therefore covers topics that are specific to Nephio development.
-
-* How to set up a [Minimal Development Environment]({{< relref "minimal-environment.md" >}}) defines common terminology
-  used in the Nephio project.
+This developer guide is for people who want to write code for the Nephio project. This document is written as an extension of the [Kubernetes Developer Guides](https://github.com/kubernetes/community/tree/master/contributors/devel#the-process-of-developing-and-contributing-code-to-the-kubernetes-project)
+and therefore covers topics specific to Nephio development that are not already covered there.

content/en/docs/guides/contributor-guides/doc-faq.md

@@ -0,0 +1,16 @@
+---
+title: Nephio Documentation System FAQ
+description: >
+  Frequently Asked Questions on the Nephio Documentation system
+weight: 5
+---
+
+#   Frequently Asked Questions on the Nephio Documentation system
+
+1. How do I check the documentation links on the documentation before I check in my changes?
+
+    Install and run *linkspector*
+    ```
+    npm install -g @umbrelladocs/linkspector
+    linkinspector check -c .linkspector.yml
+    ```