RHDEVDOCS-6424: Modularization changes in GitOps content #92533
Conversation
openshift-ci-robot
added
the
jira/valid-reference
|
@Dhruv-Soni11: This pull request references RHDEVDOCS-6424 which is a valid jira issue. In response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
openshift-ci
bot
added
the
size/XL
Dhruv-Soni11
force-pushed
the
RHDEVDOCS-6424
branch
from
15634e9 to
00f68dc
Compare
|
@Dhruv-Soni11: This pull request references RHDEVDOCS-6424 which is a valid jira issue. In response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
|
@Dhruv-Soni11: This pull request references RHDEVDOCS-6424 which is a valid jira issue. In response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
|
@Dhruv-Soni11: This pull request references RHDEVDOCS-6424 which is a valid jira issue. In response to this:
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 openshift-eng/jira-lifecycle-plugin repository. |
There was a problem hiding this comment.
I think the module breakup work is great. However, because new modules mean changes in the repo, they need to conform to the style guide and to be complete. even when they were not conformant or not complete before.
Moreover, I do think that when modularizing, you need to change procedures to conform to the PROCEDURE template. In two of them, I also think more information is needed compared to the text that was there.
I understand that some of the changes I request this will take time and research but I think the documentation quality result is worth it.
modules/gitops-managing-secrets-using-sscsid-with-gitops-overview.adoc
Outdated
Show resolved
Hide resolved
| // | ||
| // * declarative_clusterconfig/configuring-an-openshift-cluster-by-deploying-an-application-with-cluster-configurations.adoc | ||
|
|
||
| :_mod-docs-content-type: CONCEPT |
There was a problem hiding this comment.
Again, I think you need to change this into a proper procedure. If you are facing difficulties ask me or @linfraze for help
There was a problem hiding this comment.
Yes, I agree. Similar comment / approach recommended here: https://github.com/openshift/openshift-docs/pull/92533/files#r2073804581
| [id="installing-namespace-scoped-operators_{context}"] | ||
| = Installing namepace-scoped Operators | ||
|
|
||
| To install namespace-scoped Operators, create and place the `Subscription` and `OperatorGroup` resources of the required Operator in your Git repository. |
There was a problem hiding this comment.
Again you need to explain more about how you place this resource into a Git repository
There was a problem hiding this comment.
These details are often revealed naturally when we start by orienting the user, as mentioned in a similar comment: https://github.com/openshift/openshift-docs/pull/92533/files#r2073804581
|
|
||
| [IMPORTANT] | ||
| ==== | ||
| When deploying multiple Operators using {gitops-title}, you must create only a single Operator group in the corresponding namespace. If more than one Operator group exists in a single namespace, any CSV created in that namespace transition to a `failure` state with the `TooManyOperatorGroups` reason. After the number of Operator groups in their corresponding namespaces reaches one, all the previous `failure` state CSVs transition to `pending` state. You must manually approve the pending install plan to complete the Operator installation. |
There was a problem hiding this comment.
You need to expand "CSV". The only standard acronym like that expands to "comma-separated values", a file format, which does not seem to be the case here.
Dhruv-Soni11
force-pushed
the
RHDEVDOCS-6424
branch
from
8ff73ea to
9575ed9
Compare
|
@Dhruv-Soni11: 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. |
|
Issues go stale after 90d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle stale |
openshift-ci
bot
added
the
lifecycle/stale
openshift-merge-robot
added
the
needs-rebase
|
PR needs rebase. 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. |
|
Stale issues rot after 30d of inactivity. Mark the issue as fresh by commenting If this issue is safe to close now please do so with /lifecycle rotten |
openshift-ci
bot
added
lifecycle/rotten
|
Rotten issues close after 30d of inactivity. Reopen the issue by commenting /close |
|
@openshift-bot: Closed this PR. In response to this:
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. |
7 participants
Version(s):
GitOps 1.16
Issue:
https://issues.redhat.com/browse/RHDEVDOCS-6424
Link to docs preview:
The following sections have been modularized as per our modularization guidelines:
Separated the sections, Argo rollouts components and Argo rollouts resources under Argo Rollouts architecture
Separated the sections, Installing cluster-scoped Operators and Installing namepace-scoped Operators under Installing OLM Operators using Red Hat OpenShift GitOps
Separated the sections, Configuring respectRBAC using the CLI and Configuring respectRBAC by using the web console under Configuring respectRBAC using Red Hat OpenShift GitOps
Separated the sections, Benefits of managing secrets using Secrets Store CSI driver with GitOps and Secrets store providers under Overview of managing secrets using Secrets Store CSI driver with GitOps
Separated the sections, Enable the creation of aggregated cluster roles and Create user-defined cluster roles and configure user-defined permissions under Creating aggregated cluster roles
QE review:
Peer review: @mramendi
Additional information:
This PR does not require SME and QE review as it is a documentation change only.