Skip to content

Commit

Permalink
Correction of links (#90)
Browse files Browse the repository at this point in the history
I'm working on a pr to build automatic link checking. During the testing
of it I had to correct a couple of links...

---------

Signed-off-by: Gergely Csatari <gergely.csatari@nokia.com>
Signed-off-by: Victor Morales <v.morales@samsung.com>
Co-authored-by: Liam Fallon <35595825+liamfallon@users.noreply.github.com>
Co-authored-by: Lapenta Francesco Davide <37077655+lapentad@users.noreply.github.com>
Co-authored-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
Co-authored-by: spaitsbence <153498430+spaitsbence@users.noreply.github.com>
Co-authored-by: Sagar Arora <74044881+arora-sagar@users.noreply.github.com>
Co-authored-by: Victor Morales <v.morales@samsung.com>
Co-authored-by: Tal Liron <tliron@google.com>
  • Loading branch information
8 people committed Jan 31, 2024
1 parent 60878b4 commit f6edaa2
Show file tree
Hide file tree
Showing 9 changed files with 36 additions and 28 deletions.
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,13 @@ different aspects of R1.
## User Documentation
* [Release Notes](/content/en/docs/release-notes)
* [Demo Sandbox Environment Installation](/content/en/docs/guides/install-guides/_index.md)
* [Quick Start Exercises](/content/en/docs/guides/user-guides/exercises.md)
* [Quick Start Exercises](/content/en/docs/guides/user-guides/_index.md)
* [User Guide](/content/en/docs/guides/user-guides/_index.md)

## Other Documentation

* [Developer Documentation](https://github.com/nephio-project/nephio)
* [Developer Guide](/content/en/docs/guides/contributor-guides)
* [Developer Guide](/content/en/docs/guides/contributor-guides/_index.md)
* [Project Resources](https://github.com/nephio-project/docs/blob/main/resources.md)

## About Nephio R1
Expand Down
4 changes: 2 additions & 2 deletions content/en/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ menu: {main: {weight: 10}}
{{% blocks/lead color="primary" %}}
[Nephio project's](https://nephio.org) mission is "to deliver carrier-grade, simple, open, Kubernetes-based cloud native intent automation and
common automation templates that materially simplify the deployment and management of multi-vendor cloud infrastructure
and network functions across large scale edge deployments."
and network functions across large scale edge deployments."
{{% /blocks/lead %}}

{{% blocks/section type="row" %}}
Expand All @@ -38,7 +38,7 @@ Mass amount of developer information is available in the [wiki](https://wiki.nep
{{% /blocks/feature %}}

{{% blocks/feature icon="fas fa-balance-scale-right" title="Charter" %}}
Technical charter of the project can be found [here](https://nephio.org/wp-content/uploads/sites/6/2022/06/Nephio-Project-Technical-Charter-Amended-6-9-2022.pdf).
Technical charter of the project can be found [here](https://github.com/nephio-project/governance/blob/main/nephio-technical-charter-amended-2022-06-22.pdf).
{{% /blocks/feature %}}

{{% /blocks/section %}}
21 changes: 15 additions & 6 deletions content/en/docs/glossary.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,20 @@ vendors enable KRM-based management of this internal configuration, to allow
leveraging all the techniques we are building for KRM-based configuration (this
is part of the "Kubernetes Everywhere" principle).

As a community, we should try to use a common set of terminology for different
types of configuration. See
[docs#4](https://github.com/nephio-project/docs/issues/4).
As a community, we should try to use a common set of terminology for different types of configuration. See
[docs#4](https://github.com/nephio-project/nephio/issues/266).

## Config Injection
See [Injector](#injector).

## Controller
This term comes from Kubernetes where [controller](https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-controller) is defined as a control loop that watches the intended and actual state of the cluster, and attempts to make changes as needed to make the actual state match the intended state. More specifically, this typically refers to software that processes Kubernetes Resources residing in the Kubernetes API server, and either transforms them into new resources, or calls to other APIs that change the state of some entity external to the API server. For example, `kubelet` itself is a controller that processes Pod resources to create and manage containers on a Node.
This term comes from Kubernetes where
[controller](https://kubernetes.io/docs/reference/glossary/?fundamental=true#term-controller) is defined as a control
loop that watches the intended and actual state of the cluster, and attempts to make changes as needed to make the
actual state match the intended state. More specifically, this typically refers to software that processes Kubernetes
Resources residing in the Kubernetes API server, and either transforms them into new resources, or calls to other APIs
that change the state of some entity external to the API server. For example, `kubelet` itself is a controller that
processes Pod resources to create and manage containers on a Node.

*See also*: [Operator](#operator), [Injector](#injector), [KRM
function](#krm-function), [Specializer](#specializer)
Expand Down Expand Up @@ -339,8 +344,12 @@ we may build new types of variant generators, and may even compose them (for
example, to produce variants that are affected by both environment and cluster).

## WET
This term, which we use as an acronym for "Write Every Time", comes from [software
engineering](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself#WET), and is a somewhat pejorative term in contrast to [DRY](#dry). However, in the context of *configuration-as-data*, rather than *code*, the idea of storing the configuration as fully-formed data enables automation and the use of data-management techniques to manage the configuration at scale.

This term, which we use as an acronym for "Write Every Time", comes from
[software engineering](https://en.wikipedia.org/wiki/Don%27t_repeat_yourself), and is a somewhat pejorative term in
contrast to [DRY](#dry). However, in the context of *configuration-as-data*, rather than *code*, the idea of storing the
configuration as fully-formed data enables automation and the use of data-management techniques to manage the
configuration at scale.

*See also*: [DRY](#dry), [Hydration](#hydration)

Expand Down
10 changes: 5 additions & 5 deletions content/en/docs/guides/install-guides/install-on-byoc.md
Original file line number Diff line number Diff line change
Expand Up @@ -115,11 +115,11 @@ Flux or ArgoCD to apply packages to the clusters.
R1 uses Cluster API, but other options may be used such as Crossplane, Google
KCC, or AWS Controllers for Kubernetes. You can provision more than one.

| Provider | Notes |
| --------------------------- | --------------------------------------------------------------------------------------- |
| [Cluster API](capi.md) | Kubernetes project cluster provisioner for a variety of cluster providers. |
| [KCC](kcc.md) | Google's Kubernetes Config Connector for GKE clusters and other GCP resources. |
| [Crossplane](crossplane.md) | API composition framework with cluster and other infrastructure providers. |
| Provider | Notes |
| ----------- | --------------------------------------------------------------------------------------- |
| [Cluster API](https://cluster-api.sigs.k8s.io/) | Kubernetes project cluster provisioner for a variety of cluster providers. |
| [KCC](https://cloud.google.com/config-connector/docs/overview) | Google's Kubernetes Config Connector for GKE clusters and other GCP resources. |
| [Crossplane](https://docs.crossplane.io/latest/getting-started/introduction/) | API composition framework with cluster and other infrastructure providers. |

### Load Balancer

Expand Down
2 changes: 1 addition & 1 deletion content/en/docs/guides/install-guides/webui-auth-okta.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ In the secret, use these keys:
| -------------- | ----------------------------------------------------------- |
| client-id | The client ID that you generated on Okta, e.g. 3abe134ejxzF21HU74c1 |
| client-secret | The client secret shown for the Application. |
| audience | The Okta domain shown for the Application, e.g. https://company.okta.com |
| audience | The Okta domain shown for the Application, e.g. https://www.okta.com/company/ |
| auth-server-id | The authorization server ID for the Application (optional) |
| idp | The identity provider for the application, e.g. 0oaulob4BFVa4zQvt0g3 (optional) |

Expand Down
7 changes: 3 additions & 4 deletions content/en/docs/guides/user-guides/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -329,12 +329,11 @@ The diagram below depicts deployment at the high level.
## Troubleshooting and Workarounds

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).
workaround scripts. Also, please see the Release Notes
[known issues]({{< relref "../../release-notes/r1#known-issues-and-workarounds">}}).

## Next Steps

* Learn more about the Nephio
[controllers](https://github.com/nephio-project/docs/blob/main/user-guide/controllers.md)
* 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
11 changes: 6 additions & 5 deletions content/en/docs/guides/user-guides/exercise-1-free5gc.md
Original file line number Diff line number Diff line change
Expand Up @@ -91,11 +91,12 @@ regional git Package true True http://172.18.
```
</details>

Since those are Ready, you can deploy a package from the [catalog-infra-capi](https://github.com/nephio-project/catalog/infra/capi)
repository into the mgmt repository. To do this, you retrieve the Package Revision name using `kpt alpha rpkg get`,
clone that specific Package Revision via the `kpt alpha rpkg clone` command, then propose and approve the resulting
package revision. You want to use the latest revision of the nephio-workload-cluster package, which you can get with the
command below (your latest revision may be different):
Since those are Ready, you can deploy a package from the
[catalog-infra-capi](https://github.com/nephio-project/catalog/tree/main/infra/capi) repository into the mgmt
repository. To do this, you retrieve the Package Revision name using `kpt alpha rpkg get`, clone that specific Package
Revision via the `kpt alpha rpkg clone` command, then propose and approve the resulting package revision. You want to
use the latest revision of the nephio-workload-cluster package, which you can get with the command below (your latest
revision may be different):

```bash
kpt alpha rpkg get --name nephio-workload-cluster
Expand Down
1 change: 0 additions & 1 deletion learning.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,6 @@
* [Build a Kubernetes Operator in Six Steps](https://developers.redhat.com/articles/2021/09/07/build-kubernetes-operator-six-steps): Howto article from Red Hat
* [How to Build a Kubernetes Operator](https://www.techtarget.com/searchitoperations/tutorial/How-to-build-a-Kubernetes-operator): Howto article from TechTarget
* [Kopf: Kubernetes Operators Framework](https://kopf.readthedocs.io/en/stable/): A framework for writing Kubernetes Operators in python
* [Creating Custom Resources in Kubernetes 1](https://www.pluralsight.com/courses/kubernetes-creating-custom-resources): Subscription required (with initial free trial) but helpful for writing CR/CRD/Operators

## KPT

Expand Down
4 changes: 2 additions & 2 deletions resources.md
Original file line number Diff line number Diff line change
Expand Up @@ -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](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](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.

0 comments on commit f6edaa2

Please sign in to comment.