Skip to content

Creating a Porch Basic Usage guide #254

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from

Conversation

Copy link
Contributor

nephio-prow bot commented Jul 24, 2025

[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 arora-sagar for approval by writing /assign @arora-sagar 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:

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

@liamfallon
Copy link
Member

I'm afraid that we have done a big update on the porch CLI user guide because teh old one was out of date and incorrect.
Please see:
#253

Copy link

netlify bot commented Jul 24, 2025

Deploy Preview for nephio ready!

Name Link
🔨 Latest commit 6628203
🔍 Latest deploy log https://app.netlify.com/projects/nephio/deploys/68946fec984c9e00070fb148
😎 Deploy Preview https://deploy-preview-254--nephio.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Signed-off-by: Dominika Schweier <[email protected]>
@lovesprung
Copy link
Contributor Author

@liamfallon @kispaljr Did some additional work on this PR. I added the Package Orchestration chapter from the kpt book (https://github.com/kptdev/kpt/blob/main/documentation/content/en/book/08-package-orchestration/_index.md) here under Use Cases. However, we noticed that it is almost exactly the same as the Using the Porch CLI tool page we have here in Nephio, under Porch. Only difference is that the kpt one has kpt commands while the Porch one has porchcli commands. Wondering if this Use Cases page is even needed at all. What are your thoughts?

Signed-off-by: Dominika Schweier <[email protected]>
@efiacor
Copy link
Collaborator

efiacor commented Jul 31, 2025

@liamfallon @kispaljr Did some additional work on this PR. I added the Package Orchestration chapter from the kpt book (https://github.com/kptdev/kpt/blob/main/documentation/content/en/book/08-package-orchestration/_index.md) here under Use Cases. However, we noticed that it is almost exactly the same as the Using the Porch CLI tool page we have here in Nephio, under Porch. Only difference is that the kpt one has kpt commands while the Porch one has porchcli commands. Wondering if this Use Cases page is even needed at all. What are your thoughts?

kpt alpha rpkg is defunct and has been replaced with porchctl rpkg

@lovesprung
Copy link
Contributor Author

@liamfallon @kispaljr Did some additional work on this PR. I added the Package Orchestration chapter from the kpt book (https://github.com/kptdev/kpt/blob/main/documentation/content/en/book/08-package-orchestration/_index.md) here under Use Cases. However, we noticed that it is almost exactly the same as the Using the Porch CLI tool page we have here in Nephio, under Porch. Only difference is that the kpt one has kpt commands while the Porch one has porchcli commands. Wondering if this Use Cases page is even needed at all. What are your thoughts?

kpt alpha rpkg is defunct and has been replaced with porchctl rpkg

So basically the Use Cases page would be duplicated content with outdated commands, thus not needed.

@efiacor
Copy link
Collaborator

efiacor commented Jul 31, 2025

@liamfallon @kispaljr Did some additional work on this PR. I added the Package Orchestration chapter from the kpt book (https://github.com/kptdev/kpt/blob/main/documentation/content/en/book/08-package-orchestration/_index.md) here under Use Cases. However, we noticed that it is almost exactly the same as the Using the Porch CLI tool page we have here in Nephio, under Porch. Only difference is that the kpt one has kpt commands while the Porch one has porchcli commands. Wondering if this Use Cases page is even needed at all. What are your thoughts?

kpt alpha rpkg is defunct and has been replaced with porchctl rpkg

So basically the Use Cases page would be duplicated content with outdated commands, thus not needed.

I think most of it is already covered in the CLI guide yes. Although we may be missing some extra info. ie
"You can find out more about the upstream and upstreamLock sections of the Kptfile in an earlier chapter of the book."

@liamfallon We should look to remove the "kpt alpha x" from the kpt docs etc.

@CsatariGergely
Copy link
Contributor

I've created kptdev/kpt#4235 to update the kpt documentation. Which alpha commands are deprecated?

@efiacor
Copy link
Collaborator

efiacor commented Aug 7, 2025

I've created kptdev/kpt#4235 to update the kpt documentation. Which alpha commands are deprecated?

For sure the "rpkg" and "repo" commands have moved to porchctl.
The others I am not sure on as we don't use them tbh.

Copy link

sonarqubecloud bot commented Aug 7, 2025

@lovesprung
Copy link
Contributor Author

@efiacor @liamfallon So what we did was we merged content from the Use Cases to the Using the Porch CLI tool page. And since this Using the Porch CLI tool page would be the only page under Basic Usage, we decided to just toss that and move it back under Porch user guides.

I copied and tried to rework some instructions on how to download and edit package, it starts around line 365. We are not sure if it is needed or the updates on it are correct, please check this part and let me know if. Thank you!

@lovesprung
Copy link
Contributor Author

/assign @liamfallon @efiacor

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants