Skip to content

Commit 3432bd5

Browse files
new main page (#412)
* new main page * amending comments
1 parent 43e2b79 commit 3432bd5

2 files changed

Lines changed: 48 additions & 22 deletions

File tree

docs/content/en/_index.md

Lines changed: 46 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -1,43 +1,69 @@
11
---
2-
title: Start
3-
description: Documentation of the Nephio project
2+
title: Porch
3+
description: Kubernetes-native package orchestration for KRM configuration packages
44
menu: {main: {weight: 10}}
55
---
6-
{{< blocks/cover title="Welcome to the Nephio documentation" image_anchor="top" height="full" >}}
7-
<a class="btn btn-lg btn-primary me-3 mb-4" href="https://nephio.org/">
8-
Homepage <i class="fas fa-arrow-alt-circle-right ms-2"></i>
6+
{{< blocks/cover title="Porch" height="auto">}}
7+
<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs/1_overview/">
8+
Documentation (Under Construction) <i class="fas fa-arrow-alt-circle-right ms-2"></i>
99
</a>
10-
<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/nephio-project">
10+
<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://github.com/nephio-project/porch">
1111
GitHub <i class="fab fa-github ms-2 "></i>
1212
</a>
13-
<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs/">
14-
Documentation <i class="fas fa-arrow-alt-circle-right ms-2"></i>
13+
<a class="btn btn-lg btn-primary me-3 mb-4" href="/docs/3_getting_started/">
14+
Install Porch <i class="fas fa-download ms-2"></i>
1515
</a>
1616

17-
<p class="lead mt-5">Cloud Native Network Automation</p>
18-
{{< blocks/link-down color="primary" >}}
17+
<p class="lead mt-5">Kubernetes-native API for managing KRM configuration packages</p>
1918

2019
{{< /blocks/cover >}}
2120

2221
{{% blocks/lead color="primary" %}}
23-
[Nephio project's](https://nephio.org) mission is "to deliver carrier-grade, simple, open, Kubernetes-based cloud native intent automation and
24-
common automation templates that materially simplify the deployment and management of multi-vendor cloud infrastructure
25-
and network functions across large scale edge deployments."
22+
Porch is a Kubernetes extension apiserver that manages the lifecycle of KRM configuration packages in Git repositories.
23+
It provides package operations through Kubernetes resources, enabling GitOps workflows with approval gates, automation, and collaboration.
2624
{{% /blocks/lead %}}
2725

2826
{{% blocks/section type="row" %}}
2927

30-
{{% blocks/feature icon="fas fa-rocket" title="R3" %}}
31-
Welcome to the Release 3 of Nephio. This release is under ongoing development together with its documentation. It is
32-
possible to experience some incompleteness ;)
28+
{{% blocks/feature icon="fab fa-git-alt" title="GitOps Native" %}}
29+
All package changes are committed to Git with full history. Works seamlessly with Config Sync, Flux, and other GitOps tools.
3330
{{% /blocks/feature %}}
3431

35-
{{% blocks/feature icon="fab fa-wikipedia-w" title="Wiki" %}}
36-
Mass amount of developer information is available in the [wiki](https://wiki.nephio.org/).
32+
{{% blocks/feature icon="fas fa-check-circle" title="Approval Workflows" %}}
33+
Packages move through lifecycle stages (Draft → Proposed → Published) with explicit approval gates to prevent accidental changes.
3734
{{% /blocks/feature %}}
3835

39-
{{% blocks/feature icon="fas fa-balance-scale-right" title="Charter" %}}
40-
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).
36+
{{% blocks/feature icon="fas fa-cube" title="Standard kpt Packages" %}}
37+
Manages standard kpt packages with no vendor lock-in. Packages can be edited through Porch or directly in Git.
4138
{{% /blocks/feature %}}
4239

4340
{{% /blocks/section %}}
41+
42+
{{% blocks/section type="row" %}}
43+
44+
{{% blocks/feature icon="fas fa-code-branch" title="Package Cloning & Upgrades" %}}
45+
Clone packages from upstream sources and automatically upgrade when new versions are published. Three-way merge handles local customizations.
46+
{{% /blocks/feature %}}
47+
48+
{{% blocks/feature icon="fas fa-cogs" title="Function Execution" %}}
49+
Apply krm functions to transform and validate packages. Functions run in isolated containers with results tracked in package history.
50+
{{% /blocks/feature %}}
51+
52+
{{% blocks/feature icon="fas fa-sync" title="Multi-Repository" %}}
53+
Manage packages across multiple Git repositories from a single control plane. Controllers automate cross-repository operations.
54+
{{% /blocks/feature %}}
55+
56+
{{% /blocks/section %}}
57+
58+
{{% blocks/section color="primary" %}}
59+
60+
## Part of the Nephio Project
61+
62+
Porch was originally developed in the [kpt project](https://github.com/kptdev/kpt) and donated to [Nephio](https://nephio.org) in December 2023.
63+
It is maintained by the Nephio community and continues to evolve as a key component for configuration-as-data workflows.
64+
65+
<a class="btn btn-lg btn-secondary me-3 mb-4" href="https://nephio.org/">
66+
Learn about Nephio <i class="fas fa-arrow-alt-circle-right ms-2"></i>
67+
</a>
68+
69+
{{% /blocks/section %}}

docs/layouts/partials/footer.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -22,10 +22,10 @@
2222
<small class="text-white">&copy; {{ now.Year }} {{ .Site.Params.copyright }}</small>
2323
</p>
2424
<p>
25-
<small class="text-white">Nephio follows <a href="{{ .Site.Params.code_of_conduct }}" target="_blank" rel="noopener">The Linux Foundation's Code of Conduct</a>.</small>
25+
<small class="text-white">Porch follows <a href="{{ .Site.Params.code_of_conduct }}" target="_blank" rel="noopener">The Linux Foundation's Code of Conduct</a>.</small>
2626
</p>
2727
<p>
28-
<small class="text-white">Nephio documentation is built with the <a href="https://www.docsy.dev/">Docsy</a> <a href="https://gohugo.io/">Hugo</a> theme and deployed to Netlify.</small>
28+
<small class="text-white">Porch documentation is built with the <a href="https://www.docsy.dev/">Docsy</a> <a href="https://gohugo.io/">Hugo</a> theme and deployed to Netlify.</small>
2929
</br>
3030
<a href="https://www.netlify.com"> <img src="https://www.netlify.com/v3/img/components/netlify-color-bg.svg" alt="Deploys by Netlify" /> </a>
3131
</p>

0 commit comments

Comments
 (0)