Skip to content

Conversation

eromanova97
Copy link
Contributor

@eromanova97 eromanova97 commented Nov 7, 2024

Version(s) for cherry-picking: none

Issue: OBSDOCS-1472

Link to docs preview: no preview necessary

QE review:

  • QE has approved this change.

Additional information:

@openshift-ci-robot openshift-ci-robot added the jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. label Nov 7, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Nov 7, 2024

@eromanova97: This pull request references OBSDOCS-1472 which is a valid jira issue.

In response to this:

Version(s) for cherry-picking: none

Issue: OBSDOCS-1472

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:

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 openshift-ci bot added the size/S Denotes a PR that changes 10-29 lines, ignoring generated files. label Nov 7, 2024
@ocpdocs-previewbot
Copy link

Copy link

openshift-ci bot commented Nov 7, 2024

@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.

@openshift-ci-robot
Copy link

openshift-ci-robot commented Nov 7, 2024

@eromanova97: This pull request references OBSDOCS-1472 which is a valid jira issue.

In response to this:

Version(s) for cherry-picking: none

Issue: OBSDOCS-1472

Link to docs preview: no preview necessary

QE review:

  • QE has approved this change.

Additional information:

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.

@juzhao
Copy link

juzhao commented Nov 8, 2024

https://84580--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/monitoring/enabling-monitoring-for-user-defined-projects.html
there are two same headers Enabling monitoring for user-defined projects, I think we could remove the second one, WDYT?

found it's the same for 4.17 released doc: https://docs.openshift.com/container-platform/4.17/observability/monitoring/enabling-monitoring-for-user-defined-projects.html

@eromanova97
Copy link
Contributor Author

https://84580--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/monitoring/enabling-monitoring-for-user-defined-projects.html there are two same headers Enabling monitoring for user-defined projects, I think we could remove the second one, WDYT?

found it's the same for 4.17 released doc: https://docs.openshift.com/container-platform/4.17/observability/monitoring/enabling-monitoring-for-user-defined-projects.html

@juzhao Oh yes, I actually don't like it either. The problem here is that the first one is the name of the whole file while the second one is the name of the actual procedure involved. Both titles must be there due to our doc rules and the way they are structured.

So the only thing that can be done here is to rename them. The procedure being called "Enabling monitoring for user-defined projects" makes sense. However, the whole chapter being called the same makes sense as well.
Honestly, I could not come up with the possible replacement title 😓

It is not wrong to have it as it is currently, but if you have any ideas, let me know

@juzhao
Copy link

juzhao commented Nov 8, 2024

https://84580--ocpdocs-pr.netlify.app/openshift-enterprise/latest/observability/monitoring/enabling-monitoring-for-user-defined-projects.html there are two same headers Enabling monitoring for user-defined projects, I think we could remove the second one, WDYT?
found it's the same for 4.17 released doc: https://docs.openshift.com/container-platform/4.17/observability/monitoring/enabling-monitoring-for-user-defined-projects.html

@juzhao Oh yes, I actually don't like it either. The problem here is that the first one is the name of the whole file while the second one is the name of the actual procedure involved. Both titles must be there due to our doc rules and the way they are structured.

So the only thing that can be done here is to rename them. The procedure being called "Enabling monitoring for user-defined projects" makes sense. However, the whole chapter being called the same makes sense as well. Honestly, I could not come up with the possible replacement title 😓

It is not wrong to have it as it is currently, but if you have any ideas, let me know

keep it is fine, maybe others have an idea for it.
/lgtm

@openshift-ci openshift-ci bot added the lgtm Indicates that a PR is ready to be merged. label Nov 8, 2024
@eromanova97
Copy link
Contributor Author

/label peer-review-needed

@openshift-ci openshift-ci bot added the peer-review-needed Signifies that the peer review team needs to review this PR label Nov 11, 2024
@openshift-ci-robot
Copy link

openshift-ci-robot commented Nov 11, 2024

@eromanova97: This pull request references OBSDOCS-1472 which is a valid jira issue.

In response to this:

Version(s) for cherry-picking: none

Issue: OBSDOCS-1472

Link to docs preview: no preview necessary

QE review:

  • QE has approved this change.

Additional information:

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.

@skopacz1 skopacz1 added the peer-review-in-progress Signifies that the peer review team is reviewing this PR label Nov 11, 2024
Copy link
Contributor

@skopacz1 skopacz1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

@skopacz1 skopacz1 added this to the Continuous Release milestone Nov 11, 2024
@skopacz1 skopacz1 added peer-review-done Signifies that the peer review team has reviewed this PR and removed peer-review-in-progress Signifies that the peer review team is reviewing this PR peer-review-needed Signifies that the peer review team needs to review this PR labels Nov 11, 2024
@eromanova97
Copy link
Contributor Author

/label merge-review-needed

@openshift-ci openshift-ci bot added the merge-review-needed Signifies that the merge review team needs to review this PR label Nov 12, 2024
@maxwelldb maxwelldb added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Nov 12, 2024
Copy link
Contributor

@maxwelldb maxwelldb left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Seems fine to me. @eromanova97 Can you confirm the merge target for this?

@eromanova97
Copy link
Contributor Author

Hello @maxwelldb it only goes to the branch against which it is raised (monitoring-docs-restructure) so it needs no chery-picking, just merging. Thank you!

@maxwelldb maxwelldb merged commit 24da361 into openshift:monitoring-docs-restructure Nov 13, 2024
2 checks passed
@eromanova97 eromanova97 deleted the OBSDOCS-1472 branch November 18, 2024 09:53
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

jira/valid-reference Indicates that this PR references a valid Jira ticket of any type. lgtm Indicates that a PR is ready to be merged. merge-review-in-progress Signifies that the merge review team is reviewing this PR merge-review-needed Signifies that the merge review team needs to review this PR peer-review-done Signifies that the peer review team has reviewed this PR size/S Denotes a PR that changes 10-29 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants