search

ocp-power-automation / ocp4-upi-kvm

OCP4 on KVM/Power
Apache License 2.0
17 stars 20 forks source link

Update Documentation #7

Closed krishvoor closed 4 years ago

krishvoor commented 4 years ago

This PR Aims at providing fix for #6 via updating the relevant Documentation.

yussufsh commented 4 years ago

I am not in favor of mentioning the steps required for external dependcies in the README here. This part is already documented on the referenced link and we have mentioned it in this repo as well.

Most we could do is move the reference up to Pre-requisite section without giving detailed steps. (Which could in turn depend on other things like machine arch, OS and even Go version).

What you have to say @bpradipt ?

bpradipt commented 4 years ago

I am not in favor of mentioning the steps required for external dependcies in the README here. This part is already documented on the referenced link and we have mentioned it in this repo as well.

Most we could do is move the reference up to Pre-requisite section without giving detailed steps. (Which could in turn depend on other things like machine arch, OS and even Go version).

What you have to say @bpradipt ?

Yeah I tend to agree... I think what we can do is create a separate doc to describe libvirt terraform provider build and install since this is not part of default TF providers and link it in the main readme.

@krishvoor can you do that ?

krishvoor commented 4 years ago

I am not in favor of mentioning the steps required for external dependcies in the README here. This part is already documented on the referenced link and we have mentioned it in this repo as well. Most we could do is move the reference up to Pre-requisite section without giving detailed steps. (Which could in turn depend on other things like machine arch, OS and even Go version). What you have to say @bpradipt ?

Yeah I tend to agree... I think what we can do is create a separate doc to describe libvirt terraform provider build and install since this is not part of default TF providers and link it in the main readme.

@krishvoor can you do that ?

Okay I can do that.. will create a doc .. capture the steps required and link them back to README.md file..

krishvoor commented 4 years ago

@bpradipt Updated documentation relevantly - new PR is via https://github.com/ocp-power-automation/ocp4-upi-kvm/pull/22