AlanGreene
commented
1 year ago more work is required for other components' installation docs to be included here.
Can you elaborate on this?
Closed geriom closed 1 year ago
AlanGreene
commented
1 year ago more work is required for other components' installation docs to be included here.
Can you elaborate on this?
geriom
commented
1 year ago more work is required for other components' installation docs to be included here.
Can you elaborate on this?
@AlanGreene not all repos have an install.md file, chains and CLI for instance have their installation instructions in their README. I started with Pipelines and Triggers because they are the most critical. I would also like to implement some changes so all the installation docs have the same structure and style.
geriom
commented
1 year ago I think the local setup section is not ideal as it is though, I would probably only include links to the tools (minikube, kind) and to the install guides. It may be useful to include some sizing suggestions instead, like how much memory / disk / CPU.
@afrittoli I agree, there's no value in repeating the installation instructions for minikube and kind. I simplified the content to link to the corresponding docs, and made the links to the setup and scripts more prominent. TAL
tekton-robot
commented
1 year ago [APPROVALNOTIFIER] This PR is APPROVED
This pull-request has been approved by: afrittoli, dibyom
The full list of commands accepted by this bot can be found here.
The pull request process is described here
Changes
To have a better docs user experience, this new section surfaces the installation documentation for all the Tekton components.
This first iteration adds Pipelines and Triggers, more work is required for other components' installation docs to be included here.
Submitter Checklist
These are the criteria that every PR should meet, please check them off as you review them:
See the contribution guide for more details.