OBSDOCS-1637: Ensure the ROSA/OSD distros are rendering correctly. #87956
Conversation
|
@eromanova97: This pull request references OBSDOCS-1637 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-robot
added
the
jira/valid-reference
openshift-ci
bot
added
do-not-merge/work-in-progress
| // The ultimate solution DOES NOT NEED separate IDs, it is just needed for now so that the tests will not break | ||
| // tag::CPM[] | ||
| [id="about-specifying-limits-and-requests-for-monitoring-components-cpm_{context}"] | ||
| = About specifying limits and requests for core monitoring components | ||
| // end::CPM[] | ||
|
|
||
| // tag::UWM[] | ||
| [id="about-specifying-limits-and-requests-for-monitoring-components-uwm_{context}"] | ||
| = About specifying limits and requests for monitoring components for user-defined projects | ||
| // end::UWM[] |
There was a problem hiding this comment.
As the note says: the final solution does not need separate IDs, this is the last PR for editing the content, so I am getting rid of it in this step. Same can be seen in other modules in this PR.
eromanova97
force-pushed
the
OBSDOCS-1637
branch
from
8c92a01 to
ae76cbf
Compare
| // Configurable monitoring components | ||
| // The following module should only include core platform monitoring (CPM tags) | ||
| include::modules/monitoring-configurable-monitoring-components.adoc[leveloffset=+1,tags=**;CPM;!UWM] |
There was a problem hiding this comment.
The modules rendering with core platform monitoring (CPM tags) content can be now safely removed from the original assembly, because this assembly is now used only by ROSA/OSD distros, which do not contain the CPM docs. This can be seen throughout the file changes in this PR.
| // This following ifndef causes the first procedure NOT to show up in ROSA/OSD builds, only in the OCP build | ||
| // The final solution WILL NOT need those ifdef statements | ||
| // The module should only include core platform monitoring | ||
| ifndef::openshift-dedicated,openshift-rosa[] | ||
| include::modules/monitoring-moving-monitoring-components-to-different-nodes.adoc[leveloffset=+2,tags=**;CPM;!UWM] | ||
| endif::openshift-dedicated,openshift-rosa[] | ||
|
|
||
| // The following module shows in all builds. |
There was a problem hiding this comment.
This first suggested solution was overcomplicating things and can be removed now.
eromanova97
force-pushed
the
OBSDOCS-1637
branch
from
ae76cbf to
5618d3b
Compare
|
🤖 Wed Feb 05 11:58:55 - Prow CI generated the docs preview: |
|
@eromanova97: This pull request references OBSDOCS-1637 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. |
eromanova97
force-pushed
the
OBSDOCS-1637
branch
from
5618d3b to
85c6c54
Compare
eromanova97
changed the title
openshift-ci
bot
removed
the
do-not-merge/work-in-progress
|
@eromanova97: This pull request references OBSDOCS-1637 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
peer-review-in-progress
|
@eromanova97: Those labels are not set on the 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 kubernetes-sigs/prow repository. |
|
/label peer-review-needed |
openshift-ci
bot
added
peer-review-needed
gabriel-rh
added
the
peer-review-in-progress
eromanova97
force-pushed
the
OBSDOCS-1637
branch
from
85c6c54 to
61461d5
Compare
gabriel-rh
added
peer-review-done
|
@eromanova97: 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. |
gabriel-rh
merged commit bbc67ef
into
openshift:monitoring-docs-restructure
4 participants
Version(s): none for cherry-picking,
monitoring-docs-restructureonlyIssue: https://issues.redhat.com/browse/OBSDOCS-1637
Link to docs preview:
ROSA: https://87956--ocpdocs-pr.netlify.app/openshift-rosa/latest/observability/monitoring/monitoring-overview
OSD: https://87956--ocpdocs-pr.netlify.app/openshift-dedicated/latest/observability/monitoring/monitoring-overview
The thing here is to check that the distros do not include any core platform procedures, especially in this assembly: link) but includes only user-defined project procedures.
QE review:
n/aAdditional information: