Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Clean up doc structure #191

Merged
merged 11 commits into from
Dec 4, 2024
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,8 +14,8 @@ the Markdown files hosted in the GitHub repo to generate the documentation websi

### Setting up the environment

1. The site is using Hugo as the documentation generating engine and as Hugo depends on Go in mudule handling you need to
have Go installed on your computer. Most Linux distributions have Go preinstalled, but some of them have a verstion that is too old
1. The site is using Hugo as the documentation generating engine and as Hugo depends on Go in module handling you need to
have Go installed on your computer. Most Linux distributions have Go preinstalled, but some of them have a version that is too old
for Hugo. You should have at least version 1.18.0. You can install version 1.18 of go on an Ubuntu using the
following commands:

Expand Down
24 changes: 0 additions & 24 deletions content/en/docs/abbreviations.md

This file was deleted.

2 changes: 1 addition & 1 deletion content/en/docs/apis/porch/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ type: docs
weight: 5
description: Reference for the Nephio Porch APIs
---
{{< iframe src="https://doc.crds.dev/github.com/nephio-project/porch@v2.0.0" sub="https://doc.crds.dev/github.com/nephio-project/porch@v2.0.0">}}
{{< iframe src="https://doc.crds.dev/github.com/nephio-project/porch@v3.0.4" sub="https://doc.crds.dev/github.com/nephio-project/porch@v3.0.4">}}
2 changes: 1 addition & 1 deletion content/en/docs/apis/topology-and-networking/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,4 +4,4 @@ type: docs
weight: 5
description: Reference for the Nephio Topology and Networking APIs
---
{{< iframe src="https://doc.crds.dev/github.com/nephio-project/api@v2.0.0" sub="https://doc.crds.dev/github.com/nephio-project/api@v2.0.0">}}
{{< iframe src="https://doc.crds.dev/github.com/nephio-project/api@v3.0.0" sub="https://doc.crds.dev/github.com/nephio-project/api@v3.0.0">}}
efiacor marked this conversation as resolved.
Show resolved Hide resolved
Original file line number Diff line number Diff line change
@@ -1,14 +1,15 @@
---
title: Glossary
title: Glossary and Abbreviations
description:
weight: 4
weight: 10
---

We use many terms in our Nephio discussions, coming from different domains
including telecom, Kubernetes, configuration management, and our own
Nephio-specific terms. This glossary is intended to help clarify our usage of
[Nephio-specific](#nephio-related-abbreviations) terms. This glossary is intended to help clarify our usage of
these terms.


## Config
See [Configuration](#configuration).

Expand Down Expand Up @@ -369,3 +370,20 @@ configuration at scale.

A workload is any application running on Kubernetes, including network
functions.


## Nephio Related Abbreviations
* NF: Network Function
efiacor marked this conversation as resolved.
Show resolved Hide resolved
* PV: Package Variant
* PVS: Package Variant Set

## 5G 3GPP Related Abbreviations
* AMF: Access and Mobility Management Function
* SMF: Session Management Function
* UPF: User Plane Function
* AUSF: Authentication Server Function
* NRF: Network Repository Function
* UDR: Unified Data Repository
* UDM: Unified Data Management
* DNN: Data Network Name
* NAD: Network Attachment Definition
efiacor marked this conversation as resolved.
Show resolved Hide resolved
2 changes: 1 addition & 1 deletion content/en/docs/guides/install-guides/common-components.md
Original file line number Diff line number Diff line change
Expand Up @@ -118,4 +118,4 @@ kpt live apply stock-repos --reconcile-timeout=15m --output=table
## WebUI (Optional)

Nephio WebUI is optional and to install it you can follow this
[document](/content/en/docs/guides/install-guides/webui.md)
[document](/content/en/docs/guides/install-guides/web-ui/_index.md)
Original file line number Diff line number Diff line change
Expand Up @@ -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](../../glossary-abbreviations#operator) and
efiacor marked this conversation as resolved.
Show resolved Hide resolved
[Controller](../../glossary-abbreviations#controller) and
efiacor marked this conversation as resolved.
Show resolved Hide resolved
[CR](../../glossary-abbreviations#custom-resource) have already been explained here.
efiacor marked this conversation as resolved.
Show resolved Hide resolved

## Deploy the operator to the cluster

Expand Down
4 changes: 2 additions & 2 deletions content/en/docs/guides/install-guides/install-on-byoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -136,8 +136,8 @@ 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/web-ui/webui-auth-gcp.md)
- [OIDC with Okta](/content/en/docs/guides/install-guides/web-ui/webui-auth-okta.md)

### Nephio Stock Repositories

Expand Down
6 changes: 3 additions & 3 deletions content/en/docs/guides/install-guides/install-on-gcp.md
Original file line number Diff line number Diff line change
Expand Up @@ -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/web-ui/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/web-ui/webui-auth-gcp.md#creating-an-oauth-20-client-id)
and the [secret](/content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md#create-the-secret-in-the-cluster)
manually.

The *nephio-webui* subpackage in *nephio-mgmt* is already set up for
Expand Down
Original file line number Diff line number Diff line change
@@ -1,17 +1,10 @@
---
title: Install WebUI
title: Installing the WebUI
description: >
These instructions explain how to install the Nephio WebUI.
weight: 6
These instructions explain how to install and configure the Nephio WebUI.
weight: 2
---

{{% pageinfo %}}
This page is draft and the separation of the content to different categories is not clear.
{{% /pageinfo %}}


## Nephio WebUI

To install the WebUI, we simply install a different *kpt* package. First, we pull the package locally:

```bash
Expand Down Expand Up @@ -54,8 +47,8 @@ service).
Configuring authentication for the WebUI is specific to the particular cluster environment. Guides for different
environments are below:

- [Google OAuth or OIDC](/content/en/docs/guides/install-guides/webui-auth-gcp.md)
- [OIDC with Okta](/content/en/docs/guides/install-guides/webui-auth-okta.md)
- [Google OAuth or OIDC](/content/en/docs/guides/install-guides/web-ui/webui-auth-gcp.md)
- [OIDC with Okta](/content/en/docs/guides/install-guides/web-ui/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).
Expand Down
3 changes: 1 addition & 2 deletions resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ 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 & Abbreviations](content/en/docs/glossary-abbreviations) defines common terminology used in the Nephio
efiacor marked this conversation as resolved.
Show resolved Hide resolved
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.
Loading