repository doc example #278

lapentad · 2025-10-21T12:31:52Z

examples to register repositories for the example series.

NOTE: I did not add any sync information

nephio-prow · 2025-10-21T12:31:56Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
Once this PR has been reviewed and has the lgtm label, please assign liamfallon for approval by writing /assign @liamfallon in a comment. For more information see the Kubernetes Code Review Process.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

OWNERS

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

netlify · 2025-10-21T12:32:32Z

✅ Deploy Preview for nephio ready!

Name	Link
🔨 Latest commit	`b40c858`
🔍 Latest deploy log	https://app.netlify.com/projects/nephio/deploys/6904c4f20335e20008df3657
😎 Deploy Preview	https://deploy-preview-278--nephio.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md

content/en/docs/neo-porch/4_tutorials_&_how-tos/setting-up-repositories.md

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md

content/en/docs/neo-porch/4_tutorials_&_how-tos/setting-up-repositories.md

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md

Signed-off-by: lapentafd <[email protected]>

…ositories.md Co-authored-by: Fiachra Corcoran <[email protected]>

Signed-off-by: lapentafd <[email protected]>

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md

…epositories.md Co-authored-by: Catalin Stratulat <[email protected]>

Signed-off-by: lapentafd <[email protected]>

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md

Signed-off-by: lapentafd <[email protected]>

…epositories.md Co-authored-by: Catalin Stratulat <[email protected]>

sonarqubecloud · 2025-10-31T14:17:42Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

efiacor · 2025-11-05T09:19:32Z

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md

 ---

-## Lorem Ipsum
+# Setting Up Repositories


This heading can be removed

efiacor · 2025-11-05T09:20:00Z

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md

+# Setting Up Repositories

-tutorial in setting up porch repositories and using them
+Before Porch can manage packages, you must register the Git repositories where those packages are stored. This tells Porch where to find package blueprints and where to store deployment packages.


Do we need a prerequisites section here instead?

efiacor · 2025-11-05T09:21:38Z

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md

+- **Manual — Gitea web UI:** Open your Gitea instance, sign in, and click the **New Repository** (or **+**) button in the top-right of the UI. Follow the form to set the repository name, description, visibility, and initialize the repository. This is the simplest option for one-off repositories.
+- **Automated — API / CLI / script:** Automate repository creation via the Gitea REST API, the `gitea` CLI, or an automation script. The Porch project includes an example automated setup script that demonstrates creating repositories and initializing branches:
+
+[install-dev-gitea-setup.sh](https://github.com/nephio-project/porch/blob/23da894a8ef61fea4a4843294f249c3e1817a104/scripts/install-dev-gitea-setup.sh#L82-L100)


I think if we do reference the automated setup, we should break it out into it's component parts and have it here as part of the tutorial.

efiacor · 2025-11-05T09:23:48Z

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md

+
+You can create repositories in two ways:
+
+- **Manual — Gitea web UI:** Open your Gitea instance, sign in, and click the **New Repository** (or **+**) button in the top-right of the UI. Follow the form to set the repository name, description, visibility, and initialize the repository. This is the simplest option for one-off repositories.


Can be removed. If users can't create a repo then...

efiacor · 2025-11-05T09:28:30Z

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md

+# Setting Up Repositories

-tutorial in setting up porch repositories and using them
+Before Porch can manage packages, you must register the Git repositories where those packages are stored. This tells Porch where to find package blueprints and where to store deployment packages.


We use the term "packages" a lot in the docs. Do we need to point to a "kpt package" definition somewhere just to be clear?
Also, having this as a prerequisite would suffice for me.

A Git repository containing your KPT packages

Or do we have a tutorial to "Set up a Git repo with dummy KPT package".

no i want to veer away from this if possible. we make it extremely clear in the concepts section here

docs/content/en/docs/neo-porch/2_concepts/fundamentals.md

Lines 13 to 19 in 1b63aab

* ***Package***: A package, in Porch, is specifically a [kpt package](https://kpt.dev/) - a collection of related YAML

files including one or more **[KRM resources][krm]** and a [Kptfile](https://kpt.dev/book/02-concepts/#packages).

{{% alert title="N.B." color="warning" %}}

There is no such thing as a "Porch Package" - rather, **Porch stores and orchestrates kpt packages**.

{{% /alert %}}

and soon in the overview also that there is no such thing as porch packages and from that point on packages means kpt packages

i don't think we should foster this. i see it the same way as mentioning configuration as data. having its acronym stated as CaD and from that point on you refer to it as CaD and if someone does not know what that means they should go to its definition rather than carrying the explanation throughout the entire documentation for those who did not read that section. same with stating oci as experimental. we state that once clearly and explain why it is etc and then from that point on we only really mention git repositories.

but thats just my opinion. if people disagree we can have a discussion and change it

efiacor · 2025-11-05T09:29:55Z

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md

+
+Below is a high-level explanation of the steps performed by the automated script when initializing a new Gitea repository for use with Porch. These numbered steps reflect the scripted (API/CLI) approach — you may copy the equivalent commands to run them manually if you prefer.
+
+1. Create the repository via the Gitea REST API


I think this might be a good manual exercise but explicitly using git cli.

nephio-prow bot requested review from liamfallon and timop62 October 21, 2025 12:31

lapentad added the porch-doc-refactor label Oct 22, 2025

lapentad requested review from Catalin-Stratulat-Ericsson and efiacor and removed request for liamfallon and timop62 October 22, 2025 09:59

efiacor reviewed Oct 24, 2025

View reviewed changes

lapentad and others added 3 commits October 28, 2025 12:02

repository doc example

ceb4285

Signed-off-by: lapentafd <[email protected]>

Update content/en/docs/neo-porch/4_tutorials_&_how-tos/setting-up-rep…

db6f02b

…ositories.md Co-authored-by: Fiachra Corcoran <[email protected]>

Update content/en/docs/neo-porch/4_tutorials_&_how-tos/setting-up-rep…

982687c

…ositories.md Co-authored-by: Fiachra Corcoran <[email protected]>

lapentad force-pushed the cli-tutorial-doc branch from 583ea4c to 982687c Compare October 28, 2025 12:02

lapentad added 2 commits October 28, 2025 12:57

removed OCI reference and referenced porchctl api new docs

a49ebbc

Signed-off-by: lapentafd <[email protected]>

used relref

fb1315f

Signed-off-by: lapentafd <[email protected]>

Catalin-Stratulat-Ericsson reviewed Oct 28, 2025

View reviewed changes

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md Outdated Show resolved Hide resolved

Catalin-Stratulat-Ericsson reviewed Oct 28, 2025

View reviewed changes

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md Outdated Show resolved Hide resolved

Catalin-Stratulat-Ericsson reviewed Oct 28, 2025

View reviewed changes

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md Outdated Show resolved Hide resolved

Update content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-r…

af27744

…epositories.md Co-authored-by: Catalin Stratulat <[email protected]>

lapentad force-pushed the cli-tutorial-doc branch from 0146783 to af27744 Compare October 29, 2025 14:57

lapentad added 3 commits October 29, 2025 14:58

removed gitea script and repo flag explaination

0c04e6a

Signed-off-by: lapentafd <[email protected]>

link block script and added explaination for git initialization

7b3020e

Signed-off-by: lapentafd <[email protected]>

moved sections

03c20bf

Signed-off-by: lapentafd <[email protected]>

Catalin-Stratulat-Ericsson reviewed Oct 30, 2025

View reviewed changes

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md Outdated Show resolved Hide resolved

content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md Outdated Show resolved Hide resolved

lapentad and others added 2 commits October 31, 2025 14:16

made steps more precise

18c5604

Signed-off-by: lapentafd <[email protected]>

Update content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-r…

b40c858

…epositories.md Co-authored-by: Catalin Stratulat <[email protected]>

efiacor reviewed Nov 5, 2025

View reviewed changes


		You can create repositories in two ways:

		- Manual — Gitea web UI: Open your Gitea instance, sign in, and click the New Repository (or +) button in the top-right of the UI. Follow the form to set the repository name, description, visibility, and initialize the repository. This is the simplest option for one-off repositories.

	* *Package*: A package, in Porch, is specifically a [kpt package](https://kpt.dev/) - a collection of related YAML
	files including one or more [KRM resources][krm] and a [Kptfile](https://kpt.dev/book/02-concepts/#packages).
	{{% alert title="N.B." color="warning" %}}

	There is no such thing as a "Porch Package" - rather, Porch stores and orchestrates kpt packages.

	{{% /alert %}}


		Below is a high-level explanation of the steps performed by the automated script when initializing a new Gitea repository for use with Porch. These numbered steps reflect the scripted (API/CLI) approach — you may copy the equivalent commands to run them manually if you prefer.

		1. Create the repository via the Gitea REST API

repository doc example #278

Are you sure you want to change the base?

repository doc example #278

Uh oh!

Conversation

lapentad commented Oct 21, 2025

Uh oh!

nephio-prow bot commented Oct 21, 2025

Uh oh!

netlify bot commented Oct 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

✅ Deploy Preview for nephio ready!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

sonarqubecloud bot commented Oct 31, 2025

Quality Gate passed

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

netlify bot commented Oct 21, 2025 •

edited

Loading