openshift / installer

Install an OpenShift 4.x cluster
https://try.openshift.com
Apache License 2.0
1.44k stars 1.38k forks source link

[RFE] Updating docs/user/metal #3705

Closed rlopez133 closed 3 years ago

rlopez133 commented 4 years ago

Our team has created documentation within the baremetal-deploy repository on showing how to deploy IPI on Baremetal. We currently have a homepage for all the docs with it capturing how to deploy IPI on BM 4.3, 4.4 and soon 4.5 We've included troubleshooting documentation as well. All of our documentation is rendered in both HTML and PDF, is modularized, and we've worked with the docs team to ensure we have a standard for both upstream and downstream. What would be the process to get our docs to reside here or maybe even point to our existing https://openshift-kni.github.io/baremetal-deploy/ as we are actively maintaining it?

Thanks, Roger

hardys commented 4 years ago

/label platform/baremetal

stbenjam commented 4 years ago

The documentation there is very high quality, it needs to go somewhere and be discoverable. Do other platforms have analogous documentation upstream? Could it be relocated to https://github.com/openshift/openshift-docs and then we could easily link to to docs.openshift.com from the installer repo?

I'm hesitant to say it should be linked directly to the baremetal-deploy GitHub page or to be all incorporated here.

Ultimately it's up to the installer team.

@abhinavdahiya PTAL

rlopez133 commented 4 years ago

The documentation there is very high quality, it needs to go somewhere and be discoverable. Do other platforms have analogous documentation upstream? Could it be relocated to https://github.com/openshift/openshift-docs and then we could easily link to to docs.openshift.com from the installer repo?

I'm hesitant to say it should be linked directly to the baremetal-deploy GitHub page or to be all incorporated here.

Ultimately it's up to the installer team.

@abhinavdahiya PTAL

@stbenjam - The modules live here as well: https://github.com/openshift/openshift-docs/tree/master/installing/installing_bare_metal_ipi . Essentially the docs team works with us and they build the downstream from this. Regarding upstream, the modules are all there, but since we are always updating constantly within our repo, things don't necessarily land immediately in the openshift-docs repo as the process right now is update baremetal-deploy repo, then things get picked up in openshift-docs repo when we sync. Also this documentation right now in openshift-docs requires credentials to access.

openshift-bot commented 4 years ago

Issues go stale after 90d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle stale. Stale issues rot after an additional 30d of inactivity and eventually close. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle stale

openshift-bot commented 3 years ago

Stale issues rot after 30d of inactivity.

Mark the issue as fresh by commenting /remove-lifecycle rotten. Rotten issues close after an additional 30d of inactivity. Exclude this issue from closing by commenting /lifecycle frozen.

If this issue is safe to close now please do so with /close.

/lifecycle rotten /remove-lifecycle stale

openshift-bot commented 3 years ago

Rotten issues close after 30d of inactivity.

Reopen the issue by commenting /reopen. Mark the issue as fresh by commenting /remove-lifecycle rotten. Exclude this issue from closing again by commenting /lifecycle frozen.

/close

openshift-ci-robot commented 3 years ago

@openshift-bot: Closing this issue.

In response to [this](https://github.com/openshift/installer/issues/3705#issuecomment-746052095): >Rotten issues close after 30d of inactivity. > >Reopen the issue by commenting `/reopen`. >Mark the issue as fresh by commenting `/remove-lifecycle rotten`. >Exclude this issue from closing again by commenting `/lifecycle frozen`. > >/close Instructions for interacting with me using PR comments are available [here](https://git.k8s.io/community/contributors/guide/pull-requests.md). If you have questions or suggestions related to my behavior, please file an issue against the [kubernetes/test-infra](https://github.com/kubernetes/test-infra/issues/new?title=Prow%20issue:) repository.