Merging changes from old R3 branch to newly created (#157)

Signed-off-by: Gergely Csatari <[email protected]>
Co-authored-by: Gergely Csatari <[email protected]>

.linkspector.yml

@@ -10,6 +10,7 @@ aliveStatusCodes:
 ignorePatterns:
   - pattern: "^http://localhost.*$"
   - pattern: "^http://HOSTNAME:PORT.*$"
+  - pattern: "https://wiki.lfnetworking.org/.*"
   - pattern: "172\\.18\\.255\\.200"
 replacementPatterns:
   - pattern: ".md#.*$"

config.toml

@@ -1,7 +1,6 @@
-baseURL = 'https://docs.nephio.org/'
+baseURL = 'https://r3.docs.nephio.org/'
 languageCode = 'en-us'
-title = 'Nephio Documentation'
-
+title = 'Nephio R3 Documentation'
 # based on https://www.docsy.dev/docs/get-started/docsy-as-module/start-from-scratch/
 
 # Language settings
@@ -79,12 +78,11 @@ archived_version = false
 # The version number for the version of the docs represented in this doc set.
 # Used in the "version-banner" partial to display a version number for the 
 # current doc set.
-
-version = "main"
+#version = "0.0"
+version = "R3"
 
 # A link to latest version of the docs. Used in the "version-banner" partial to
 # point people to the main doc site.
-
 url_latest_version = "https://docs.nephio.org/docs/"
 
 # Repository configuration (URLs for in-page links to opening issues and suggesting changes)
@@ -207,7 +205,7 @@ enable = false
 	# name = "Developer mailing list"
 	# url = "https://example.org/mail"
 	# icon = "fa fa-envelope"
-        # desc = "Discuss development issues around the project"
+  # desc = "Discuss development issues around the project"
 
 # Add your release versions here
 
@@ -225,4 +223,4 @@ enable = false
 
   [[params.versions]]
   version = "R1"
-  url = "https://github.com/nephio-project/docs/tree/R1"
+  url = "https://github.com/nephio-project/docs/tree/R1"

content/en/_index.md

@@ -3,7 +3,7 @@ title: Start
 description: Documentation of the Nephio project
 menu: {main: {weight: 10}}
 ---
-{{< blocks/cover title="Welcome to the Nephio documentation" image_anchor="top" height="full" >}}
+{{< blocks/cover title="Welcome to Release 3 of Nephio" image_anchor="top" height="full" >}}
 <a class="btn btn-lg btn-primary me-3 mb-4" href="https://nephio.org/">
   Homepage <i class="fas fa-arrow-alt-circle-right ms-2"></i>
 </a>
@@ -28,8 +28,7 @@ and network functions across large scale edge deployments."
 {{% blocks/section type="row" %}}
 
 {{% blocks/feature icon="fas fa-rocket" title="R3" %}}
-Welcome to the Release 3 of Nephio. This release is under ongoing development together with its documentation. It is
-possible to experience some incompleteness ;)
+Welcome to the Release 3 (R3) of Nephio. Please use the documentation links below to learn more about Nephio R3.
 {{% /blocks/feature %}}
 
 {{% blocks/feature icon="fab fa-wikipedia-w" title="Wiki" %}}

content/en/docs/glossary.md

@@ -34,7 +34,7 @@ is part of the "Kubernetes Everywhere" principle).
 As a community, we should try to use a common set of terminology for different types of configuration. See
 [docs#4](https://github.com/nephio-project/nephio/issues/266).
 
-## Configuration as Data
+# Configuration as Data
 Configuration as Data is an approach to management of configuration (incl. configuration of infrastructure, policy,
 services, applications, etc.) which:
 
@@ -44,8 +44,8 @@ services, applications, etc.) which:
 * abstracts configuration file structure and storage from operations that act upon the configuration data; clients
   manipulating configuration data don’t need to directly interact with storage (git, container images)
 
-Source of definition and more information about Configuration as Data can be found in the [kpt documentation](/content/en/docs/porch/config-as-data.md).
-
+Source of definition and more information about Configuration as Data can be found in the
+[kpt documentation](/content/en/docs/porch/config-as-data.md).
 ## Controller
 This term comes from Kubernetes where
 [controller](https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-controller) is defined as a control
@@ -298,6 +298,7 @@ although we also use it to refer to the external representation of that object
 Also see [REST](https://en.wikipedia.org/wiki/Representational_state_transfer).
 
 ## Specializer
+
 This refers to a software component that runs in the Nephio Management cluster,
 and could be considered a type of [controller](#controller). However, it
 specifically watches for `PackageRevision` resources in a Draft state, and

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

@@ -5,9 +5,22 @@ description: >
 weight: 1
 ---
 
-{{% pageinfo %}}
-This page is draft and the separation of the content to different categories is not clearly done. 
-{{% /pageinfo %}}
+# Demonstration Environment Installation
+
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Installing on GCE](#installing-on-gce)
+  - [GCE Prerequisites](#gce-prerequisites)
+  - [Create a Virtual Machine on GCE](#create-a-virtual-machine-on-gce)
+  - [Follow installation on GCE](#follow-the-installation-on-gce)
+- [Installing on a pre-provisioned VM](#installing-on-a-pre-provisioned-vm)
+  - [VM Prerequisites](#vm-prerequisites)
+  - [Kick off the installation on VM](#kick-off-an-installation-on-vm)
+  - [Follow installation on VM](#follow-the-installation-on-vm)
+- [Access to the User Interfaces](#access-to-the-user-interfaces)
+- [Open terminal](#open-terminal)
+- [Next Steps](#next-steps)
 
 ## Introduction
 

content/en/docs/guides/install-guides/package-transformations.md

@@ -5,7 +5,20 @@ description: >
 weight: 7
 ---
 
-## Vanilla kpt for the Management cluster
+# Table of Contents
+
+- [Vanilla kpt for the Management cluster](#vanilla-kpt-for-the-management-cluster)
+  - [kpt pkg get](#kpt-pkg-get)
+  - [kpt fn render](#kpt-fn-render)
+  - [kpt live init](#kpt-live-init)
+- [porchctl rpkg for the Workload clusters](#porchctl-rpkg-for-workload-clusters)
+  - [Create workload cluster package](#create-the-workload-cluster-package)
+  - [Configure the package](#configure-the-package)
+  - [Propose the package](#propose-the-package)
+  - [Approve the package and trigger configsync](#approve-the-package-and-trigger-configsync)
+- [Transformations in the Workload cluster creation](#transformations-in-the-workload-cluster-creation)
+
+# Vanilla kpt for the Management cluster
 
 Before reading this, please read [the kpt book](https://kpt.dev/book/).
 

content/en/docs/guides/user-guides/exercise-1-free5gc.md

@@ -5,6 +5,19 @@ description: >
 weight: 2
 ---
 
+## Table of Contents
+
+- [Introduction](#introduction)
+- [Create the Regional cluster](#step-1-create-the-regional-cluster)
+- [Check the Regional cluster installation](#step-2-check-the-regional-cluster-installation)
+- [Deploy two Edge clusters](#step-3-deploy-two-edge-clusters)
+- [Deploy free5GC control plane functions](#step-4-deploy-free5gc-control-plane-functions)
+- [Deploy free5GC Operator in the Workload clusters](#step-5-deploy-free5gc-operator-in-the-workload-clusters)
+- [Check free5GC Operator deployment](#step-6-check-free5gc-operator-deployment)
+- [Deploy AMF, SMF and UPF](#step-7-deploy-the-amf-smf-and-upf-nfs)
+- [Deploy UERANSIM](#step-8-deploy-ueransim)
+- [Change the Capacities of the UPF and SMF NFs](#step-9-change-the-capacities-of-the-upf-and-smf-nfs)
+
 ## Introduction
 
 Be sure you have followed the [installation guide](/content/en/docs/guides/install-guides/_index.md)
@@ -595,7 +608,7 @@ kubectl apply -f test-infra/e2e/tests/free5gc/006-regional-free5gc-amf.yaml
 kubectl apply -f test-infra/e2e/tests/free5gc/006-regional-free5gc-smf.yaml
 ```
 
-Free5gc requires that the SMF and AMF NFs be explicitly configured with information about each UPF. Therefore, the AMF
+Free5GC requires that the SMF and AMF NFs be explicitly configured with information about each UPF. Therefore, the AMF
 and SMF packages will remain in an "unready" state until the UPF packages have all been published.
 
 ### Check UPF deployment