repository doc example#278
Conversation
✅ Deploy Preview for nephio ready!
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
Outdated
Show resolved
Hide resolved
content/en/docs/neo-porch/4_tutorials_&_how-tos/setting-up-repositories.md
Outdated
Show resolved
Hide resolved
content/en/docs/neo-porch/4_tutorials_&_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
content/en/docs/neo-porch/4_tutorials_&_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
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
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
…ositories.md Co-authored-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
…ositories.md Co-authored-by: Fiachra Corcoran <fiachra.corcoran@est.tech>
583ea4c to
982687c
Compare
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
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
content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md
Outdated
Show resolved
Hide resolved
…epositories.md Co-authored-by: Catalin Stratulat <159934629+Catalin-Stratulat-Ericsson@users.noreply.github.com>
0146783 to
af27744
Compare
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
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
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
Outdated
Show resolved
Hide resolved
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
content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md
Outdated
Show resolved
Hide resolved
| # 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. |
There was a problem hiding this comment.
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".
There was a problem hiding this comment.
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
There was a problem hiding this comment.
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.
There was a problem hiding this comment.
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
Outdated
Show resolved
Hide resolved
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
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
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
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
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
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
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
content/en/docs/neo-porch/4_tutorials_and_how-tos/setting-up-repositories.md
Outdated
Show resolved
Hide resolved
Signed-off-by: lapentafd <francesco.lapenta@est.tech>
|
|
/approve |
|
/approve this looks ready to go in for me. |
| # 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 | ||
| ``` | ||
|
|
There was a problem hiding this comment.
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
There was a problem hiding this comment.
maybe even a FAQ of common registration issues reason for repo not being ready e.g. invalid password/username combo etc
|
/approve |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Catalin-Stratulat-Ericsson, efiacor, lovesprung 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 |



examples to register repositories for the example series.
NOTE: I did not add any sync information