-
Notifications
You must be signed in to change notification settings - Fork 18
Installing, upgrading, uninstalling #4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Installing, upgrading, uninstalling #4
Conversation
@Preeticp could you review please |
@@ -0,0 +1,11 @@ | |||
[id="installing-the-pipelines-operator_{context}"] | |||
= Upgrading the Pipelines Operator to the newer version |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@boczkowska since there are no actionable instructions for the user, can we simply add this to the existing note under step 5 in the Installation Procedure, instead of a separate module for this? You can use bullets in the Note, one for the existing note and the second one for this. For some reason I was under the impression that we have at least a couple of steps in this section.
Without instructions we should not be calling a module a procedural module. Once you do that please remove the include in the Assembly too.
|
||
[NOTE] | ||
==== | ||
OpenShift Pipelines 0.5.2 has introduced changes incompatable with older versions. If the installed version is 0.5.0 or below, the operator *will not be automatically upgraded.* |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
incompatable>incompatible
Remove the Bold format for 'will not be automatically upgraded.', since we are using the admonition (Note) to draw the user's attention, we do not need to use Bold in addition.
==== | ||
OpenShift Pipelines 0.5.2 has introduced changes incompatable with older versions. If the installed version is 0.5.0 or below, the operator *will not be automatically upgraded.* | ||
To upgrade from the 0.5.0 or below uninstall the operator and then install it again. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Extra space before 'uninstall...'
Should we add a link to the Uninstall section when we mention uninstall the operator? WDYT?
[NOTE] | ||
==== | ||
* The operator is installed automatically into the `openshift-operators` namespace. The option to install in *A specific namespace on the cluster* should be disabled. The OpenShift Pipelines operator should watch for Tekton Custom Resources across all namespaces. | ||
* OpenShift Pipelines upgrades are handled automatically via Operator Subscription. New updates will be installed as soon as they become available. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We do not use via, use through. See IBM style guide.
==== | ||
* The operator is installed automatically into the `openshift-operators` namespace. The option to install in *A specific namespace on the cluster* should be disabled. The OpenShift Pipelines operator should watch for Tekton Custom Resources across all namespaces. | ||
* OpenShift Pipelines upgrades are handled automatically via Operator Subscription. New updates will be installed as soon as they become available. | ||
** OpenShift Pipelines 0.5.2 has introduced changes incompatible with older versions. If the installed version is 0.5.0 or below, the operator will not be automatically upgraded. To upgrade from the 0.5.0 or below uninstall the operator and then install it again. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Comma after below.
Link the un-installation doc to the words uninstall the operator.
Changes: