Creating a Porch Basic Usage guide

[lovesprung]

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

[liamfallon]

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

[netlify]

✅ Deploy Preview for nephio ready!

Name	Link
🔨 Latest commit	b38808d
🔍 Latest deploy log	https://app.netlify.com/projects/nephio/deploys/68e90a8aa2fe110008a376cb
😎 Deploy Preview	https://deploy-preview-254--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.

[lovesprung]

@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?

[efiacor]

@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]

@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]

@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]

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

[efiacor]

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.

[sonarqubecloud]

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]

@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]

/assign @liamfallon @efiacor

[Catalin-Stratulat-Ericsson]

overall this entire "user guide" section will need entire rewrite (using certain sections we already have e.g. alot of the cli guide can be reused) but overall i dont see why this cant be merged in now before this rewrite begins

[sonarqubecloud]

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

[Catalin-Stratulat-Ericsson]

/approve looks good

[nephio-prow]

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: Catalin-Stratulat-Ericsson
Once this PR has been reviewed and has the lgtm label, please ask for approval from efiacor by writing /assign @efiacor 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