Adding install guide #284
Adding install guide #284
Conversation
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here.
Needs approval from an approver in each of these files:
Approvers can indicate their approval by writing |
✅ Deploy Preview for nephio ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Catalin-Stratulat-Ericsson
removed the request for review
from johnbelamaric
|
There was a problem hiding this comment.
Might be cleaner to just have single shortcode to pull any "param" from the config.
params.html
{{- $param := .Get 0 -}}
{{- index site.Params $param -}}
and use it like:
({{< params "version_git" >}})
There was a problem hiding this comment.
ah cool i did not know we can do it this way. looks cleaner. will try and do it that way. i had a feeling when adding the sc's that there is a lot of repetition and there must be a cleaner way.
|
|
||
| list of prerequisites for script to run and porch to be deployed. e.g. kubectl, kind cluster etc | ||
| {{% alert color="primary" %}} | ||
| Note that Porch and this guide assumes a K8s cluster is set up and a Unix Operating system is used as the basis for operation. These include Linux OS's such as Ubuntu 24.04 LTS or MacOS. |
There was a problem hiding this comment.
I would remove this and just state:
Platforms supported:
Linux
Mac
| {{% /alert %}} | ||
|
|
||
| we should have a simple installing porch script which deploys porch similar to the (./scripts/setup-dev-env.sh + make run-in-kind + setting up an example-repository) with a small description for exactly what this script does for those who want more information but does not impede those who simply want to deploy porch | ||
| Before porch and its CLI can be installed a few prerequisites are required to be present on the system. |
There was a problem hiding this comment.
We could move this to the parent level and just have the list as the "Prerequisites"
No need for explanation really
| version (Print the version number of porchctl) | ||
| ``` | ||
|
|
||
| ## Deploying Porch on a cluster |
There was a problem hiding this comment.
I would split these into 2 guides.
- Install porchctl
- Deploy the package
| type: docs | ||
| weight: 3 | ||
| description: Getting Started with Porch | ||
| description: "This section serves to act as an introduction to setting up Porch as for a first time user. It lists the prerequisites required before installation, then deployment of the porchctl cli binary along with a deployment of porch on an existing kubernetes cluster." |
There was a problem hiding this comment.
| description: "This section serves to act as an introduction to setting up Porch as for a first time user. It lists the prerequisites required before installation, then deployment of the porchctl cli binary along with a deployment of porch on an existing kubernetes cluster." | |
| description: "A set of guides for installing Porch prerequisites, the porchctl CLI, and deploying Porch components on a Kubernetes cluster." |
| # The version of the latest code build | ||
| latestTag = "1.5.4" | ||
|
|
||
| # The version of docker the latest code build in automated jobs |
There was a problem hiding this comment.
Are these not more like the latest tested versions?
3 participants
This PR adds a simplistic install guide for porch. (not to be confused with the dev-env setup guide).
This will act as a first time user's first point of contact with installing porch