-
Notifications
You must be signed in to change notification settings - Fork 35
repository doc example #278
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
✅ 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 <[email protected]>
…ositories.md Co-authored-by: Fiachra Corcoran <[email protected]>
…ositories.md Co-authored-by: Fiachra Corcoran <[email protected]>
583ea4c to
982687c
Compare
Signed-off-by: lapentafd <[email protected]>
Signed-off-by: lapentafd <[email protected]>
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 <[email protected]>
0146783 to
af27744
Compare
Signed-off-by: lapentafd <[email protected]>
Signed-off-by: lapentafd <[email protected]>
Signed-off-by: lapentafd <[email protected]>
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 <[email protected]>
…epositories.md Co-authored-by: Catalin Stratulat <[email protected]>
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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
| * ***Package***: A package, in Porch, is specifically a [kpt package](https://kpt.dev/) - a collection of related YAML | |
| files including one or more **[KRM resources][krm]** and a [Kptfile](https://kpt.dev/book/02-concepts/#packages). | |
| {{% alert title="N.B." color="warning" %}} | |
| There is no such thing as a "Porch Package" - rather, **Porch stores and orchestrates kpt packages**. | |
| {{% /alert %}} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
|
|
/approve |
|
/approve this looks ready to go in for me. |
|
[APPROVALNOTIFIER] This PR is APPROVED This pull-request has been approved by: Catalin-Stratulat-Ericsson, lovesprung The full list of commands accepted by this bot can be found here. The pull request process is described here
Needs 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