From 706bc1c74566f0765164c81157e9a45ee0bc6123 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 11:56:28 +0000 Subject: [PATCH 01/29] Test contributor Guide --- content/en/docs/guides/contributor-guides/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/contributor-guides/_index.md b/content/en/docs/guides/contributor-guides/_index.md index 934acd7e..aba8d6bd 100644 --- a/content/en/docs/guides/contributor-guides/_index.md +++ b/content/en/docs/guides/contributor-guides/_index.md @@ -11,5 +11,5 @@ This developer guide is for for people who want to write code for the Nephio pro 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 +* How to set up a [Minimal Development Environment](minimal-environment.md) defines common terminology used in the Nephio project. \ No newline at end of file From 00a6ba283fd3145c5dcdd028dacef5fe3a884953 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:13:16 +0000 Subject: [PATCH 02/29] Converted references to md format --- content/en/docs/abbreviations.md | 2 +- content/en/docs/guides/install-guides/_index.md | 8 ++++---- .../guides/install-guides/explore-nephio-free5gc.md | 6 +++--- .../en/docs/guides/install-guides/explore-sandbox.md | 2 +- .../en/docs/guides/install-guides/install-on-byoc.md | 10 +++++----- .../en/docs/guides/install-guides/install-on-gce.md | 8 ++++---- .../en/docs/guides/install-guides/install-on-gcp.md | 10 +++++----- .../docs/guides/install-guides/install-on-openshift.md | 2 +- .../docs/guides/install-guides/install-on-single-vm.md | 4 ++-- content/en/docs/guides/install-guides/webui.md | 4 ++-- content/en/docs/guides/user-guides/_index.md | 8 ++++---- .../en/docs/guides/user-guides/exercise-1-free5gc.md | 4 ++-- content/en/docs/guides/user-guides/exercise-2-oai.md | 2 +- content/en/docs/guides/user-guides/helm/_index.md | 2 +- content/en/docs/guides/user-guides/helm/flux-helm.md | 8 ++++---- content/en/docs/release-notes/R1.md | 2 +- content/en/docs/release-notes/R2.md | 2 +- 17 files changed, 42 insertions(+), 42 deletions(-) diff --git a/content/en/docs/abbreviations.md b/content/en/docs/abbreviations.md index 7c09eb0b..2ad80694 100644 --- a/content/en/docs/abbreviations.md +++ b/content/en/docs/abbreviations.md @@ -5,7 +5,7 @@ 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](glossary.md) for more detailed descriptions of Nephio related terms. ## Nephio related abbreviations * NF: Network Function diff --git a/content/en/docs/guides/install-guides/_index.md b/content/en/docs/guides/install-guides/_index.md index 82a9e99f..a733c689 100644 --- a/content/en/docs/guides/install-guides/_index.md +++ b/content/en/docs/guides/install-guides/_index.md @@ -173,7 +173,7 @@ ssh @ ## Next Steps -* Step through the [Free5GC]({{< relref "exercise-1-free5gc.md" >}}) and [OAI]({{< relref "exercise-2-oai.md" >}}) exercises -* Learn more about the [Nephio demo sandbox]({{< relref "explore-sandbox.md" >}}) -* Dig into the [user guide]({{< ref "user-guides#nephio-r1-user-guide" >}}) -* Create a [Bring-Your-Own-Cluster]({{< relref "install-on-byoc.md" >}}) Nephio Installation +* Step through the [Free5GC](exercise-1-free5gc.md) and [OAI](exercise-2-oai.md) exercises +* Learn more about the [Nephio demo sandbox](explore-sandbox.md) +* Dig into the [user guide](user-guides#nephio-r1-user-guide) +* Create a [Bring-Your-Own-Cluster](install-on-byoc.md) Nephio Installation diff --git a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md index 7eb46ac7..7c0c5c01 100644 --- a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md +++ b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md @@ -5,9 +5,9 @@ description: > weight: 6 --- -Concepts as [Operator]({{< ref "/docs/glossary.md#operator" >}}) and -[Controller]({{< ref "/docs/glossary.md#controller" >}}) and -[CR]({{< ref "/docs/glossary.md#custom-resource" >}}) have already been explained here. +Concepts as [Operator](/docs/glossary.md#operator) and +[Controller](/docs/glossary.md#controller) and +[CR](/docs/glossary.md#custom-resource) have already been explained here. # Deploy the operator to the cluster diff --git a/content/en/docs/guides/install-guides/explore-sandbox.md b/content/en/docs/guides/install-guides/explore-sandbox.md index 49560638..969efb9b 100644 --- a/content/en/docs/guides/install-guides/explore-sandbox.md +++ b/content/en/docs/guides/install-guides/explore-sandbox.md @@ -6,7 +6,7 @@ weight: 5 --- -You have installed the Nephio single VM [using the installation instructions]({{< relref "install-on-single-vm.md" >}}). +You have installed the Nephio single VM [using the installation instructions](install-on-single-vm.md). The installation has done a good job of installing a complex software stack without any fuss. Let's take a look around. ![Software Installed by the Nephio Sandbox Installation](/images/install-guides/ManagementCluster.png) diff --git a/content/en/docs/guides/install-guides/install-on-byoc.md b/content/en/docs/guides/install-guides/install-on-byoc.md index 1ded8b94..b0a99653 100644 --- a/content/en/docs/guides/install-guides/install-on-byoc.md +++ b/content/en/docs/guides/install-guides/install-on-byoc.md @@ -67,9 +67,9 @@ options, if you wish to assemble your own set of components. | Environment | Description | | ----------- | ---------------------------------------------------------- | -| [Single VM]({{< relref "install-on-single-vm.md" >}}) | The single VM demo environment, set up "the hard way" - without using the included provisioning script. This creates a complete Nephio-in-a-VM, just like the R1 demo environment. These instructions cover both Ubuntu and Fedora. | -| [Google Cloud Platform]({{< relref "install-on-gcp.md" >}}) | Nephio running in GCP. A GKE cluster is used as the management cluster, with Anthos Config Controller for GCP infrastructure provisioning, Gitea as the Git provider, and Web UI authentication and authorization via Google OAuth 2.0 | -| [OpenShift]({{< relref "install-on-openshift.md" >}}) | Nephio running in OpenShift, with Cluster API as the cluster provisioner, Gitea as the Git provider and Web UI authentication backed by Open Shift OIDC. | +| [Single VM](install-on-single-vm.md) | The single VM demo environment, set up "the hard way" - without using the included provisioning script. This creates a complete Nephio-in-a-VM, just like the R1 demo environment. These instructions cover both Ubuntu and Fedora. | +| [Google Cloud Platform](install-on-gcp.md) | Nephio running in GCP. A GKE cluster is used as the management cluster, with Anthos Config Controller for GCP infrastructure provisioning, Gitea as the Git provider, and Web UI authentication and authorization via Google OAuth 2.0 | +| [OpenShift](install-on-openshift.md) | Nephio running in OpenShift, with Cluster API as the cluster provisioner, Gitea as the Git provider and Web UI authentication backed by Open Shift OIDC. | ## A La Carte Installation @@ -146,8 +146,8 @@ development it must not be exposed on the internet (for example, via a LoadBalancer service, Ingress, or Route). The WebUI currently supports the following options: -- [Google OAuth or OIDC]({{< relref "webui-auth-gcp.md" >}}) -- [OIDC with Okta]({{< relref "webui-auth-okta.md" >}}) +- [Google OAuth or OIDC](webui-auth-gcp.md) +- [OIDC with Okta](webui-auth-okta.md) ### Nephio Stock Repositories diff --git a/content/en/docs/guides/install-guides/install-on-gce.md b/content/en/docs/guides/install-guides/install-on-gce.md index e4055e94..3e46018d 100644 --- a/content/en/docs/guides/install-guides/install-on-gce.md +++ b/content/en/docs/guides/install-guides/install-on-gce.md @@ -174,7 +174,7 @@ ssh @ ## Next Steps * Step through the exercises - * [Free5GC Testbed Deployment and E2E testing with UERANSIM]({{< relref "/docs/guides/user-guides/exercise-1-free5gc.md" >}}) - * [OAI Core and RAN Testbed Deployment and E2E testing]({{< relref "/docs/guides/user-guides/exercise-2-oai.md" >}}) -* Learn more about the [Nephio demo sandbox]({{< relref "explore-sandbox.md" >}}) -* Dig into the [user guide]({{< relref "/docs/guides/user-guides/_index.md" >}}) + * [Free5GC Testbed Deployment and E2E testing with UERANSIM](/docs/guides/user-guides/exercise-1-free5gc.md) + * [OAI Core and RAN Testbed Deployment and E2E testing](/docs/guides/user-guides/exercise-2-oai.md) +* Learn more about the [Nephio demo sandbox](explore-sandbox.md) +* Dig into the [user guide](/docs/guides/user-guides/_index.md) diff --git a/content/en/docs/guides/install-guides/install-on-gcp.md b/content/en/docs/guides/install-guides/install-on-gcp.md index 06f77cb8..92260b90 100644 --- a/content/en/docs/guides/install-guides/install-on-gcp.md +++ b/content/en/docs/guides/install-guides/install-on-gcp.md @@ -1022,9 +1022,9 @@ git commit -m "Initial checking of nephio-mgmt" **Prior to deploying the package, we need to manually setup the secret for the WebUI.** -See [Google OAuth 2.0 or OIDC]({{< relref "webui-auth-gcp.md" >}}) for details on how to -set up OAuth. In particular you need to [create the client ID]({{< relref "webui-auth-gcp.md#creating-an-oauth-20-client-id" >}}) -and the [secret]({{< relref "webui-auth-gcp.md#create-the-secret-in-the-cluster" >}}) +See [Google OAuth 2.0 or OIDC](webui-auth-gcp.md) for details on how to +set up OAuth. In particular you need to [create the client ID](webui-auth-gcp.md#creating-an-oauth-20-client-id) +and the [secret](webui-auth-gcp.md#create-the-secret-in-the-cluster) manually. The `nephio-webui` subpackage in `nephio-mgmt` is already set up for @@ -1384,5 +1384,5 @@ Note that the exercises using free5gc rely on Multus and on the gtp5g kernel mod GKE nodes. Therefore, the free5gc workloads cannot be run on this installation. You will need to alter the exercises to\ use workloads that do not rely on that functionality in order to experiment with Nephio features. -* Step through the [Free5GC]({{< relref "exercise-1-free5gc.md" >}}) and [OAI]({{< relref "exercise-2-oai.md" >}}) exercises -* Dig into the [user guide]({{< relref "/docs/guides/user-guides/_index.md" >}}) +* Step through the [Free5GC](exercise-1-free5gc.md) and [OAI](exercise-2-oai.md) exercises +* Dig into the [user guide](/docs/guides/user-guides/_index.md) diff --git a/content/en/docs/guides/install-guides/install-on-openshift.md b/content/en/docs/guides/install-guides/install-on-openshift.md index e982ee82..06216f83 100644 --- a/content/en/docs/guides/install-guides/install-on-openshift.md +++ b/content/en/docs/guides/install-guides/install-on-openshift.md @@ -70,7 +70,7 @@ Application: oc apply -f https://raw.githubusercontent.com/openshift-telco/blueprints-nephio-openshift/v1.0.1/nephio-mgnt/app-of-apps.yaml ``` -This will take care of applying the [common dependencies]({{< relref "common-dependencies.md" >}}) and the [common components]({{< relref "common-components.md" >}}) +This will take care of applying the [common dependencies](common-dependencies.md) and the [common components](common-components.md) ### Access the Nephio diff --git a/content/en/docs/guides/install-guides/install-on-single-vm.md b/content/en/docs/guides/install-guides/install-on-single-vm.md index 3be4e444..0ba66184 100644 --- a/content/en/docs/guides/install-guides/install-on-single-vm.md +++ b/content/en/docs/guides/install-guides/install-on-single-vm.md @@ -65,12 +65,12 @@ kpt live apply gitea --reconcile-timeout 15m --output=table There are a few dependencies that are common across most installations, and do not require any installation-specific setup. You should install these next, as described in the -[common dependencies documentation]({{< relref "common-dependencies.md" >}}). +[common dependencies documentation](common-dependencies.md). ## Common Components With the necessary dependencies now installed, you can now install the essential Nephio components. This is documented -in the [common components documentation]({{< relref "common-components.md" >}}). +in the [common components documentation](common-components.md). ## Provisioning Cluster API diff --git a/content/en/docs/guides/install-guides/webui.md b/content/en/docs/guides/install-guides/webui.md index 61e05e2e..9d73c56b 100644 --- a/content/en/docs/guides/install-guides/webui.md +++ b/content/en/docs/guides/install-guides/webui.md @@ -54,8 +54,8 @@ service). Configuring authentication for the WebUI is very specific to the particular cluster environment. Guides for different environments are below: -- [Google OAuth or OIDC]({{< relref "/webui-auth-gcp.md" >}}) -- [OIDC with Okta]({{< relref "/webui-auth-okta.md" >}}) +- [Google OAuth or OIDC](/webui-auth-gcp.md) +- [OIDC with Okta](/webui-auth-okta.md) Once that configuration is updated, you can proceed with the installation (note, this uses `inventory-policy=adopt`, since in the previous steps we may have created the namespace already). diff --git a/content/en/docs/guides/user-guides/_index.md b/content/en/docs/guides/user-guides/_index.md index e0717a3b..f2b5a69b 100644 --- a/content/en/docs/guides/user-guides/_index.md +++ b/content/en/docs/guides/user-guides/_index.md @@ -330,10 +330,10 @@ The diagram below depicts deployment at the high level. On the demo VM, the `test-infra/e2e/provision/hacks` directory contains some workaround scripts. Also, please see the Release Notes -[known issues]({{< relref "../../release-notes/r1#known-issues-and-workarounds">}}). +[known issues](../../release-notes/r1#known-issues-and-workarounds"). ## Next Steps -* Learn more about the Nephio [controllers]({{< relref "controllers.md" >}}) -* Learn more about how packages are [transformed]({{< relref "../install-guides/package-transformations.md" >}}) -* Learn more about [deploying helm charts]({{< relref "../user-guides/helm/#helm-integration-in-nephio" >}}) in Nephio +* Learn more about the Nephio [controllers](controllers.md) +* Learn more about how packages are [transformed](../install-guides/package-transformations.md) +* Learn more about [deploying helm charts](../user-guides/helm/#helm-integration-in-nephio) in Nephio diff --git a/content/en/docs/guides/user-guides/exercise-1-free5gc.md b/content/en/docs/guides/user-guides/exercise-1-free5gc.md index dd21fec1..738e64ab 100644 --- a/content/en/docs/guides/user-guides/exercise-1-free5gc.md +++ b/content/en/docs/guides/user-guides/exercise-1-free5gc.md @@ -20,7 +20,7 @@ weight: 2 ## Introduction -Be sure you have followed the [installation guide]({{< ref "docs/guides/install-guides ">}}) +Be sure you have followed the [installation guide](docs/guides/install-guides ") before trying these exercises. These exercises will take you from a system with only the Nephio Management cluster setup to a deployment with: @@ -995,7 +995,7 @@ commits to see how Porch interacts with packages stored in Git repositories. ![Commits in Gitea made by porch](/images/user-guides/gitea-porch.png) After the package is approved, the results can be observed in Nephio Web UI. Head over to http://localhost:7007/config-as-data -([port forwarding]({{< ref "docs/guides/install-guides/#access-to-the-user-interfaces" >}}) must be running). +([port forwarding](docs/guides/install-guides/#access-to-the-user-interfaces) must be running). ![Deployments in Nephio UI](/images/user-guides/UPF-Capacity.png) diff --git a/content/en/docs/guides/user-guides/exercise-2-oai.md b/content/en/docs/guides/user-guides/exercise-2-oai.md index 25920c8f..95932aa4 100644 --- a/content/en/docs/guides/user-guides/exercise-2-oai.md +++ b/content/en/docs/guides/user-guides/exercise-2-oai.md @@ -19,7 +19,7 @@ weight: 2 ## Introduction -Be sure you have followed the [installation guide]({{< ref "docs/guides/install-guides ">}}) +Be sure you have followed the [installation guide](docs/guides/install-guides ") before trying these exercises. These exercises will take you from a system with only the Nephio Management cluster setup to a deployment with: diff --git a/content/en/docs/guides/user-guides/helm/_index.md b/content/en/docs/guides/user-guides/helm/_index.md index 039942f7..15b3fc1c 100644 --- a/content/en/docs/guides/user-guides/helm/_index.md +++ b/content/en/docs/guides/user-guides/helm/_index.md @@ -16,6 +16,6 @@ for deploying on Kubernetes, legacy helm support will be required for a number o ### Deployment options -* [Using Flux CD]({{< ref "flux-helm.md" >}}) +* [Using Flux CD](flux-helm.md) * [Operator SDK](https://sdk.operatorframework.io/docs/building-operators/helm/) diff --git a/content/en/docs/guides/user-guides/helm/flux-helm.md b/content/en/docs/guides/user-guides/helm/flux-helm.md index f116f64c..96677a14 100644 --- a/content/en/docs/guides/user-guides/helm/flux-helm.md +++ b/content/en/docs/guides/user-guides/helm/flux-helm.md @@ -16,11 +16,11 @@ Then, we can utilize the flux Custom Resources defined in another test kpt packa ## Prerequisites: -* [Nephio R1 sandbox]({{< ref "/docs/guides/install-guides/" >}}): Set up the Nephio sandbox environment. -* [Access to the Nephio Web UI]({{< ref "/docs/guides/install-guides/#access-to-the-user-interfaces" >}}) -* [Nephio R1 sandbox workload clusters]({{< ref "/docs/guides/user-guides/exercise-1-free5gc.md" >}}): +* [Nephio R1 sandbox](/docs/guides/install-guides/): Set up the Nephio sandbox environment. +* [Access to the Nephio Web UI](/docs/guides/install-guides/#access-to-the-user-interfaces) +* [Nephio R1 sandbox workload clusters](/docs/guides/user-guides/exercise-1-free5gc.md): Create/Deploy the predefined set of workload clusters by completing the Free5GC Core quick start exercises up to and including - [Step 3]({{< ref "/docs/guides/user-guides/exercise-1-free5gc.md#step-3-deploy-two-edge-clusters" >}}). + [Step 3](/docs/guides/user-guides/exercise-1-free5gc.md#step-3-deploy-two-edge-clusters). ### Deploying the flux-helm-controllers pkg diff --git a/content/en/docs/release-notes/R1.md b/content/en/docs/release-notes/R1.md index 6d90d302..4030170d 100644 --- a/content/en/docs/release-notes/R1.md +++ b/content/en/docs/release-notes/R1.md @@ -7,7 +7,7 @@ weight: 1 ## Prerequisites -Please refer to the [Install Guide]({{< ref "/docs/guides/install-guides" >}}) +Please refer to the [Install Guide](/docs/guides/install-guides) for the prerequisites on supported environments. ## Support Matrix diff --git a/content/en/docs/release-notes/R2.md b/content/en/docs/release-notes/R2.md index 61550c9c..6c727c83 100644 --- a/content/en/docs/release-notes/R2.md +++ b/content/en/docs/release-notes/R2.md @@ -7,7 +7,7 @@ weight: 1 ## Prerequisites -Please refer to the [Install Guide]({{< ref "docs/guides/install-guides/install-on-byoc.md#prerequisites" >}}) +Please refer to the [Install Guide](docs/guides/install-guides/install-on-byoc.md#prerequisites) for the prerequisites on supported environments. ## Support Matrix From 0ff83b97dfe97fc5066b55e8d86eee391a357392 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:18:41 +0000 Subject: [PATCH 03/29] Converted references to md format --- content/en/docs/guides/install-guides/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/guides/install-guides/_index.md b/content/en/docs/guides/install-guides/_index.md index a733c689..9b7798ec 100644 --- a/content/en/docs/guides/install-guides/_index.md +++ b/content/en/docs/guides/install-guides/_index.md @@ -173,7 +173,7 @@ ssh @ ## Next Steps -* Step through the [Free5GC](exercise-1-free5gc.md) and [OAI](exercise-2-oai.md) exercises +* Step through the [Free5GC](../user-guides/exercise-1-free5gc.md) and [OAI](../user-guides/exercise-2-oai.md) exercises * Learn more about the [Nephio demo sandbox](explore-sandbox.md) -* Dig into the [user guide](user-guides#nephio-r1-user-guide) +* Dig into the [user guide](../user-guides#nephio-r1-user-guide) * Create a [Bring-Your-Own-Cluster](install-on-byoc.md) Nephio Installation From 7b7fa8441b8ae309358cdf07d00889946dd06e10 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:24:03 +0000 Subject: [PATCH 04/29] Converted references to md format --- .../en/docs/guides/install-guides/explore-nephio-free5gc.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md index 7c0c5c01..afc8c70c 100644 --- a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md +++ b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md @@ -5,9 +5,9 @@ description: > weight: 6 --- -Concepts as [Operator](/docs/glossary.md#operator) and -[Controller](/docs/glossary.md#controller) and -[CR](/docs/glossary.md#custom-resource) have already been explained here. +Concepts as [Operator](../../glossary.md#operator) and +[Controller](../../glossary.md#controller) and +[CR](../../glossary.md#custom-resource) have already been explained here. # Deploy the operator to the cluster From c5a0f6828316c1f2306d020b06f2cfc8e9f879c9 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:27:38 +0000 Subject: [PATCH 05/29] Converted references to md format --- content/en/docs/guides/install-guides/install-on-gce.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/en/docs/guides/install-guides/install-on-gce.md b/content/en/docs/guides/install-guides/install-on-gce.md index 3e46018d..b5566ef5 100644 --- a/content/en/docs/guides/install-guides/install-on-gce.md +++ b/content/en/docs/guides/install-guides/install-on-gce.md @@ -174,7 +174,7 @@ ssh @ ## Next Steps * Step through the exercises - * [Free5GC Testbed Deployment and E2E testing with UERANSIM](/docs/guides/user-guides/exercise-1-free5gc.md) - * [OAI Core and RAN Testbed Deployment and E2E testing](/docs/guides/user-guides/exercise-2-oai.md) + * [Free5GC Testbed Deployment and E2E testing with UERANSIM](../user-guides/exercise-1-free5gc.md) + * [OAI Core and RAN Testbed Deployment and E2E testing](../user-guides/exercise-2-oai.md) * Learn more about the [Nephio demo sandbox](explore-sandbox.md) -* Dig into the [user guide](/docs/guides/user-guides/_index.md) +* Dig into the [user guide](../user-guides/_index.md) From a428af0407cee035ccbed214d0f4ac7986d8d4b8 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:29:41 +0000 Subject: [PATCH 06/29] Converted references to md format --- content/en/docs/guides/install-guides/install-on-gcp.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/guides/install-guides/install-on-gcp.md b/content/en/docs/guides/install-guides/install-on-gcp.md index 92260b90..ba4d1583 100644 --- a/content/en/docs/guides/install-guides/install-on-gcp.md +++ b/content/en/docs/guides/install-guides/install-on-gcp.md @@ -1384,5 +1384,5 @@ Note that the exercises using free5gc rely on Multus and on the gtp5g kernel mod GKE nodes. Therefore, the free5gc workloads cannot be run on this installation. You will need to alter the exercises to\ use workloads that do not rely on that functionality in order to experiment with Nephio features. -* Step through the [Free5GC](exercise-1-free5gc.md) and [OAI](exercise-2-oai.md) exercises -* Dig into the [user guide](/docs/guides/user-guides/_index.md) +* Step through the [Free5GC](../user-guides/exercise-1-free5gc.md) and [OAI](../user-guides/exercise-2-oai.md) exercises +* Dig into the [user guide](../user-guides/_index.md) From 65ec2a1f04734c13ccb3b5f455168d742d69673b Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:32:47 +0000 Subject: [PATCH 07/29] Converted references to md format --- content/en/docs/guides/install-guides/webui.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/guides/install-guides/webui.md b/content/en/docs/guides/install-guides/webui.md index 9d73c56b..284aadd4 100644 --- a/content/en/docs/guides/install-guides/webui.md +++ b/content/en/docs/guides/install-guides/webui.md @@ -54,8 +54,8 @@ service). Configuring authentication for the WebUI is very specific to the particular cluster environment. Guides for different environments are below: -- [Google OAuth or OIDC](/webui-auth-gcp.md) -- [OIDC with Okta](/webui-auth-okta.md) +- [Google OAuth or OIDC](webui-auth-gcp.md) +- [OIDC with Okta](webui-auth-okta.md) Once that configuration is updated, you can proceed with the installation (note, this uses `inventory-policy=adopt`, since in the previous steps we may have created the namespace already). From 75dc582afdb10275bfd72bb63b55b606fd19c035 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:34:52 +0000 Subject: [PATCH 08/29] Converted references to md format --- content/en/docs/guides/user-guides/_index.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/guides/user-guides/_index.md b/content/en/docs/guides/user-guides/_index.md index f2b5a69b..a4200f96 100644 --- a/content/en/docs/guides/user-guides/_index.md +++ b/content/en/docs/guides/user-guides/_index.md @@ -330,10 +330,10 @@ The diagram below depicts deployment at the high level. On the demo VM, the `test-infra/e2e/provision/hacks` directory contains some workaround scripts. Also, please see the Release Notes -[known issues](../../release-notes/r1#known-issues-and-workarounds"). +[known issues](../../release-notes/R2.md#known-issues-and-workarounds"). ## Next Steps * Learn more about the Nephio [controllers](controllers.md) * Learn more about how packages are [transformed](../install-guides/package-transformations.md) -* Learn more about [deploying helm charts](../user-guides/helm/#helm-integration-in-nephio) in Nephio +* Learn more about [deploying helm charts](helm/#helm-integration-in-nephio) in Nephio From 5821295dca3cd92cd2928f246ce7b2446a84fce7 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:36:33 +0000 Subject: [PATCH 09/29] Converted references to md format --- content/en/docs/guides/user-guides/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/user-guides/_index.md b/content/en/docs/guides/user-guides/_index.md index a4200f96..4f16216f 100644 --- a/content/en/docs/guides/user-guides/_index.md +++ b/content/en/docs/guides/user-guides/_index.md @@ -336,4 +336,4 @@ workaround scripts. Also, please see the Release Notes * Learn more about the Nephio [controllers](controllers.md) * Learn more about how packages are [transformed](../install-guides/package-transformations.md) -* Learn more about [deploying helm charts](helm/#helm-integration-in-nephio) in Nephio +* Learn more about [deploying helm charts](helm/_index.md_) in Nephio From ad426282ef1fbfc9e901a8bbbaa720cea3417a5a Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:36:57 +0000 Subject: [PATCH 10/29] Converted references to md format --- content/en/docs/guides/user-guides/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/user-guides/_index.md b/content/en/docs/guides/user-guides/_index.md index 4f16216f..f0f7dfc9 100644 --- a/content/en/docs/guides/user-guides/_index.md +++ b/content/en/docs/guides/user-guides/_index.md @@ -330,7 +330,7 @@ The diagram below depicts deployment at the high level. On the demo VM, the `test-infra/e2e/provision/hacks` directory contains some workaround scripts. Also, please see the Release Notes -[known issues](../../release-notes/R2.md#known-issues-and-workarounds"). +[known issues](../../release-notes/R2.md#known-issues-and-workarounds). ## Next Steps From b3fedc4f2260cc94f3bfb1996450c31b1a63a013 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:37:48 +0000 Subject: [PATCH 11/29] Converted references to md format --- content/en/docs/guides/user-guides/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/user-guides/_index.md b/content/en/docs/guides/user-guides/_index.md index f0f7dfc9..5f5e1fd4 100644 --- a/content/en/docs/guides/user-guides/_index.md +++ b/content/en/docs/guides/user-guides/_index.md @@ -336,4 +336,4 @@ workaround scripts. Also, please see the Release Notes * Learn more about the Nephio [controllers](controllers.md) * Learn more about how packages are [transformed](../install-guides/package-transformations.md) -* Learn more about [deploying helm charts](helm/_index.md_) in Nephio +* Learn more about [deploying helm charts](helm/_index.md) in Nephio From 454bb4e1435d79e5df78f4c82377858992111d19 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:39:21 +0000 Subject: [PATCH 12/29] Converted references to md format --- content/en/docs/guides/user-guides/exercise-1-free5gc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/user-guides/exercise-1-free5gc.md b/content/en/docs/guides/user-guides/exercise-1-free5gc.md index 738e64ab..96581a30 100644 --- a/content/en/docs/guides/user-guides/exercise-1-free5gc.md +++ b/content/en/docs/guides/user-guides/exercise-1-free5gc.md @@ -20,7 +20,7 @@ weight: 2 ## Introduction -Be sure you have followed the [installation guide](docs/guides/install-guides ") +Be sure you have followed the [installation guide](../install-guides) before trying these exercises. These exercises will take you from a system with only the Nephio Management cluster setup to a deployment with: From 9700f5f6e4b51061f8068fbac3a006417a93a6bc Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:39:47 +0000 Subject: [PATCH 13/29] Converted references to md format --- content/en/docs/guides/user-guides/exercise-1-free5gc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/user-guides/exercise-1-free5gc.md b/content/en/docs/guides/user-guides/exercise-1-free5gc.md index 96581a30..342607cc 100644 --- a/content/en/docs/guides/user-guides/exercise-1-free5gc.md +++ b/content/en/docs/guides/user-guides/exercise-1-free5gc.md @@ -20,7 +20,7 @@ weight: 2 ## Introduction -Be sure you have followed the [installation guide](../install-guides) +Be sure you have followed the [installation guide](../install-guides/_index.md) before trying these exercises. These exercises will take you from a system with only the Nephio Management cluster setup to a deployment with: From 74cefe95f13e3344f4de97a3d83012be7164c1e1 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:41:04 +0000 Subject: [PATCH 14/29] Converted references to md format --- content/en/docs/guides/user-guides/exercise-1-free5gc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/user-guides/exercise-1-free5gc.md b/content/en/docs/guides/user-guides/exercise-1-free5gc.md index 342607cc..7d2cf386 100644 --- a/content/en/docs/guides/user-guides/exercise-1-free5gc.md +++ b/content/en/docs/guides/user-guides/exercise-1-free5gc.md @@ -995,7 +995,7 @@ commits to see how Porch interacts with packages stored in Git repositories. ![Commits in Gitea made by porch](/images/user-guides/gitea-porch.png) After the package is approved, the results can be observed in Nephio Web UI. Head over to http://localhost:7007/config-as-data -([port forwarding](docs/guides/install-guides/#access-to-the-user-interfaces) must be running). +([port forwarding](../install-guides/#access-to-the-user-interfaces) must be running). ![Deployments in Nephio UI](/images/user-guides/UPF-Capacity.png) From ed9884e5e5acfc867ebce83f4e88886ebd6ed4e6 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:42:02 +0000 Subject: [PATCH 15/29] Converted references to md format --- content/en/docs/guides/user-guides/exercise-1-free5gc.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/user-guides/exercise-1-free5gc.md b/content/en/docs/guides/user-guides/exercise-1-free5gc.md index 7d2cf386..9459fda3 100644 --- a/content/en/docs/guides/user-guides/exercise-1-free5gc.md +++ b/content/en/docs/guides/user-guides/exercise-1-free5gc.md @@ -995,7 +995,7 @@ commits to see how Porch interacts with packages stored in Git repositories. ![Commits in Gitea made by porch](/images/user-guides/gitea-porch.png) After the package is approved, the results can be observed in Nephio Web UI. Head over to http://localhost:7007/config-as-data -([port forwarding](../install-guides/#access-to-the-user-interfaces) must be running). +([port forwarding](../install-guides/_index.md#access-to-the-user-interfaces) must be running). ![Deployments in Nephio UI](/images/user-guides/UPF-Capacity.png) From ab86e38715f3410c8b3f8d0897799deeb4f432ae Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:43:14 +0000 Subject: [PATCH 16/29] Converted references to md format --- content/en/docs/guides/user-guides/exercise-2-oai.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/guides/user-guides/exercise-2-oai.md b/content/en/docs/guides/user-guides/exercise-2-oai.md index 95932aa4..d52e687e 100644 --- a/content/en/docs/guides/user-guides/exercise-2-oai.md +++ b/content/en/docs/guides/user-guides/exercise-2-oai.md @@ -19,7 +19,7 @@ weight: 2 ## Introduction -Be sure you have followed the [installation guide](docs/guides/install-guides ") +Be sure you have followed the [installation guide](../install-guides/_index.md) before trying these exercises. These exercises will take you from a system with only the Nephio Management cluster setup to a deployment with: From 7fadc9224c0c6bf173bfc945add20cb0830a8c66 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:46:21 +0000 Subject: [PATCH 17/29] Converted references to md format --- content/en/docs/guides/user-guides/helm/flux-helm.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/docs/guides/user-guides/helm/flux-helm.md b/content/en/docs/guides/user-guides/helm/flux-helm.md index 96677a14..5a71642e 100644 --- a/content/en/docs/guides/user-guides/helm/flux-helm.md +++ b/content/en/docs/guides/user-guides/helm/flux-helm.md @@ -16,11 +16,11 @@ Then, we can utilize the flux Custom Resources defined in another test kpt packa ## Prerequisites: -* [Nephio R1 sandbox](/docs/guides/install-guides/): Set up the Nephio sandbox environment. -* [Access to the Nephio Web UI](/docs/guides/install-guides/#access-to-the-user-interfaces) -* [Nephio R1 sandbox workload clusters](/docs/guides/user-guides/exercise-1-free5gc.md): +* [Nephio R1 sandbox](../../install-guides/_index.md): Set up the Nephio sandbox environment. +* [Access to the Nephio Web UI](../../install-guides/_index.md#access-to-the-user-interfaces) +* [Nephio R1 sandbox workload clusters](../exercise-1-free5gc.md): Create/Deploy the predefined set of workload clusters by completing the Free5GC Core quick start exercises up to and including - [Step 3](/docs/guides/user-guides/exercise-1-free5gc.md#step-3-deploy-two-edge-clusters). + [Step 3](../exercise-1-free5gc.md#step-3-deploy-two-edge-clusters). ### Deploying the flux-helm-controllers pkg From 1b0dabc74120e7ab401b091bc9c990ddf5b02714 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:48:38 +0000 Subject: [PATCH 18/29] Converted references to md format --- content/en/docs/release-notes/R1.md | 2 +- content/en/docs/release-notes/R2.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/en/docs/release-notes/R1.md b/content/en/docs/release-notes/R1.md index 4030170d..443f72e3 100644 --- a/content/en/docs/release-notes/R1.md +++ b/content/en/docs/release-notes/R1.md @@ -7,7 +7,7 @@ weight: 1 ## Prerequisites -Please refer to the [Install Guide](/docs/guides/install-guides) +Please refer to the [Install Guide](../guides/install-guides) for the prerequisites on supported environments. ## Support Matrix diff --git a/content/en/docs/release-notes/R2.md b/content/en/docs/release-notes/R2.md index 6c727c83..56e39b8c 100644 --- a/content/en/docs/release-notes/R2.md +++ b/content/en/docs/release-notes/R2.md @@ -7,7 +7,7 @@ weight: 1 ## Prerequisites -Please refer to the [Install Guide](docs/guides/install-guides/install-on-byoc.md#prerequisites) +Please refer to the [Install Guide](../guides/install-guides/install-on-byoc.md#prerequisites) for the prerequisites on supported environments. ## Support Matrix From 17642b79b5575b91633107e2d881486e690db64e Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 12:49:23 +0000 Subject: [PATCH 19/29] Converted references to md format --- content/en/docs/release-notes/R1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/release-notes/R1.md b/content/en/docs/release-notes/R1.md index 443f72e3..2cccf3e7 100644 --- a/content/en/docs/release-notes/R1.md +++ b/content/en/docs/release-notes/R1.md @@ -7,7 +7,7 @@ weight: 1 ## Prerequisites -Please refer to the [Install Guide](../guides/install-guides) +Please refer to the [Install Guide](../guides/install-guides/_index.md) for the prerequisites on supported environments. ## Support Matrix From 042bc8fab83382ea3812d12be5c549367e1cd7f2 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 14:44:08 +0000 Subject: [PATCH 20/29] Converted references to md format --- content/en/docs/abbreviations.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/abbreviations.md b/content/en/docs/abbreviations.md index 2ad80694..eae255c9 100644 --- a/content/en/docs/abbreviations.md +++ b/content/en/docs/abbreviations.md @@ -5,7 +5,7 @@ weight: 3 --- This page gives brief explanations of abbreviations used in the Nephio project. See also the -[Nephio Glossary](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 * NF: Network Function From 3ce7fdf84580d3a5dec99df72c1457a3fbf04702 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 14:49:58 +0000 Subject: [PATCH 21/29] Converted references to md format --- content/en/docs/guides/user-guides/_index.md | 6 +++--- content/en/docs/guides/user-guides/exercise-1-free5gc.md | 4 ++-- content/en/docs/guides/user-guides/exercise-2-oai.md | 2 +- content/en/docs/release-notes/R1.md | 2 +- content/en/docs/release-notes/R2.md | 2 +- 5 files changed, 8 insertions(+), 8 deletions(-) diff --git a/content/en/docs/guides/user-guides/_index.md b/content/en/docs/guides/user-guides/_index.md index 5f5e1fd4..d31e9275 100644 --- a/content/en/docs/guides/user-guides/_index.md +++ b/content/en/docs/guides/user-guides/_index.md @@ -330,10 +330,10 @@ The diagram below depicts deployment at the high level. On the demo VM, the `test-infra/e2e/provision/hacks` directory contains some workaround scripts. Also, please see the Release Notes -[known issues](../../release-notes/R2.md#known-issues-and-workarounds). +[known issues](content/en/docs/release-notes/R2.md#known-issues-and-workarounds). ## Next Steps -* Learn more about the Nephio [controllers](controllers.md) -* Learn more about how packages are [transformed](../install-guides/package-transformations.md) +* Learn more about the Nephio [controllers](content/en/docs/guides/user-gudies/controllers.md) +* Learn more about how packages are [transformed](content/en/docs/guides/install-guides/package-transformations.md) * Learn more about [deploying helm charts](helm/_index.md) in Nephio diff --git a/content/en/docs/guides/user-guides/exercise-1-free5gc.md b/content/en/docs/guides/user-guides/exercise-1-free5gc.md index 9459fda3..3433155a 100644 --- a/content/en/docs/guides/user-guides/exercise-1-free5gc.md +++ b/content/en/docs/guides/user-guides/exercise-1-free5gc.md @@ -20,7 +20,7 @@ weight: 2 ## Introduction -Be sure you have followed the [installation guide](../install-guides/_index.md) +Be sure you have followed the [installation guide](content/en/docs/install-guides/_index.md) before trying these exercises. These exercises will take you from a system with only the Nephio Management cluster setup to a deployment with: @@ -995,7 +995,7 @@ commits to see how Porch interacts with packages stored in Git repositories. ![Commits in Gitea made by porch](/images/user-guides/gitea-porch.png) After the package is approved, the results can be observed in Nephio Web UI. Head over to http://localhost:7007/config-as-data -([port forwarding](../install-guides/_index.md#access-to-the-user-interfaces) must be running). +([port forwarding](content/en/docs/install-guides/_index.md#access-to-the-user-interfaces) must be running). ![Deployments in Nephio UI](/images/user-guides/UPF-Capacity.png) diff --git a/content/en/docs/guides/user-guides/exercise-2-oai.md b/content/en/docs/guides/user-guides/exercise-2-oai.md index d52e687e..1824201a 100644 --- a/content/en/docs/guides/user-guides/exercise-2-oai.md +++ b/content/en/docs/guides/user-guides/exercise-2-oai.md @@ -19,7 +19,7 @@ weight: 2 ## Introduction -Be sure you have followed the [installation guide](../install-guides/_index.md) +Be sure you have followed the [installation guide](content/en/docs/guides/install-guides/_index.md) before trying these exercises. These exercises will take you from a system with only the Nephio Management cluster setup to a deployment with: diff --git a/content/en/docs/release-notes/R1.md b/content/en/docs/release-notes/R1.md index 2cccf3e7..55dceb29 100644 --- a/content/en/docs/release-notes/R1.md +++ b/content/en/docs/release-notes/R1.md @@ -7,7 +7,7 @@ weight: 1 ## Prerequisites -Please refer to the [Install Guide](../guides/install-guides/_index.md) +Please refer to the [Install Guide](content/en/docs/guides/install-guides/_index.md) for the prerequisites on supported environments. ## Support Matrix diff --git a/content/en/docs/release-notes/R2.md b/content/en/docs/release-notes/R2.md index 56e39b8c..4129c8dc 100644 --- a/content/en/docs/release-notes/R2.md +++ b/content/en/docs/release-notes/R2.md @@ -7,7 +7,7 @@ weight: 1 ## Prerequisites -Please refer to the [Install Guide](../guides/install-guides/install-on-byoc.md#prerequisites) +Please refer to the [Install Guide](content/en/docs/guides/install-guides/install-on-byoc.md#prerequisites) for the prerequisites on supported environments. ## Support Matrix From aff891baa0761b280a6a9b62f6493fb4000d498e Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 14:53:09 +0000 Subject: [PATCH 22/29] Converted references to md format --- content/en/docs/release-notes/R2.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/release-notes/R2.md b/content/en/docs/release-notes/R2.md index 4129c8dc..85882a35 100644 --- a/content/en/docs/release-notes/R2.md +++ b/content/en/docs/release-notes/R2.md @@ -7,7 +7,7 @@ weight: 1 ## Prerequisites -Please refer to the [Install Guide](content/en/docs/guides/install-guides/install-on-byoc.md#prerequisites) +Please refer to the [Install Guide](/content/en/docs/guides/install-guides/install-on-byoc.md#prerequisites) for the prerequisites on supported environments. ## Support Matrix From 76965eb507818552c750a781a1ef965759d601d9 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 14:59:50 +0000 Subject: [PATCH 23/29] Converted references to md format --- content/en/docs/guides/user-guides/_index.md | 6 +++--- content/en/docs/guides/user-guides/exercise-1-free5gc.md | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/content/en/docs/guides/user-guides/_index.md b/content/en/docs/guides/user-guides/_index.md index d31e9275..3682854a 100644 --- a/content/en/docs/guides/user-guides/_index.md +++ b/content/en/docs/guides/user-guides/_index.md @@ -330,10 +330,10 @@ The diagram below depicts deployment at the high level. On the demo VM, the `test-infra/e2e/provision/hacks` directory contains some workaround scripts. Also, please see the Release Notes -[known issues](content/en/docs/release-notes/R2.md#known-issues-and-workarounds). +[known issues](/content/en/docs/release-notes/R2.md#known-issues-and-workarounds). ## Next Steps -* Learn more about the Nephio [controllers](content/en/docs/guides/user-gudies/controllers.md) +* Learn more about the Nephio [controllers](content/en/docs/guides/user-guides/controllers.md) * Learn more about how packages are [transformed](content/en/docs/guides/install-guides/package-transformations.md) -* Learn more about [deploying helm charts](helm/_index.md) in Nephio +* Learn more about [deploying helm charts](content/en/docs/guides/user-guides/helm/_index.md) in Nephio diff --git a/content/en/docs/guides/user-guides/exercise-1-free5gc.md b/content/en/docs/guides/user-guides/exercise-1-free5gc.md index 3433155a..fbd5790d 100644 --- a/content/en/docs/guides/user-guides/exercise-1-free5gc.md +++ b/content/en/docs/guides/user-guides/exercise-1-free5gc.md @@ -20,7 +20,7 @@ weight: 2 ## Introduction -Be sure you have followed the [installation guide](content/en/docs/install-guides/_index.md) +Be sure you have followed the [installation guide](content/en/docs/guides/install-guides/_index.md) before trying these exercises. These exercises will take you from a system with only the Nephio Management cluster setup to a deployment with: @@ -995,7 +995,7 @@ commits to see how Porch interacts with packages stored in Git repositories. ![Commits in Gitea made by porch](/images/user-guides/gitea-porch.png) After the package is approved, the results can be observed in Nephio Web UI. Head over to http://localhost:7007/config-as-data -([port forwarding](content/en/docs/install-guides/_index.md#access-to-the-user-interfaces) must be running). +([port forwarding](content/en/docs/guides/install-guides/_index.md#access-to-the-user-interfaces) must be running). ![Deployments in Nephio UI](/images/user-guides/UPF-Capacity.png) From dc1ed0c93a79e5fd57905f1f68af898f06159991 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 15:05:44 +0000 Subject: [PATCH 24/29] Converted references to md format --- content/en/docs/guides/user-guides/helm/_index.md | 2 +- content/en/docs/guides/user-guides/helm/flux-helm.md | 6 +++--- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/content/en/docs/guides/user-guides/helm/_index.md b/content/en/docs/guides/user-guides/helm/_index.md index 15b3fc1c..7e4900ee 100644 --- a/content/en/docs/guides/user-guides/helm/_index.md +++ b/content/en/docs/guides/user-guides/helm/_index.md @@ -16,6 +16,6 @@ for deploying on Kubernetes, legacy helm support will be required for a number o ### Deployment options -* [Using Flux CD](flux-helm.md) +* [Using Flux CD](content/en/docs/guides/user-guides/helm/flux-helm.md) * [Operator SDK](https://sdk.operatorframework.io/docs/building-operators/helm/) diff --git a/content/en/docs/guides/user-guides/helm/flux-helm.md b/content/en/docs/guides/user-guides/helm/flux-helm.md index 5a71642e..c247075d 100644 --- a/content/en/docs/guides/user-guides/helm/flux-helm.md +++ b/content/en/docs/guides/user-guides/helm/flux-helm.md @@ -16,9 +16,9 @@ Then, we can utilize the flux Custom Resources defined in another test kpt packa ## Prerequisites: -* [Nephio R1 sandbox](../../install-guides/_index.md): Set up the Nephio sandbox environment. -* [Access to the Nephio Web UI](../../install-guides/_index.md#access-to-the-user-interfaces) -* [Nephio R1 sandbox workload clusters](../exercise-1-free5gc.md): +* [Nephio R1 sandbox](content/en/docs/guides/install-guides/install-guides/_index.md): Set up the Nephio sandbox environment. +* [Access to the Nephio Web UI](content/en/docs/guides/install-guides/_index.md#access-to-the-user-interfaces) +* [Nephio R1 sandbox workload clusters](content/en/docs/guidesuser-guides/exercise-1-free5gc.md): Create/Deploy the predefined set of workload clusters by completing the Free5GC Core quick start exercises up to and including [Step 3](../exercise-1-free5gc.md#step-3-deploy-two-edge-clusters). From ef683af381ef3db25ef16d2078377cc9a27f7d55 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 15:16:40 +0000 Subject: [PATCH 25/29] Converted references to md format --- content/en/docs/guides/contributor-guides/_index.md | 2 +- content/en/docs/guides/install-guides/_index.md | 8 ++++---- .../guides/install-guides/explore-nephio-free5gc.md | 6 +++--- .../en/docs/guides/install-guides/explore-sandbox.md | 2 +- .../en/docs/guides/install-guides/install-on-byoc.md | 10 +++++----- .../en/docs/guides/install-guides/install-on-gce.md | 8 ++++---- .../en/docs/guides/install-guides/install-on-gcp.md | 11 ++++++----- .../guides/install-guides/install-on-openshift.md | 3 ++- .../guides/install-guides/install-on-single-vm.md | 4 ++-- content/en/docs/guides/install-guides/webui.md | 4 ++-- content/en/docs/guides/user-guides/helm/flux-helm.md | 4 ++-- 11 files changed, 32 insertions(+), 30 deletions(-) diff --git a/content/en/docs/guides/contributor-guides/_index.md b/content/en/docs/guides/contributor-guides/_index.md index aba8d6bd..32d3fd48 100644 --- a/content/en/docs/guides/contributor-guides/_index.md +++ b/content/en/docs/guides/contributor-guides/_index.md @@ -11,5 +11,5 @@ This developer guide is for for people who want to write code for the Nephio pro 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](minimal-environment.md) defines common terminology +* How to set up a [Minimal Development Environment](content/en/docs/guides/contributor-guides/minimal-environment.md) defines common terminology used in the Nephio project. \ No newline at end of file diff --git a/content/en/docs/guides/install-guides/_index.md b/content/en/docs/guides/install-guides/_index.md index 9b7798ec..e186fe0e 100644 --- a/content/en/docs/guides/install-guides/_index.md +++ b/content/en/docs/guides/install-guides/_index.md @@ -173,7 +173,7 @@ ssh @ ## Next Steps -* Step through the [Free5GC](../user-guides/exercise-1-free5gc.md) and [OAI](../user-guides/exercise-2-oai.md) exercises -* Learn more about the [Nephio demo sandbox](explore-sandbox.md) -* Dig into the [user guide](../user-guides#nephio-r1-user-guide) -* Create a [Bring-Your-Own-Cluster](install-on-byoc.md) Nephio Installation +* Step through the [Free5GC](content/en/docs/guides/user-guides/exercise-1-free5gc.md) and [OAI](content/en/docs/guides/user-guides/exercise-2-oai.md) exercises +* Learn more about the [Nephio demo sandbox](content/en/docs/guides/install-guides/explore-sandbox.md) +* Dig into the [user guide](content/en/docs/guides/user-guides#nephio-r1-user-guide) +* Create a [Bring-Your-Own-Cluster](content/en/docs/guides/install-guides/install-on-byoc.md) Nephio Installation diff --git a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md index afc8c70c..ea0847e6 100644 --- a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md +++ b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md @@ -5,9 +5,9 @@ description: > weight: 6 --- -Concepts as [Operator](../../glossary.md#operator) and -[Controller](../../glossary.md#controller) and -[CR](../../glossary.md#custom-resource) have already been explained here. +Concepts as [Operator](content/en/docs/glossary.md#operator) and +[Controller](content/en/docs/glossary.md#controller) and +[CR](content/en/docs/glossary.md#custom-resource) have already been explained here. # Deploy the operator to the cluster diff --git a/content/en/docs/guides/install-guides/explore-sandbox.md b/content/en/docs/guides/install-guides/explore-sandbox.md index 969efb9b..e55fd43d 100644 --- a/content/en/docs/guides/install-guides/explore-sandbox.md +++ b/content/en/docs/guides/install-guides/explore-sandbox.md @@ -6,7 +6,7 @@ weight: 5 --- -You have installed the Nephio single VM [using the installation instructions](install-on-single-vm.md). +You have installed the Nephio single VM [using the installation instructions](content/en/docs/guides/install-guides/install-on-single-vm.md). The installation has done a good job of installing a complex software stack without any fuss. Let's take a look around. ![Software Installed by the Nephio Sandbox Installation](/images/install-guides/ManagementCluster.png) diff --git a/content/en/docs/guides/install-guides/install-on-byoc.md b/content/en/docs/guides/install-guides/install-on-byoc.md index b0a99653..54a5e8cf 100644 --- a/content/en/docs/guides/install-guides/install-on-byoc.md +++ b/content/en/docs/guides/install-guides/install-on-byoc.md @@ -67,9 +67,9 @@ options, if you wish to assemble your own set of components. | Environment | Description | | ----------- | ---------------------------------------------------------- | -| [Single VM](install-on-single-vm.md) | The single VM demo environment, set up "the hard way" - without using the included provisioning script. This creates a complete Nephio-in-a-VM, just like the R1 demo environment. These instructions cover both Ubuntu and Fedora. | -| [Google Cloud Platform](install-on-gcp.md) | Nephio running in GCP. A GKE cluster is used as the management cluster, with Anthos Config Controller for GCP infrastructure provisioning, Gitea as the Git provider, and Web UI authentication and authorization via Google OAuth 2.0 | -| [OpenShift](install-on-openshift.md) | Nephio running in OpenShift, with Cluster API as the cluster provisioner, Gitea as the Git provider and Web UI authentication backed by Open Shift OIDC. | +| [Single VM](content/en/docs/guides/install-guides/install-on-single-vm.md) | The single VM demo environment, set up "the hard way" - without using the included provisioning script. This creates a complete Nephio-in-a-VM, just like the R1 demo environment. These instructions cover both Ubuntu and Fedora. | +| [Google Cloud Platform](content/en/docs/guides/install-guides/install-on-gcp.md) | Nephio running in GCP. A GKE cluster is used as the management cluster, with Anthos Config Controller for GCP infrastructure provisioning, Gitea as the Git provider, and Web UI authentication and authorization via Google OAuth 2.0 | +| [OpenShift](content/en/docs/guides/install-guides/install-on-openshift.md) | Nephio running in OpenShift, with Cluster API as the cluster provisioner, Gitea as the Git provider and Web UI authentication backed by Open Shift OIDC. | ## A La Carte Installation @@ -146,8 +146,8 @@ development it must not be exposed on the internet (for example, via a LoadBalancer service, Ingress, or Route). The WebUI currently supports the following options: -- [Google OAuth or OIDC](webui-auth-gcp.md) -- [OIDC with Okta](webui-auth-okta.md) +- [Google OAuth or OIDC](content/en/docs/guides/install-guides/webui-auth-gcp.md) +- [OIDC with Okta](content/en/docs/guides/install-guides/webui-auth-okta.md) ### Nephio Stock Repositories diff --git a/content/en/docs/guides/install-guides/install-on-gce.md b/content/en/docs/guides/install-guides/install-on-gce.md index b5566ef5..821b21d6 100644 --- a/content/en/docs/guides/install-guides/install-on-gce.md +++ b/content/en/docs/guides/install-guides/install-on-gce.md @@ -174,7 +174,7 @@ ssh @ ## Next Steps * Step through the exercises - * [Free5GC Testbed Deployment and E2E testing with UERANSIM](../user-guides/exercise-1-free5gc.md) - * [OAI Core and RAN Testbed Deployment and E2E testing](../user-guides/exercise-2-oai.md) -* Learn more about the [Nephio demo sandbox](explore-sandbox.md) -* Dig into the [user guide](../user-guides/_index.md) + * [Free5GC Testbed Deployment and E2E testing with UERANSIM](content/en/docs/guides/content/en/docs/guides/install-guides/user-guides/exercise-1-free5gc.md) + * [OAI Core and RAN Testbed Deployment and E2E testing](content/en/docs/guides/user-guides/exercise-2-oai.md) +* Learn more about the [Nephio demo sandbox](content/en/docs/guides/install-guides/explore-sandbox.md) +* Dig into the [user guide](content/en/docs/guides/user-guides/_index.md) diff --git a/content/en/docs/guides/install-guides/install-on-gcp.md b/content/en/docs/guides/install-guides/install-on-gcp.md index ba4d1583..f6796658 100644 --- a/content/en/docs/guides/install-guides/install-on-gcp.md +++ b/content/en/docs/guides/install-guides/install-on-gcp.md @@ -1022,9 +1022,9 @@ git commit -m "Initial checking of nephio-mgmt" **Prior to deploying the package, we need to manually setup the secret for the WebUI.** -See [Google OAuth 2.0 or OIDC](webui-auth-gcp.md) for details on how to -set up OAuth. In particular you need to [create the client ID](webui-auth-gcp.md#creating-an-oauth-20-client-id) -and the [secret](webui-auth-gcp.md#create-the-secret-in-the-cluster) +See [Google OAuth 2.0 or OIDC](content/en/docs/guides/install-guides/webui-auth-gcp.md) for details on how to +set up OAuth. In particular you need to [create the client ID](content/en/docs/guides/install-guides/webui-auth-gcp.md#creating-an-oauth-20-client-id) +and the [secret](content/en/docs/guides/install-guides/webui-auth-gcp.md#create-the-secret-in-the-cluster) manually. The `nephio-webui` subpackage in `nephio-mgmt` is already set up for @@ -1384,5 +1384,6 @@ Note that the exercises using free5gc rely on Multus and on the gtp5g kernel mod GKE nodes. Therefore, the free5gc workloads cannot be run on this installation. You will need to alter the exercises to\ use workloads that do not rely on that functionality in order to experiment with Nephio features. -* Step through the [Free5GC](../user-guides/exercise-1-free5gc.md) and [OAI](../user-guides/exercise-2-oai.md) exercises -* Dig into the [user guide](../user-guides/_index.md) +* Step through the [Free5GC](content/en/docs/guides/user-guides/exercise-1-free5gc.md) and +[OAI](content/en/docs/guides/user-guides/exercise-2-oai.md) exercises +* Dig into the [user guide](content/en/docs/guides/user-guides/_index.md) diff --git a/content/en/docs/guides/install-guides/install-on-openshift.md b/content/en/docs/guides/install-guides/install-on-openshift.md index 06216f83..055ebaa1 100644 --- a/content/en/docs/guides/install-guides/install-on-openshift.md +++ b/content/en/docs/guides/install-guides/install-on-openshift.md @@ -70,7 +70,8 @@ Application: oc apply -f https://raw.githubusercontent.com/openshift-telco/blueprints-nephio-openshift/v1.0.1/nephio-mgnt/app-of-apps.yaml ``` -This will take care of applying the [common dependencies](common-dependencies.md) and the [common components](common-components.md) +This will take care of applying the [common dependencies](content/en/docs/guides/install-guides/common-dependencies.md) +and the [common components](content/en/docs/guides/install-guides/common-components.md) ### Access the Nephio diff --git a/content/en/docs/guides/install-guides/install-on-single-vm.md b/content/en/docs/guides/install-guides/install-on-single-vm.md index 0ba66184..c5f54d64 100644 --- a/content/en/docs/guides/install-guides/install-on-single-vm.md +++ b/content/en/docs/guides/install-guides/install-on-single-vm.md @@ -65,12 +65,12 @@ kpt live apply gitea --reconcile-timeout 15m --output=table There are a few dependencies that are common across most installations, and do not require any installation-specific setup. You should install these next, as described in the -[common dependencies documentation](common-dependencies.md). +[common dependencies documentation](content/en/docs/guides/install-guides/common-dependencies.md). ## Common Components With the necessary dependencies now installed, you can now install the essential Nephio components. This is documented -in the [common components documentation](common-components.md). +in the [common components documentation](content/en/docs/guides/install-guides/common-components.md). ## Provisioning Cluster API diff --git a/content/en/docs/guides/install-guides/webui.md b/content/en/docs/guides/install-guides/webui.md index 284aadd4..2fc3b388 100644 --- a/content/en/docs/guides/install-guides/webui.md +++ b/content/en/docs/guides/install-guides/webui.md @@ -54,8 +54,8 @@ service). Configuring authentication for the WebUI is very specific to the particular cluster environment. Guides for different environments are below: -- [Google OAuth or OIDC](webui-auth-gcp.md) -- [OIDC with Okta](webui-auth-okta.md) +- [Google OAuth or OIDC](content/en/docs/guides/install-guides/webui-auth-gcp.md) +- [OIDC with Okta](content/en/docs/guides/install-guides/webui-auth-okta.md) Once that configuration is updated, you can proceed with the installation (note, this uses `inventory-policy=adopt`, since in the previous steps we may have created the namespace already). diff --git a/content/en/docs/guides/user-guides/helm/flux-helm.md b/content/en/docs/guides/user-guides/helm/flux-helm.md index c247075d..eba9d79c 100644 --- a/content/en/docs/guides/user-guides/helm/flux-helm.md +++ b/content/en/docs/guides/user-guides/helm/flux-helm.md @@ -18,9 +18,9 @@ Then, we can utilize the flux Custom Resources defined in another test kpt packa * [Nephio R1 sandbox](content/en/docs/guides/install-guides/install-guides/_index.md): Set up the Nephio sandbox environment. * [Access to the Nephio Web UI](content/en/docs/guides/install-guides/_index.md#access-to-the-user-interfaces) -* [Nephio R1 sandbox workload clusters](content/en/docs/guidesuser-guides/exercise-1-free5gc.md): +* [Nephio R1 sandbox workload clusters](content/en/docs/guides/user-guides/exercise-1-free5gc.md): Create/Deploy the predefined set of workload clusters by completing the Free5GC Core quick start exercises up to and including - [Step 3](../exercise-1-free5gc.md#step-3-deploy-two-edge-clusters). + [Step 3](content/en/docs/guides/user-guides/exercise-1-free5gc.md#step-3-deploy-two-edge-clusters). ### Deploying the flux-helm-controllers pkg From 0ecac26ddfdc4c3f97fe60bcb71685f0c617c859 Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 15:20:14 +0000 Subject: [PATCH 26/29] Converted references to md format --- content/en/docs/release-notes/R1.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/en/docs/release-notes/R1.md b/content/en/docs/release-notes/R1.md index 55dceb29..cff99b4d 100644 --- a/content/en/docs/release-notes/R1.md +++ b/content/en/docs/release-notes/R1.md @@ -7,7 +7,7 @@ weight: 1 ## Prerequisites -Please refer to the [Install Guide](content/en/docs/guides/install-guides/_index.md) +Please refer to the [Install Guide](/content/en/docs/guides/install-guides/_index.md) for the prerequisites on supported environments. ## Support Matrix From cf91c843d6e5f4423beb5f3cc0d89f12b70a169d Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 15:44:21 +0000 Subject: [PATCH 27/29] Converted references to md format --- .linkspector.yml | 4 +++- content/en/docs/guides/install-guides/_index.md | 2 +- content/en/docs/guides/install-guides/install-on-gce.md | 2 +- content/en/docs/guides/user-guides/helm/flux-helm.md | 2 +- 4 files changed, 6 insertions(+), 4 deletions(-) diff --git a/.linkspector.yml b/.linkspector.yml index e5b4399e..e73b0822 100644 --- a/.linkspector.yml +++ b/.linkspector.yml @@ -10,4 +10,6 @@ aliveStatusCodes: ignorePatterns: - pattern: "^http://localhost.*$" - pattern: "^http://HOSTNAME:PORT.*$" - \ No newline at end of file +replacementPatterns: + - pattern: ".md#.*$" + replacement: ".md" \ No newline at end of file diff --git a/content/en/docs/guides/install-guides/_index.md b/content/en/docs/guides/install-guides/_index.md index e186fe0e..781e92e8 100644 --- a/content/en/docs/guides/install-guides/_index.md +++ b/content/en/docs/guides/install-guides/_index.md @@ -175,5 +175,5 @@ ssh @ * Step through the [Free5GC](content/en/docs/guides/user-guides/exercise-1-free5gc.md) and [OAI](content/en/docs/guides/user-guides/exercise-2-oai.md) exercises * Learn more about the [Nephio demo sandbox](content/en/docs/guides/install-guides/explore-sandbox.md) -* Dig into the [user guide](content/en/docs/guides/user-guides#nephio-r1-user-guide) +* Dig into the [user guide](content/en/docs/guides/user-guides/_index.md) * Create a [Bring-Your-Own-Cluster](content/en/docs/guides/install-guides/install-on-byoc.md) Nephio Installation diff --git a/content/en/docs/guides/install-guides/install-on-gce.md b/content/en/docs/guides/install-guides/install-on-gce.md index 821b21d6..30b4824c 100644 --- a/content/en/docs/guides/install-guides/install-on-gce.md +++ b/content/en/docs/guides/install-guides/install-on-gce.md @@ -174,7 +174,7 @@ ssh @ ## Next Steps * Step through the exercises - * [Free5GC Testbed Deployment and E2E testing with UERANSIM](content/en/docs/guides/content/en/docs/guides/install-guides/user-guides/exercise-1-free5gc.md) + * [Free5GC Testbed Deployment and E2E testing with UERANSIM](content/en/docs/guides/user-guides/exercise-1-free5gc.md) * [OAI Core and RAN Testbed Deployment and E2E testing](content/en/docs/guides/user-guides/exercise-2-oai.md) * Learn more about the [Nephio demo sandbox](content/en/docs/guides/install-guides/explore-sandbox.md) * Dig into the [user guide](content/en/docs/guides/user-guides/_index.md) diff --git a/content/en/docs/guides/user-guides/helm/flux-helm.md b/content/en/docs/guides/user-guides/helm/flux-helm.md index eba9d79c..af8ca470 100644 --- a/content/en/docs/guides/user-guides/helm/flux-helm.md +++ b/content/en/docs/guides/user-guides/helm/flux-helm.md @@ -16,7 +16,7 @@ Then, we can utilize the flux Custom Resources defined in another test kpt packa ## Prerequisites: -* [Nephio R1 sandbox](content/en/docs/guides/install-guides/install-guides/_index.md): Set up the Nephio sandbox environment. +* [Nephio R1 sandbox]/content/en/docs/guides/install-guides/install-guides/_index.md): Set up the Nephio sandbox environment. * [Access to the Nephio Web UI](content/en/docs/guides/install-guides/_index.md#access-to-the-user-interfaces) * [Nephio R1 sandbox workload clusters](content/en/docs/guides/user-guides/exercise-1-free5gc.md): Create/Deploy the predefined set of workload clusters by completing the Free5GC Core quick start exercises up to and including From 6ddbf8cc416b2de2996cbefe1e099355bf16cd1b Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 16:02:30 +0000 Subject: [PATCH 28/29] Changed to absolute references to fix for md refereces --- content/en/docs/abbreviations.md | 2 +- content/en/docs/guides/contributor-guides/_index.md | 2 +- content/en/docs/guides/install-guides/_index.md | 8 ++++---- .../guides/install-guides/explore-nephio-free5gc.md | 6 +++--- .../en/docs/guides/install-guides/explore-sandbox.md | 2 +- .../en/docs/guides/install-guides/install-on-byoc.md | 10 +++++----- .../en/docs/guides/install-guides/install-on-gce.md | 8 ++++---- .../en/docs/guides/install-guides/install-on-gcp.md | 12 ++++++------ .../guides/install-guides/install-on-openshift.md | 4 ++-- .../guides/install-guides/install-on-single-vm.md | 4 ++-- content/en/docs/guides/install-guides/webui.md | 4 ++-- content/en/docs/guides/user-guides/_index.md | 6 +++--- .../en/docs/guides/user-guides/exercise-1-free5gc.md | 4 ++-- content/en/docs/guides/user-guides/exercise-2-oai.md | 2 +- content/en/docs/guides/user-guides/helm/_index.md | 2 +- content/en/docs/guides/user-guides/helm/flux-helm.md | 6 +++--- resources.md | 4 ++-- 17 files changed, 43 insertions(+), 43 deletions(-) diff --git a/content/en/docs/abbreviations.md b/content/en/docs/abbreviations.md index eae255c9..f03dcb7b 100644 --- a/content/en/docs/abbreviations.md +++ b/content/en/docs/abbreviations.md @@ -5,7 +5,7 @@ weight: 3 --- This page gives brief explanations of abbreviations used in the Nephio project. See also the -[Nephio Glossary](content/en/docs/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 * NF: Network Function diff --git a/content/en/docs/guides/contributor-guides/_index.md b/content/en/docs/guides/contributor-guides/_index.md index 32d3fd48..79a31d8f 100644 --- a/content/en/docs/guides/contributor-guides/_index.md +++ b/content/en/docs/guides/contributor-guides/_index.md @@ -11,5 +11,5 @@ This developer guide is for for people who want to write code for the Nephio pro 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](content/en/docs/guides/contributor-guides/minimal-environment.md) defines common terminology +* How to set up a [Minimal Development Environment](/content/en/docs/guides/contributor-guides/minimal-environment.md) defines common terminology used in the Nephio project. \ No newline at end of file diff --git a/content/en/docs/guides/install-guides/_index.md b/content/en/docs/guides/install-guides/_index.md index 781e92e8..63f3fd4c 100644 --- a/content/en/docs/guides/install-guides/_index.md +++ b/content/en/docs/guides/install-guides/_index.md @@ -173,7 +173,7 @@ ssh @ ## Next Steps -* Step through the [Free5GC](content/en/docs/guides/user-guides/exercise-1-free5gc.md) and [OAI](content/en/docs/guides/user-guides/exercise-2-oai.md) exercises -* Learn more about the [Nephio demo sandbox](content/en/docs/guides/install-guides/explore-sandbox.md) -* Dig into the [user guide](content/en/docs/guides/user-guides/_index.md) -* Create a [Bring-Your-Own-Cluster](content/en/docs/guides/install-guides/install-on-byoc.md) Nephio Installation +* Step through the [Free5GC](/content/en/docs/guides/user-guides/exercise-1-free5gc.md) and [OAI](/content/en/docs/guides/user-guides/exercise-2-oai.md) exercises +* Learn more about the [Nephio demo sandbox](/content/en/docs/guides/install-guides/explore-sandbox.md) +* Dig into the [user guide](/content/en/docs/guides/user-guides/_index.md) +* Create a [Bring-Your-Own-Cluster](/content/en/docs/guides/install-guides/install-on-byoc.md) Nephio Installation diff --git a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md index ea0847e6..0636647c 100644 --- a/content/en/docs/guides/install-guides/explore-nephio-free5gc.md +++ b/content/en/docs/guides/install-guides/explore-nephio-free5gc.md @@ -5,9 +5,9 @@ description: > weight: 6 --- -Concepts as [Operator](content/en/docs/glossary.md#operator) and -[Controller](content/en/docs/glossary.md#controller) and -[CR](content/en/docs/glossary.md#custom-resource) have already been explained here. +Concepts as [Operator](/content/en/docs/glossary.md#operator) and +[Controller](/content/en/docs/glossary.md#controller) and +[CR](/content/en/docs/glossary.md#custom-resource) have already been explained here. # Deploy the operator to the cluster diff --git a/content/en/docs/guides/install-guides/explore-sandbox.md b/content/en/docs/guides/install-guides/explore-sandbox.md index e55fd43d..ff8ba5dd 100644 --- a/content/en/docs/guides/install-guides/explore-sandbox.md +++ b/content/en/docs/guides/install-guides/explore-sandbox.md @@ -6,7 +6,7 @@ weight: 5 --- -You have installed the Nephio single VM [using the installation instructions](content/en/docs/guides/install-guides/install-on-single-vm.md). +You have installed the Nephio single VM [using the installation instructions](/content/en/docs/guides/install-guides/install-on-single-vm.md). The installation has done a good job of installing a complex software stack without any fuss. Let's take a look around. ![Software Installed by the Nephio Sandbox Installation](/images/install-guides/ManagementCluster.png) diff --git a/content/en/docs/guides/install-guides/install-on-byoc.md b/content/en/docs/guides/install-guides/install-on-byoc.md index 54a5e8cf..4ef4d3f3 100644 --- a/content/en/docs/guides/install-guides/install-on-byoc.md +++ b/content/en/docs/guides/install-guides/install-on-byoc.md @@ -67,9 +67,9 @@ options, if you wish to assemble your own set of components. | Environment | Description | | ----------- | ---------------------------------------------------------- | -| [Single VM](content/en/docs/guides/install-guides/install-on-single-vm.md) | The single VM demo environment, set up "the hard way" - without using the included provisioning script. This creates a complete Nephio-in-a-VM, just like the R1 demo environment. These instructions cover both Ubuntu and Fedora. | -| [Google Cloud Platform](content/en/docs/guides/install-guides/install-on-gcp.md) | Nephio running in GCP. A GKE cluster is used as the management cluster, with Anthos Config Controller for GCP infrastructure provisioning, Gitea as the Git provider, and Web UI authentication and authorization via Google OAuth 2.0 | -| [OpenShift](content/en/docs/guides/install-guides/install-on-openshift.md) | Nephio running in OpenShift, with Cluster API as the cluster provisioner, Gitea as the Git provider and Web UI authentication backed by Open Shift OIDC. | +| [Single VM](/content/en/docs/guides/install-guides/install-on-single-vm.md) | The single VM demo environment, set up "the hard way" - without using the included provisioning script. This creates a complete Nephio-in-a-VM, just like the R1 demo environment. These instructions cover both Ubuntu and Fedora. | +| [Google Cloud Platform](/content/en/docs/guides/install-guides/install-on-gcp.md) | Nephio running in GCP. A GKE cluster is used as the management cluster, with Anthos Config Controller for GCP infrastructure provisioning, Gitea as the Git provider, and Web UI authentication and authorization via Google OAuth 2.0 | +| [OpenShift](/content/en/docs/guides/install-guides/install-on-openshift.md) | Nephio running in OpenShift, with Cluster API as the cluster provisioner, Gitea as the Git provider and Web UI authentication backed by Open Shift OIDC. | ## A La Carte Installation @@ -146,8 +146,8 @@ development it must not be exposed on the internet (for example, via a LoadBalancer service, Ingress, or Route). The WebUI currently supports the following options: -- [Google OAuth or OIDC](content/en/docs/guides/install-guides/webui-auth-gcp.md) -- [OIDC with Okta](content/en/docs/guides/install-guides/webui-auth-okta.md) +- [Google OAuth or OIDC](/content/en/docs/guides/install-guides/webui-auth-gcp.md) +- [OIDC with Okta](/content/en/docs/guides/install-guides/webui-auth-okta.md) ### Nephio Stock Repositories diff --git a/content/en/docs/guides/install-guides/install-on-gce.md b/content/en/docs/guides/install-guides/install-on-gce.md index 30b4824c..cca390a7 100644 --- a/content/en/docs/guides/install-guides/install-on-gce.md +++ b/content/en/docs/guides/install-guides/install-on-gce.md @@ -174,7 +174,7 @@ ssh @ ## Next Steps * Step through the exercises - * [Free5GC Testbed Deployment and E2E testing with UERANSIM](content/en/docs/guides/user-guides/exercise-1-free5gc.md) - * [OAI Core and RAN Testbed Deployment and E2E testing](content/en/docs/guides/user-guides/exercise-2-oai.md) -* Learn more about the [Nephio demo sandbox](content/en/docs/guides/install-guides/explore-sandbox.md) -* Dig into the [user guide](content/en/docs/guides/user-guides/_index.md) + * [Free5GC Testbed Deployment and E2E testing with UERANSIM](/content/en/docs/guides/user-guides/exercise-1-free5gc.md) + * [OAI Core and RAN Testbed Deployment and E2E testing](/content/en/docs/guides/user-guides/exercise-2-oai.md) +* Learn more about the [Nephio demo sandbox](/content/en/docs/guides/install-guides/explore-sandbox.md) +* Dig into the [user guide](/content/en/docs/guides/user-guides/_index.md) diff --git a/content/en/docs/guides/install-guides/install-on-gcp.md b/content/en/docs/guides/install-guides/install-on-gcp.md index f6796658..4cfd3892 100644 --- a/content/en/docs/guides/install-guides/install-on-gcp.md +++ b/content/en/docs/guides/install-guides/install-on-gcp.md @@ -1022,9 +1022,9 @@ git commit -m "Initial checking of nephio-mgmt" **Prior to deploying the package, we need to manually setup the secret for the WebUI.** -See [Google OAuth 2.0 or OIDC](content/en/docs/guides/install-guides/webui-auth-gcp.md) for details on how to -set up OAuth. In particular you need to [create the client ID](content/en/docs/guides/install-guides/webui-auth-gcp.md#creating-an-oauth-20-client-id) -and the [secret](content/en/docs/guides/install-guides/webui-auth-gcp.md#create-the-secret-in-the-cluster) +See [Google OAuth 2.0 or OIDC](/content/en/docs/guides/install-guides/webui-auth-gcp.md) for details on how to +set up OAuth. In particular you need to [create the client ID](/content/en/docs/guides/install-guides/webui-auth-gcp.md#creating-an-oauth-20-client-id) +and the [secret](/content/en/docs/guides/install-guides/webui-auth-gcp.md#create-the-secret-in-the-cluster) manually. The `nephio-webui` subpackage in `nephio-mgmt` is already set up for @@ -1384,6 +1384,6 @@ Note that the exercises using free5gc rely on Multus and on the gtp5g kernel mod GKE nodes. Therefore, the free5gc workloads cannot be run on this installation. You will need to alter the exercises to\ use workloads that do not rely on that functionality in order to experiment with Nephio features. -* Step through the [Free5GC](content/en/docs/guides/user-guides/exercise-1-free5gc.md) and -[OAI](content/en/docs/guides/user-guides/exercise-2-oai.md) exercises -* Dig into the [user guide](content/en/docs/guides/user-guides/_index.md) +* Step through the [Free5GC](/content/en/docs/guides/user-guides/exercise-1-free5gc.md) and +[OAI](/content/en/docs/guides/user-guides/exercise-2-oai.md) exercises +* Dig into the [user guide](/content/en/docs/guides/user-guides/_index.md) diff --git a/content/en/docs/guides/install-guides/install-on-openshift.md b/content/en/docs/guides/install-guides/install-on-openshift.md index 055ebaa1..a1015e2b 100644 --- a/content/en/docs/guides/install-guides/install-on-openshift.md +++ b/content/en/docs/guides/install-guides/install-on-openshift.md @@ -70,8 +70,8 @@ Application: oc apply -f https://raw.githubusercontent.com/openshift-telco/blueprints-nephio-openshift/v1.0.1/nephio-mgnt/app-of-apps.yaml ``` -This will take care of applying the [common dependencies](content/en/docs/guides/install-guides/common-dependencies.md) -and the [common components](content/en/docs/guides/install-guides/common-components.md) +This will take care of applying the [common dependencies](/content/en/docs/guides/install-guides/common-dependencies.md) +and the [common components](/content/en/docs/guides/install-guides/common-components.md) ### Access the Nephio diff --git a/content/en/docs/guides/install-guides/install-on-single-vm.md b/content/en/docs/guides/install-guides/install-on-single-vm.md index c5f54d64..87d9b69b 100644 --- a/content/en/docs/guides/install-guides/install-on-single-vm.md +++ b/content/en/docs/guides/install-guides/install-on-single-vm.md @@ -65,12 +65,12 @@ kpt live apply gitea --reconcile-timeout 15m --output=table There are a few dependencies that are common across most installations, and do not require any installation-specific setup. You should install these next, as described in the -[common dependencies documentation](content/en/docs/guides/install-guides/common-dependencies.md). +[common dependencies documentation](/content/en/docs/guides/install-guides/common-dependencies.md). ## Common Components With the necessary dependencies now installed, you can now install the essential Nephio components. This is documented -in the [common components documentation](content/en/docs/guides/install-guides/common-components.md). +in the [common components documentation](/content/en/docs/guides/install-guides/common-components.md). ## Provisioning Cluster API diff --git a/content/en/docs/guides/install-guides/webui.md b/content/en/docs/guides/install-guides/webui.md index 2fc3b388..953876a7 100644 --- a/content/en/docs/guides/install-guides/webui.md +++ b/content/en/docs/guides/install-guides/webui.md @@ -54,8 +54,8 @@ service). Configuring authentication for the WebUI is very 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) -- [OIDC with Okta](content/en/docs/guides/install-guides/webui-auth-okta.md) +- [Google OAuth or OIDC](/content/en/docs/guides/install-guides/webui-auth-gcp.md) +- [OIDC with Okta](/content/en/docs/guides/install-guides/webui-auth-okta.md) Once that configuration is updated, you can proceed with the installation (note, this uses `inventory-policy=adopt`, since in the previous steps we may have created the namespace already). diff --git a/content/en/docs/guides/user-guides/_index.md b/content/en/docs/guides/user-guides/_index.md index 3682854a..43b65121 100644 --- a/content/en/docs/guides/user-guides/_index.md +++ b/content/en/docs/guides/user-guides/_index.md @@ -334,6 +334,6 @@ workaround scripts. Also, please see the Release Notes ## Next Steps -* Learn more about the Nephio [controllers](content/en/docs/guides/user-guides/controllers.md) -* Learn more about how packages are [transformed](content/en/docs/guides/install-guides/package-transformations.md) -* Learn more about [deploying helm charts](content/en/docs/guides/user-guides/helm/_index.md) in Nephio +* Learn more about the Nephio [controllers](/content/en/docs/guides/user-guides/controllers.md) +* Learn more about how packages are [transformed](/content/en/docs/guides/install-guides/package-transformations.md) +* Learn more about [deploying helm charts](/content/en/docs/guides/user-guides/helm/_index.md) in Nephio diff --git a/content/en/docs/guides/user-guides/exercise-1-free5gc.md b/content/en/docs/guides/user-guides/exercise-1-free5gc.md index fbd5790d..b41409e8 100644 --- a/content/en/docs/guides/user-guides/exercise-1-free5gc.md +++ b/content/en/docs/guides/user-guides/exercise-1-free5gc.md @@ -20,7 +20,7 @@ weight: 2 ## Introduction -Be sure you have followed the [installation guide](content/en/docs/guides/install-guides/_index.md) +Be sure you have followed the [installation guide](/content/en/docs/guides/install-guides/_index.md) before trying these exercises. These exercises will take you from a system with only the Nephio Management cluster setup to a deployment with: @@ -995,7 +995,7 @@ commits to see how Porch interacts with packages stored in Git repositories. ![Commits in Gitea made by porch](/images/user-guides/gitea-porch.png) After the package is approved, the results can be observed in Nephio Web UI. Head over to http://localhost:7007/config-as-data -([port forwarding](content/en/docs/guides/install-guides/_index.md#access-to-the-user-interfaces) must be running). +([port forwarding](/content/en/docs/guides/install-guides/_index.md#access-to-the-user-interfaces) must be running). ![Deployments in Nephio UI](/images/user-guides/UPF-Capacity.png) diff --git a/content/en/docs/guides/user-guides/exercise-2-oai.md b/content/en/docs/guides/user-guides/exercise-2-oai.md index 1824201a..2292dc75 100644 --- a/content/en/docs/guides/user-guides/exercise-2-oai.md +++ b/content/en/docs/guides/user-guides/exercise-2-oai.md @@ -19,7 +19,7 @@ weight: 2 ## Introduction -Be sure you have followed the [installation guide](content/en/docs/guides/install-guides/_index.md) +Be sure you have followed the [installation guide](/content/en/docs/guides/install-guides/_index.md) before trying these exercises. These exercises will take you from a system with only the Nephio Management cluster setup to a deployment with: diff --git a/content/en/docs/guides/user-guides/helm/_index.md b/content/en/docs/guides/user-guides/helm/_index.md index 7e4900ee..f4f78d1d 100644 --- a/content/en/docs/guides/user-guides/helm/_index.md +++ b/content/en/docs/guides/user-guides/helm/_index.md @@ -16,6 +16,6 @@ for deploying on Kubernetes, legacy helm support will be required for a number o ### Deployment options -* [Using Flux CD](content/en/docs/guides/user-guides/helm/flux-helm.md) +* [Using Flux CD](/content/en/docs/guides/user-guides/helm/flux-helm.md) * [Operator SDK](https://sdk.operatorframework.io/docs/building-operators/helm/) diff --git a/content/en/docs/guides/user-guides/helm/flux-helm.md b/content/en/docs/guides/user-guides/helm/flux-helm.md index af8ca470..4905c960 100644 --- a/content/en/docs/guides/user-guides/helm/flux-helm.md +++ b/content/en/docs/guides/user-guides/helm/flux-helm.md @@ -17,10 +17,10 @@ Then, we can utilize the flux Custom Resources defined in another test kpt packa ## Prerequisites: * [Nephio R1 sandbox]/content/en/docs/guides/install-guides/install-guides/_index.md): Set up the Nephio sandbox environment. -* [Access to the Nephio Web UI](content/en/docs/guides/install-guides/_index.md#access-to-the-user-interfaces) -* [Nephio R1 sandbox workload clusters](content/en/docs/guides/user-guides/exercise-1-free5gc.md): +* [Access to the Nephio Web UI](/content/en/docs/guides/install-guides/_index.md#access-to-the-user-interfaces) +* [Nephio R1 sandbox workload clusters](/content/en/docs/guides/user-guides/exercise-1-free5gc.md): Create/Deploy the predefined set of workload clusters by completing the Free5GC Core quick start exercises up to and including - [Step 3](content/en/docs/guides/user-guides/exercise-1-free5gc.md#step-3-deploy-two-edge-clusters). + [Step 3](/content/en/docs/guides/user-guides/exercise-1-free5gc.md#step-3-deploy-two-edge-clusters). ### Deploying the flux-helm-controllers pkg diff --git a/resources.md b/resources.md index 9050c2c8..a1ba9a8a 100644 --- a/resources.md +++ b/resources.md @@ -46,7 +46,7 @@ More tutorials are under discussion in * [SIG Release Meeting playlist](https://www.youtube.com/playlist?list=PLiW9_IXAWtks9Ys4Zs6wPRNEuQYAnWcg1) ## Other Resources -* The [Glossary](content/en/docs/glossary.md) defines common terminology used in the Nephio +* The [Glossary](/content/en/docs/glossary.md) defines common terminology used in the Nephio project. * The [Nephio Learning Resources page](learning.md) lists some learning resources that are useful for the Nephio community -* The [Abbreviation Decoder page](content/en/docs/abbreviations.md) explains common abbreviations used in the project. +* The [Abbreviation Decoder page](/content/en/docs/abbreviations.md) explains common abbreviations used in the project. From ff91a4c94cfd6c9abac2d9d96adbc25e84d13d3c Mon Sep 17 00:00:00 2001 From: liamfallon Date: Thu, 1 Feb 2024 16:20:07 +0000 Subject: [PATCH 29/29] Added documentation FAQ --- .../en/docs/guides/contributor-guides/doc-faq.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) create mode 100644 content/en/docs/guides/contributor-guides/doc-faq.md diff --git a/content/en/docs/guides/contributor-guides/doc-faq.md b/content/en/docs/guides/contributor-guides/doc-faq.md new file mode 100644 index 00000000..74495cb0 --- /dev/null +++ b/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 + ``` \ No newline at end of file