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

Correction of links #90

Merged
merged 35 commits into from
Jan 31, 2024
Merged
Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
97bf6f1
Add linkcheck for plan md files
CsatariGergely Jan 23, 2024
e6adf7f
Add linkspector config file
CsatariGergely Jan 23, 2024
5bc497c
Add verification for the linkspector config file
CsatariGergely Jan 23, 2024
e1cc928
Ignoring localhost links
CsatariGergely Jan 24, 2024
9518c65
Fixing yaml error
CsatariGergely Jan 24, 2024
20f6244
Add HOSTNAME to ignore list
CsatariGergely Jan 24, 2024
25dcc33
Addig 302 as active status code
CsatariGergely Jan 24, 2024
cd2f753
Ignoring the wiki link :(
CsatariGergely Jan 24, 2024
269eb39
Correction of links
CsatariGergely Jan 24, 2024
a26baf0
Merge branch 'main' into correction-of-links
CsatariGergely Jan 24, 2024
e4f9b03
Change owners (#92)
liamfallon Jan 24, 2024
9629959
Removing unecesary ignore link
CsatariGergely Jan 25, 2024
b4fc452
Fixing broken links in glossary
CsatariGergely Jan 25, 2024
426f5a0
Merge branch 'correction-of-links' of github.com:nokia/nephio-docs in…
CsatariGergely Jan 25, 2024
364bf24
Update openstack documentation (#81)
lapentad Jan 25, 2024
cc244ab
Adding footer with Code of Conduct and Netlify (#83)
CsatariGergely Jan 25, 2024
086fbbc
Add efiacor to approvers section (#94)
efiacor Jan 25, 2024
da41955
Fixing typo in the footer (#96)
CsatariGergely Jan 26, 2024
4be361c
reordering installation guides (#87)
spaitsbence Jan 26, 2024
2d9a3f3
Revert inadvertent check in of file to documentation (#93)
liamfallon Jan 26, 2024
7365ed2
Updating docs for R2 (#85)
arora-sagar Jan 29, 2024
ce39c8b
Update Sandbox R2 documentation (#95)
electrocucaracha Jan 29, 2024
a0d97a8
Update content/en/docs/guides/install-guides/install-on-byoc.md
CsatariGergely Jan 30, 2024
9601101
Fixing relative links
CsatariGergely Jan 30, 2024
b1b2cf3
Merge pull request #91 from nokia/add-linkcheck
tliron Jan 30, 2024
5c06bfd
Remove documentation typos (#98)
electrocucaracha Jan 30, 2024
0635574
Fix exercise links (#99)
liamfallon Jan 30, 2024
60878b4
Adding Controller user's guide (#77)
CsatariGergely Jan 31, 2024
7f42d65
Correction of links
CsatariGergely Jan 24, 2024
c2c1000
Fixing broken links in glossary
CsatariGergely Jan 25, 2024
7392ddf
Update content/en/docs/guides/install-guides/install-on-byoc.md
CsatariGergely Jan 30, 2024
9d1c741
Fixing relative links
CsatariGergely Jan 30, 2024
bd8fb04
Adding a link to the controllers user guide
CsatariGergely Jan 31, 2024
37fd73e
Merge branch 'correction-of-links' of github.com:nokia/nephio-docs in…
CsatariGergely Jan 31, 2024
3b4decd
Fixing links
CsatariGergely Jan 31, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ different aspects of R1.
## 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 inofrmation 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 %}}


Expand Down
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
CsatariGergely marked this conversation as resolved.
Show resolved Hide resolved
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
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we need to keep a link here?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes and no :)
Yes, in the final documentation we need a link there.
But I forgot tho move the controllers.md file and the link is broken now.
I move back the file and restore the link in #77

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But I forgot tho move the controllers.md file and the link is broken now.

OK, I'll check on #77 and see if we can get it merged.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

But I forgot tho move the controllers.md file and the link is broken now.

OK, I'll check on #77 and see if we can get it merged.

#77 is merged now so maybe we can fix the link.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've rebased 60878b4 and a couple other commits (plus fixed some new link errors :))

* 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
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.