-
Notifications
You must be signed in to change notification settings - Fork 33
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
base: main
Are you sure you want to change the base?
Conversation
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: 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 |
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. |
✅ Deploy Preview for nephio ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Signed-off-by: Dominika Schweier <[email protected]>
Signed-off-by: Dominika Schweier <[email protected]>
@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]>
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 @liamfallon We should look to remove the "kpt alpha x" from the kpt docs etc. |
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. |
Signed-off-by: Dominika Schweier <[email protected]>
|
@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! |
/assign @liamfallon @efiacor |
Basic usage
Tutorial part of the “Install and use Porch” (Starting from "The porchctl command")
Using the Porch CLI tool
Merge https://kpt.dev/book/08-package-orchestration/02-quickstart, https://kpt.dev/book/08-package-orchestration/03-registering-a-repositoryto, https://kpt.dev/book/08-package-orchestration/04-package-authoring and https://kpt.dev/book/08-package-orchestration/05-package-lifecycle here