Skip to content

Commit

Permalink
Merge pull request #50 from johnbelamaric/r101-prep
Browse files Browse the repository at this point in the history
Improve landing page
  • Loading branch information
johnbelamaric authored Aug 2, 2023
2 parents 806291b + 9a0d5fb commit 1345d14
Showing 1 changed file with 32 additions and 25 deletions.
57 changes: 32 additions & 25 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,39 @@
# Nephio R1

## Introduction
Welcome to the R1 release of Nephio. Please use the documenation links below to
learn more about Nephio R1, or checkout our [Learning Nephio with
R1](https://wiki.nephio.org/display/HOME/Learning+with+Nephio+R1) series, which
includes a [demo video](https://youtu.be/mFl71sy2Pdc) and short articles about
different aspects of R1.

Welcome to the R1 release of Nephio. Our 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." But what does that mean? With this release and
the accompanying documentation, we hope to make that clear.
## User Documentation
* [Release Notes](https://github.com/nephio-project/docs/blob/main/release-notes/README.md)
* [Demo Sandbox Environment Installation](https://github.com/nephio-project/docs/blob/main/install-guide/README.md)
* [Quick Start Exercises](https://github.com/nephio-project/docs/blob/main/user-guide/exercises.md)
* [User Guide](https://github.com/nephio-project/docs/blob/main/user-guide/README.md)

## Other Documentation

* [Developer Documentation](https://github.com/nephio-project/nephio)
* [Project Resources](https://github.com/nephio-project/docs/blob/main/resources.md)

## About Nephio R1

Our 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." But what does that mean?
With this release and the accompanying documentation, we hope to make that
clear.

The mission outlines the basic goals and the [About Nephio page](https://nephio.org/about/)
describes the high-level architecture of Nephio. It is important to understand that Nephio is about managing complex, inter-related workloads
*at scale*. If we simply want to deploy a network function, existing methods
like Helm charts and scripts are sufficient. Similarly, if we want to deploy
some infrastructure, then using existing Infrastructure-as-Code tools can
accomplish that. Configuring running network functions can already be done today
with element managers.
The mission outlines the basic goals and the [About Nephio
page](https://nephio.org/about/) describes the high-level architecture of
Nephio. It is important to understand that Nephio is about managing complex,
inter-related workloads *at scale*. If we simply want to deploy a network
function, existing methods like Helm charts and scripts are sufficient.
Similarly, if we want to deploy some infrastructure, then using existing
Infrastructure-as-Code tools can accomplish that. Configuring running network
functions can already be done today with element managers.

So, why do we need Nephio? The problems Nephio wants to solve start only
once we try to operate at scale. "Scale" here does not simply mean "large number
Expand Down Expand Up @@ -88,14 +106,3 @@ purposes, the exact same principles and even code can be used for managing other
infrastructure and network functions. The *uniformity in systems* principle
means that as long as something is manageable via the Kubernetes Resource Model,
it is manageable via Nephio.

## User Documentation
* [Release Notes](https://github.com/nephio-project/docs/blob/main/release-notes/README.md)
* [Demo Sandbox Environment Installation](https://github.com/nephio-project/docs/blob/main/install-guide/README.md)
* [Quick Start Exercises](https://github.com/nephio-project/docs/blob/main/user-guide/exercises.md)
* [User Guide](https://github.com/nephio-project/docs/blob/main/user-guide/README.md)

## Other Documentation

* [Developer Documentation](https://github.com/nephio-project/nephio)
* [Project Resources](https://github.com/nephio-project/docs/blob/main/resources.md)

0 comments on commit 1345d14

Please sign in to comment.