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

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

✅ Deploy Preview for nephio ready!

Name	Link
🔨 Latest commit	`67481cc`
🔍 Latest deploy log	https://app.netlify.com/projects/nephio/deploys/691ef615dced780008fe5640
😎 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 <francesco.lapenta@est.tech>

…ositories.md Co-authored-by: Fiachra Corcoran <fiachra.corcoran@est.tech>

Signed-off-by: lapentafd <francesco.lapenta@est.tech>

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

…epositories.md Co-authored-by: Catalin Stratulat <159934629+Catalin-Stratulat-Ericsson@users.noreply.github.com>

Signed-off-by: lapentafd <francesco.lapenta@est.tech>

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

Signed-off-by: lapentafd <francesco.lapenta@est.tech>

…epositories.md Co-authored-by: Catalin Stratulat <159934629+Catalin-Stratulat-Ericsson@users.noreply.github.com>

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

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

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

Signed-off-by: lapentafd <francesco.lapenta@est.tech>

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

Signed-off-by: lapentafd <francesco.lapenta@est.tech>

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

Signed-off-by: lapentafd <francesco.lapenta@est.tech>

sonarqubecloud · 2025-11-20T11:06:17Z

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

lovesprung · 2025-11-20T11:17:38Z

/approve

Catalin-Stratulat-Ericsson · 2025-11-20T15:33:26Z

/approve this looks ready to go in for me.

nephio-prow · 2025-11-20T15:33:33Z

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: Catalin-Stratulat-Ericsson, lovesprung

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

The pull request process is described here

Needs approval from an approver in each of these files:

~~OWNERS~~ [Catalin-Stratulat-Ericsson,lovesprung]

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

Catalin-Stratulat-Ericsson · 2025-11-21T16:30:14Z

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

+# Register a Git repository with Porch
+porchctl repo register http://gitea.gitea:3000/nephio/porch-test.git \
+  --name=porch-test \
+  --description="Test repository for Porch packages" \
+  --branch=main \
+  --deployment=true \
+  --repo-basic-username=nephio \
+  --repo-basic-password=secret
+```
+


now that i think of it this shows input and no output.
we should include the response of a repo get command and show a successfully registered repo and an unsuccessful registration

maybe even a FAQ of common registration issues reason for repo not being ready e.g. invalid password/username combo etc

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 <francesco.lapenta@est.tech>

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

db6f02b

…ositories.md Co-authored-by: Fiachra Corcoran <fiachra.corcoran@est.tech>

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

982687c

…ositories.md Co-authored-by: Fiachra Corcoran <fiachra.corcoran@est.tech>

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 <francesco.lapenta@est.tech>

used relref

fb1315f

Signed-off-by: lapentafd <francesco.lapenta@est.tech>

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 <159934629+Catalin-Stratulat-Ericsson@users.noreply.github.com>

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 <francesco.lapenta@est.tech>

link block script and added explaination for git initialization

7b3020e

Signed-off-by: lapentafd <francesco.lapenta@est.tech>

moved sections

03c20bf

Signed-off-by: lapentafd <francesco.lapenta@est.tech>

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 <francesco.lapenta@est.tech>

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

b40c858

…epositories.md Co-authored-by: Catalin Stratulat <159934629+Catalin-Stratulat-Ericsson@users.noreply.github.com>

efiacor reviewed Nov 5, 2025

View reviewed changes

repository change

2a4a94d

Signed-off-by: lapentafd <francesco.lapenta@est.tech>

Catalin-Stratulat-Ericsson reviewed Nov 18, 2025

View reviewed changes

moved description

6855ca6

Signed-off-by: lapentafd <francesco.lapenta@est.tech>

lovesprung suggested changes Nov 20, 2025

View reviewed changes

style suggestions

67481cc

Signed-off-by: lapentafd <francesco.lapenta@est.tech>

nephio-prow bot added the approved label Nov 20, 2025

Catalin-Stratulat-Ericsson reviewed Nov 21, 2025

View reviewed changes

	* *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 %}}

repository doc example #278

Are you sure you want to change the base?

repository doc example #278

Conversation

lapentad 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!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

efiacor Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

Catalin-Stratulat-Ericsson Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

Catalin-Stratulat-Ericsson Nov 5, 2025

Choose a reason for hiding this comment

Uh oh!

Catalin-Stratulat-Ericsson Nov 5, 2025

Choose a reason for hiding this comment

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 Nov 20, 2025

Quality Gate passed

Uh oh!

lovesprung commented Nov 20, 2025

Uh oh!

Catalin-Stratulat-Ericsson commented Nov 20, 2025

Uh oh!

nephio-prow bot commented Nov 20, 2025

Uh oh!

Catalin-Stratulat-Ericsson Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Catalin-Stratulat-Ericsson Nov 21, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

netlify bot commented Oct 21, 2025 •

edited

Loading