docs icon indicating copy to clipboard operation
docs copied to clipboard

Tekton CI/CD for Private Cloud

Open MarkvanMents opened this issue 2 years ago • 4 comments

MarkvanMents avatar Apr 07 '22 11:04 MarkvanMents

Also our expert services team gave advice to split this documentation into 2 documents. One for airgapped environments, and the second one for the regular environments.

I don't think it makes sense to make this into two documents. Most of the document works for both air-gapped and internet installations. The only differences are:

  • Section 4 - preparation for air-gapped
  • Section 5 - Tekton installation - this looks more complex because it also covers Kubernetes and OpenShift - but I wouldn't split it into two more documents because of that, either.
  • Section 6.1 - Pipeline installation.

The rest of the sections - the introduction to Tekton and installing and using Triggers are identical. Duplicating these means a lot more work if we need to update them, and making a third document makes it more difficult for users to find the one they want.

I'd rather leave it like this for now.

MarkvanMents avatar Apr 21 '22 14:04 MarkvanMents

For Section 5.1.2, mention that user need to go to Tekton folder For Section 5.2.1, mention that user need to create another folder and move out of Tekton folder and add the command cd .. For Section 6.1.2, replace " --set images.imageBuild=$PRIVATE_REGISTRY/mxpc-pipeline-tools-cli:0.0.4 " in command with "--set images.imageBuild=nidhisoni2512/mxpc-pipeline-tools:imagebuild-0.0.1 "

Nidhi251289 avatar Apr 22 '22 11:04 Nidhi251289

Also our expert services team gave advice to split this documentation into 2 documents. One for airgapped environments, and the second one for the regular environments.

I don't think it makes sense to make this into two documents. Most of the document works for both air-gapped and internet installations. The only differences are:

  • Section 4 - preparation for air-gapped
  • Section 5 - Tekton installation - this looks more complex because it also covers Kubernetes and OpenShift - but I wouldn't split it into two more documents because of that, either.
  • Section 6.1 - Pipeline installation.

The rest of the sections - the introduction to Tekton and installing and using Triggers are identical. Duplicating these means a lot more work if we need to update them, and making a third document makes it more difficult for users to find the one they want.

I'd rather leave it like this for now.


Personally when i was working on documentation, then i was facing issue and mistakenly also ran the airgapped command when running the connected mode. As a user, i believe we should have two document, just to avoid confusion

Nidhi251289 avatar Apr 26 '22 10:04 Nidhi251289

@walkline and @Nidhi251289 I have split the air-gapped instructions out of the main document and into a sub-document. I hope that I haven't messed anything up, and that the route through the document is clear. I think it might be a good idea to test the documentation again, once you have had a look to see that it makes sense at a high level. I'm crafting tomorrow, but will be able to respond to your review comments on Monday 2 May.

I can answer any urgent questions in case of a disaster.

MarkvanMents avatar Apr 28 '22 14:04 MarkvanMents

Release requested over Slack

MarkvanMents avatar Sep 27 '22 10:09 MarkvanMents