Skip to content

Conversation

eromanova97
Copy link
Contributor

@eromanova97 eromanova97 commented Jan 13, 2025

Version(s): none for cherry-picking, monitoring-docs-restruce only

Issue: OBSDOCS-1612

Links to docs preview:

QE review:

  • QE has approved this change.

Additional information:
The changes it this PR are not yet user-facing.
This PR adds an existing content to about alert configurations to the new assembly.

The content in the original assembly is still there . The reason is to not lose any content while moving it around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to check in this PR is to see if the structure in the linked chapters looks good and renders without issues.

This PR also makes small changes to naming of procedures to mitigate the confusion about using multiple terms for the same configuration.

NOTE: The links and xrefs will be filled in in a different PR, because the content from other assemblies still needs to be moved to the new place, which means that if I filled the links now, I would have to keep repairing them later. So I am keeping that for a separate PR.

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

openshift-ci-robot commented Jan 13, 2025

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

In response to this:

Version(s): none for cherry-picking, monitoring-docs-restruce` only

Issue: OBSDOCS-1612

Link to docs preview:

QE review:

  • QE has approved this change.

Additional information:
The changes it this PR are not yet user-facing.
This PR adds an existing content to about alert configurations to the new assembly.

The content in the original assembly is still there . The reason is to not lose any content while moving it around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to check in this PR is to see if the structure in the linked chapters looks good and renders without issues.

This PR also makes small changes to naming of procedure to mitigate the confusion about using multiple terms for the same configuration.

NOTE: The links and xrefs will be filled in in a different PR, because the content from other assemblies still needs to be moved to the new place, which means that if I filled the links now, I would have to keep repairing them later. So I am keeping that for a separate PR.

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 eromanova97 changed the title OBSDOCS-1612: Move the alertmanager configuration modules under a new… [WIP] OBSDOCS-1612: Move the alertmanager configuration modules under a new… Jan 13, 2025
@openshift-ci openshift-ci bot added do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Jan 13, 2025
@ocpdocs-previewbot
Copy link

ocpdocs-previewbot commented Jan 13, 2025

@eromanova97 eromanova97 force-pushed the OBSDOCS1612 branch 2 times, most recently from a207a24 to 20b0bb9 Compare January 14, 2025 14:57
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jan 14, 2025

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

In response to this:

Version(s): none for cherry-picking, monitoring-docs-restruce` only

Issue: OBSDOCS-1612

Links to docs preview:

QE review:

  • QE has approved this change.

Additional information:
The changes it this PR are not yet user-facing.
This PR adds an existing content to about alert configurations to the new assembly.

The content in the original assembly is still there . The reason is to not lose any content while moving it around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to check in this PR is to see if the structure in the linked chapters looks good and renders without issues.

This PR also makes small changes to naming of procedure to mitigate the confusion about using multiple terms for the same configuration.

NOTE: The links and xrefs will be filled in in a different PR, because the content from other assemblies still needs to be moved to the new place, which means that if I filled the links now, I would have to keep repairing them later. So I am keeping that for a separate PR.

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
Copy link

openshift-ci-robot commented Jan 15, 2025

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

In response to this:

Version(s): none for cherry-picking, monitoring-docs-restruce` only

Issue: OBSDOCS-1612

Links to docs preview:

QE review:

  • QE has approved this change.

Additional information:
The changes it this PR are not yet user-facing.
This PR adds an existing content to about alert configurations to the new assembly.

The content in the original assembly is still there . The reason is to not lose any content while moving it around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to check in this PR is to see if the structure in the linked chapters looks good and renders without issues.

This PR also makes small changes to naming of procedure to mitigate the confusion about using multiple terms for the same configuration.

NOTE: The links and xrefs will be filled in in a different PR, because the content from other assemblies still needs to be moved to the new place, which means that if I filled the links now, I would have to keep repairing them later. So I am keeping that for a separate PR.

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 eromanova97 force-pushed the OBSDOCS1612 branch 2 times, most recently from bd6b167 to bc59b87 Compare January 15, 2025 10:59
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jan 15, 2025

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

In response to this:

Version(s): none for cherry-picking, monitoring-docs-restruce` only

Issue: OBSDOCS-1612

Links to docs preview:

QE review:

  • QE has approved this change.

Additional information:
The changes it this PR are not yet user-facing.
This PR adds an existing content to about alert configurations to the new assembly.

The content in the original assembly is still there . The reason is to not lose any content while moving it around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to check in this PR is to see if the structure in the linked chapters looks good and renders without issues.

This PR also makes small changes to naming of procedures to mitigate the confusion about using multiple terms for the same configuration.

NOTE: The links and xrefs will be filled in in a different PR, because the content from other assemblies still needs to be moved to the new place, which means that if I filled the links now, I would have to keep repairing them later. So I am keeping that for a separate PR.

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 eromanova97 changed the title [WIP] OBSDOCS-1612: Move the alertmanager configuration modules under a new… OBSDOCS-1612: Move the alertmanager configuration modules under a new… Jan 15, 2025
@openshift-ci openshift-ci bot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jan 15, 2025
@openshift-ci-robot
Copy link

openshift-ci-robot commented Jan 15, 2025

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

In response to this:

Version(s): none for cherry-picking, monitoring-docs-restruce only

Issue: OBSDOCS-1612

Links to docs preview:

QE review:

  • QE has approved this change.

Additional information:
The changes it this PR are not yet user-facing.
This PR adds an existing content to about alert configurations to the new assembly.

The content in the original assembly is still there . The reason is to not lose any content while moving it around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to check in this PR is to see if the structure in the linked chapters looks good and renders without issues.

This PR also makes small changes to naming of procedures to mitigate the confusion about using multiple terms for the same configuration.

NOTE: The links and xrefs will be filled in in a different PR, because the content from other assemblies still needs to be moved to the new place, which means that if I filled the links now, I would have to keep repairing them later. So I am keeping that for a separate PR.

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 Jan 16, 2025

/lgtm

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

/label peer-review-needed

@openshift-ci-robot
Copy link

openshift-ci-robot commented Jan 16, 2025

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

In response to this:

Version(s): none for cherry-picking, monitoring-docs-restruce only

Issue: OBSDOCS-1612

Links to docs preview:

QE review:

  • QE has approved this change.

Additional information:
The changes it this PR are not yet user-facing.
This PR adds an existing content to about alert configurations to the new assembly.

The content in the original assembly is still there . The reason is to not lose any content while moving it around. There will be a separate issue that will make sure that all the content is transfered as needed.

Therefore, the main thing to check in this PR is to see if the structure in the linked chapters looks good and renders without issues.

This PR also makes small changes to naming of procedures to mitigate the confusion about using multiple terms for the same configuration.

NOTE: The links and xrefs will be filled in in a different PR, because the content from other assemblies still needs to be moved to the new place, which means that if I filled the links now, I would have to keep repairing them later. So I am keeping that for a separate PR.

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 peer-review-needed Signifies that the peer review team needs to review this PR label Jan 16, 2025
@eromanova97
Copy link
Contributor Author

/remove-label peer-review-needed

@openshift-ci openshift-ci bot removed the peer-review-needed Signifies that the peer review team needs to review this PR label Jan 16, 2025
@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 Jan 16, 2025
@xenolinux xenolinux added peer-review-in-progress Signifies that the peer review team is reviewing this PR and removed peer-review-needed Signifies that the peer review team needs to review this PR labels Jan 16, 2025
Copy link
Contributor

@xenolinux xenolinux left a comment

Choose a reason for hiding this comment

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

A few comments; otherwise LGTM

@xenolinux xenolinux 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 labels Jan 16, 2025
@openshift-ci openshift-ci bot removed the lgtm Indicates that a PR is ready to be merged. label Jan 16, 2025
Copy link

openshift-ci bot commented Jan 16, 2025

New changes are detected. LGTM label has been removed.

@eromanova97
Copy link
Contributor Author

eromanova97 commented Jan 16, 2025

/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 Jan 16, 2025
@jeana-redhat jeana-redhat added the merge-review-in-progress Signifies that the merge review team is reviewing this PR label Jan 16, 2025
Copy link
Contributor

@jeana-redhat jeana-redhat left a comment

Choose a reason for hiding this comment

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

This is looking good! I found a couple tiny changes to make, and was thinking about the "before you begin" titles, but that last one is out of scope here and just for your consideration as you work on this.

/remove-label merge-review-in-progress
/remove-label merge-review-needed

Copy link
Contributor

Choose a reason for hiding this comment

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

Musing on structure...

So, I like the idea of "before you begin" but I am not sure if it's right as the assembly title. It makes sense to me as an introduction in that section, but right now we have a page called "before you begin" that includes a bunch of actual procedures under it. It also shows in the left nav as "before you begin" - not sure a user would expect to see so many procedures when they click that in the nav.

Does it make sense to call this assembly something elese and bump the "before you begin" content into a first subsection? Maybe something about "preparing", which would imply the need to read it first but also match expectations of a lot of procedural work?

NB: it is also very possible I am just misunderstanding :)

image

@openshift-ci openshift-ci bot removed 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 labels Jan 16, 2025
Copy link

openshift-ci bot commented Jan 17, 2025

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

@jeana-redhat jeana-redhat merged commit cff85a5 into openshift:monitoring-docs-restructure Jan 17, 2025
2 checks passed
@eromanova97 eromanova97 deleted the OBSDOCS1612 branch January 17, 2025 13:19
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. peer-review-done Signifies that the peer review team has reviewed this PR size/L Denotes a PR that changes 100-499 lines, ignoring generated files.

Projects

None yet

Development

Successfully merging this pull request may close these issues.

6 participants