-
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
Changes from 12 commits
ceb4285
db6f02b
982687c
a49ebbc
fb1315f
af27744
0c04e6a
7b3020e
03c20bf
18c5604
b40c858
2a4a94d
6855ca6
67481cc
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change | ||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| @@ -1,10 +1,58 @@ | ||||||||||||||||
| --- | ||||||||||||||||
| title: "Setting Up Repositories" | ||||||||||||||||
| title: "Managing Porch Repositories" | ||||||||||||||||
| type: docs | ||||||||||||||||
| weight: 2 | ||||||||||||||||
| description: | ||||||||||||||||
| description: "A how-to guide on registering Git repositories with Porch" | ||||||||||||||||
| --- | ||||||||||||||||
|
|
||||||||||||||||
| ## Lorem Ipsum | ||||||||||||||||
| # Setting Up Repositories | ||||||||||||||||
lapentad marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
lapentad marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
lapentad marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||
|
|
||||||||||||||||
| 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. | ||||||||||||||||
lapentad marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||||||||||||||||
| * ***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
lapentad marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
lapentad marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
lapentad marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
lapentad marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
lapentad marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
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.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
maybe even a FAQ of common registration issues reason for repo not being ready e.g. invalid password/username combo etc
Uh oh!
There was an error while loading. Please reload this page.