RHDEVDOCS-6278 Content improvement for builds

[likhithj1996]

Version(s):

Builds v1.1
Builds v1.2

Issue:

https://issues.redhat.com/browse/RHDEVDOCS-6278

Link to docs preview:

Using Builds in a network-restricted environment.
Creating buildah build in a network-restricted environment
Creating source-to-image build in a network-restricted environment

QE review:

• QE has approved this change.

QE review:
SME review:
Peer review:
Internal Peer review: @Dhruv-Soni11

Additional information:

[ocpdocs-previewbot]

🤖 Thu Dec 12 08:17:12 - Prow CI generated the docs preview:

https://85707--ocpdocs-pr.netlify.app/openshift-builds/latest/configuring/using-builds-in-a-network-restricted-environment.html
https://85707--ocpdocs-pr.netlify.app/openshift-builds/latest/work_with_builds/using-builds.html

[Dhruv-Soni11]

/lgtm, thanks @likhithj1996. Please ensure that you list the section names and then add the URL in the text for that affected section under the PR description.

[openshift-ci]

@likhithj1996: all tests passed!

Full PR test history. Your PR dashboard.

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository. I understand the commands that are listed here.

[avinal]

/lgtm

[likhithj1996]

/label peer-review-needed

[ayushsatyam146]

/approve
/lgtm

[likhithj1996]

/label merge-review-needed

[skopacz1]

LGTM

[skopacz1]

I see that build docs go up to 1.3, and that this PR is based off a main branch. Idk whether 1.3 is released yet, but if it was released, would these changes apply to that version as well?

I will review this PR as if it's just for 1.1 and 1.2. If I finish merge review and these changes should also apply to 1.3, please reach out to the OCP docs team to ask if someone could cherry pick this to that version as well.

CC @Dhruv-Soni11 for version confirmation and @snarayan-redhat for merge availability during recharge

[skopacz1]

/cherrypick build-docs-1.1

[skopacz1]

/cherrypick build-docs-1.2

[openshift-cherrypick-robot]

@skopacz1: #85707 failed to apply on top of branch "build-docs-1.1":

Applying: Content improvement for builds
.git/rebase-apply/patch:36: trailing whitespace.
The {pipelines-operator} provides support for injecting the proxy environment variables in the network-restricted environments. 
.git/rebase-apply/patch:52: trailing whitespace.
You can create a `buildah` build in a network-restricted environment by mirroring the images required by the `buildah` build strategy. 
.git/rebase-apply/patch:68: trailing whitespace.
You can create a `source-to-image` build in a network-restricted environment by mirroring the images required by the `source-to-image` build strategy. 
warning: 3 lines add whitespace errors.
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map.yml
A	configuring/using-builds-in-a-network-restricted-environment.adoc
A	modules/ob-creating-buildah-build-in-a-network-restricted-environment.adoc
A	modules/ob-creating-s2i-build-in-a-network-restricted-environment.adoc
Falling back to patching base and 3-way merge...
CONFLICT (modify/delete): modules/ob-creating-s2i-build-in-a-network-restricted-environment.adoc deleted in HEAD and modified in Content improvement for builds. Version Content improvement for builds of modules/ob-creating-s2i-build-in-a-network-restricted-environment.adoc left in tree.
CONFLICT (modify/delete): modules/ob-creating-buildah-build-in-a-network-restricted-environment.adoc deleted in HEAD and modified in Content improvement for builds. Version Content improvement for builds of modules/ob-creating-buildah-build-in-a-network-restricted-environment.adoc left in tree.
CONFLICT (modify/delete): configuring/using-builds-in-a-network-restricted-environment.adoc deleted in HEAD and modified in Content improvement for builds. Version Content improvement for builds of configuring/using-builds-in-a-network-restricted-environment.adoc left in tree.
Auto-merging _topic_maps/_topic_map.yml
CONFLICT (content): Merge conflict in _topic_maps/_topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
hint: When you have resolved this problem, run "git am --continue".
hint: If you prefer to skip this patch, run "git am --skip" instead.
hint: To restore the original branch and stop patching, run "git am --abort".
hint: Disable this message with "git config advice.mergeConflict false"
Patch failed at 0001 Content improvement for builds

In response to this:

/cherrypick build-docs-1.1

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[openshift-cherrypick-robot]

@skopacz1: new pull request created: #86599

In response to this:

/cherrypick build-docs-1.2

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[skopacz1]

@likhithj1996 additionally, you'll need to make a manual CP for 1.1. Since I'll be gone for recharge, you can add that cherry pick to the merge review queue like you did with this PR.

[skopacz1]

Also just realized that I did not confirm whether this PR was peer reviewed first 😅. From a peer review perspective the PR LGTM, so I'll add the label, but in the future, you must finish peer review before requesting a merge review.

[shivanisathe25]

I see that build docs go up to 1.3, and that this PR is based off a main branch. Idk whether 1.3 is released yet, but if it was released, would these changes apply to that version as well?

I will review this PR as if it's just for 1.1 and 1.2. If I finish merge review and these changes should also apply to 1.3, please reach out to the OCP docs team to ask if someone could cherry pick this to that version as well.

CC @Dhruv-Soni11 for version confirmation and @snarayan-redhat for merge availability during recharge

@skopacz1 , the PR is intended only for 1.2. 1.3 is not yet released. Please merge it into 1.2 only.

[snarayan-redhat]

@skopacz1 Thanks for looping me in. I see that this PR was peer reviewed but the labels were not updated. But I agree that this should go through the process that includes updating the required labels.

@likhithj1996 @shivanisathe25 The PR is already merged to 1.2. I think if it is a 1.2 only feature, the PR should have branched out of 1.2 instead of main. If it applies to future versions as well, then we might have to CP it to 1.3 too as we already have a branch for the same.

[shivanisathe25]

@skopacz1 Thanks for looping me in. I see that this PR was peer reviewed but the labels were not updated. But I agree that this should go through the process that includes updating the required labels.

@likhithj1996 @shivanisathe25 The PR is already merged to 1.2. I think if it is a 1.2 only feature, the PR should have branched out of 1.2 instead of main. If it applies to future versions as well, then we might have to CP it to 1.3 too as we already have a branch for the same.

okay. What I meant was the changes should be there in 1.2 and above versions but not 1.1. Could you or @skopacz1 CP it to 1.3 as well then?

[snarayan-redhat]

/cherrypick build-docs-1.3

[openshift-cherrypick-robot]

@snarayan-redhat: new pull request created: #86602

In response to this:

/cherrypick build-docs-1.3

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes-sigs/prow repository.

[snarayan-redhat]

@shivanisathe25 I tried cherrypicking to 1.3, however, the builds don't seem to be configured for 1.3. Can you check and confirm how the features are pushed to 1.3?
cc: @Dhruv-Soni11

[snarayan-redhat]

Also, meanwhile can one of you update the PR description with the relevant version, like removing 1.1 and maybe adding 1.3?