Modifying repository guide #288
Conversation
✅ Deploy Preview for nephio ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
| @@ -0,0 +1,479 @@ | |||
| --- | |||
| title: "Managing Repositories" | |||
There was a problem hiding this comment.
I'm think we could do with 2 sub sections.
Working with Porch Repositories
Working with Package Revisions
And break these operations out into the Working with Repo sub section
Registering a Git Repository
Syncing Porch Repositories
...
There was a problem hiding this comment.
remodeled for the "Working with Porch Repositories" section.
also added the "Working with Package Revisions" section but just haven't moved the content over because it will be easier to merge in once the other PR's with the guides are in.
Catalin-Stratulat-Ericsson
requested review from
CsatariGergely,
JamesMcDermott,
lapentad and
liamfallon
| description: "Registering Repositories guide in Porch" | ||
| --- | ||
|
|
||
| ## Registering Repositories |
There was a problem hiding this comment.
Could prob drop these initial headings as it's a lot of repetition.
Same for the other repo guides.
There was a problem hiding this comment.
yea i see it now. will amend quickly
| kubectl edit repository porch-test -n default | ||
| ``` | ||
|
|
||
| This opens the repository configuration in your default editor. You can modify fields under `spec.git` such as: |
There was a problem hiding this comment.
I think we decided most of this was a no go. We can't allow an edit on the dir for sure. It should be immutable.
@kushnaidu @liamfallon confirm?
There was a problem hiding this comment.
yea im not 100% sure on this myself. even with the best intention editing this way is flawed. for example lets say user swaps the "secret-ref" to another secret holding another login details. this is pointless because porch will keep using the old details anyways until those fail and the user gets left wondering why their changes aren't taking effect.(and this situation is a nicer issue never-mind serious harm which could be done to the repo with other changes)
There was a problem hiding this comment.
Yes. URL and Directories cannot be edited after a repo is registered.
It has to be re-registered if it requires a change.
|
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: efiacor The full list of commands accepted by this bot can be found here. The pull request process is described here DetailsNeeds approval from an approver in each of these files:
Approvers can indicate their approval by writing |
|
|
||
| ## Prerequisites | ||
|
|
||
| - Porch deployed on a Kubernetes cluster [Setup Porch Guide]({{% relref "/docs/neo-porch/3_getting_started/installing-porch.md" %}}). |
There was a problem hiding this comment.
Shouldn't we start using relative paths? Using absolute paths can cause problems when we rename or move the docs.
There was a problem hiding this comment.
this is a relative path is it not? as far as im aware the absolute path is "/content/en/docs/neo-porch/3_getting_started/installing-porch.md"
| OCI repository support is **experimental** and not actively maintained. Use at your own risk. This feature may have limitations, bugs, or breaking changes. For production deployments, use Git repositories. | ||
| {{% /alert %}} | ||
|
|
||
| Porch has experimental support for OCI (Open Container Initiative) repositories that store packages as container images. This feature is not recommended for production use. |
There was a problem hiding this comment.
Maybe we should switch this with the Warning.
There was a problem hiding this comment.
will amend in another PR thanks
This PR does 3 things 1. Firstly moves the package revision based guides into their personal subsection. as requested here #288 (comment) 2. Adds a general introduction section for package revision based guides much like the working with porch repositories has. 3. Takes out repeated content in the numerous guides related to working with package revisions and puts this content neatly in the _index.md introduction section of the section. Its majority a refactor of the section. no real new content
4 participants
remodeled the repository guide to include general repository managing information for users not just registration.