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.

Sign up for GitHub

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

Jump to bottom

OBSDOCS-152: Collate storage docs and remove duplicated files #67049

Merged

abrennan89 merged 1 commit into openshift:main from abrennan89:OBSDOCS-460-storage

Dec 4, 2023

Contributor

abrennan89 commented Oct 27, 2023 •

edited

Version(s):
4.11+

Issue:

Link to docs preview:

QE review:

QE has approved this change.

abrennan89 added dev-tools branch/enterprise-4.11 branch/enterprise-4.12 branch/enterprise-4.13 branch/enterprise-4.14 labels

abrennan89 added this to the Continuous Release milestone

ocpdocs-previewbot commented Oct 27, 2023 •

edited

🤖 Updated build preview is available at:
https://67049--docspreview.netlify.app

Build log: https://circleci.com/gh/ocpdocs-previewbot/openshift-docs/35840

openshift-ci bot added size/L do-not-merge/work-in-progress labels

abrennan89 force-pushed the OBSDOCS-460-storage branch 2 times, most recently from e5d3acd to efd3367 Compare

November 1, 2023 15:24

abrennan89 added the branch/enterprise-4.15 label

abrennan89 force-pushed the OBSDOCS-460-storage branch 3 times, most recently from 45409f4 to dbb714a Compare

November 1, 2023 17:26

abrennan89 changed the title ~~[WIP] [OBSDOCS-152] Collate storage docs and remove duplicated files~~ [WIP] [OBSDOCS-152, OBSDOCS-460] Collate storage docs and remove duplicated files

abrennan89 force-pushed the OBSDOCS-460-storage branch 3 times, most recently from 1e44e8a to b6b6cbe Compare

November 2, 2023 19:04

openshift-merge-robot added the needs-rebase label

abrennan89 force-pushed the OBSDOCS-460-storage branch from b6b6cbe to 2f051e3 Compare

November 6, 2023 15:39

openshift-merge-robot removed the needs-rebase label

abrennan89 closed this

abrennan89 reopened this

abrennan89 force-pushed the OBSDOCS-460-storage branch 6 times, most recently from f7b1bcf to 500032a Compare

November 10, 2023 14:16

abrennan89 added the peer-review-needed label

ousleyp added the peer-review-in-progress label

ousleyp reviewed

View reviewed changes

Member

ousleyp left a comment

Overall, this looks great; just a few nits and some small pre-existing items to consider fixing in this PR. Thanks! :)

modules/cluster-logging-about-es-logstore.adoc Outdated Show resolved Hide resolved

logging/log_storage/logging-config-es-store.adoc Outdated Show resolved Hide resolved

logging/log_storage/logging-config-es-store.adoc Outdated Show resolved Hide resolved

modules/logging-loki-gui-install.adoc Outdated Show resolved Hide resolved

modules/logging-loki-gui-install.adoc

    
              +

              [NOTE]

              ====

              The Community Loki Operator is not supported by Red Hat.

              ====

              . On the *Install Operator* page, for *Update channel* select *stable*.

              . Select *stable* or *stable-x.y* as the *Update channel*.

Member

ousleyp Dec 1, 2023

If this isn't shown in the GUI as "stable-x.y" I would format it like a user-replaceable value: *stable-<x.y>*.

(If you make this change, it also applies to the logging-stable-updates-snip.adoc snippet.)

Contributor Author

abrennan89 Dec 1, 2023

This format appears in other places in our docs IIRC, so I will maybe follow them all up together afterwards if that's OK (https://docs.openshift.com/container-platform/4.14/logging/cluster-logging-deploying.html needs other updates anyway to make these consistent).

logging/log_storage/cluster-logging-loki.adoc

Comment on lines 1 to 5

    
              :_mod-docs-content-type: ASSEMBLY

              :context: cluster-logging-loki

              [id="cluster-logging-loki"]

              = Logging using LokiStack

              = Configuring the LokiStack log store

              include::_attributes/common-attributes.adoc[]

Member

ousleyp Dec 1, 2023

I am not sure if this impacts anything, but the assembly file metadata is slightly out of order. The :context: line normally follows the common-attributes include statement.

https://github.com/openshift/openshift-docs/blob/main/contributing_to_docs/doc_guidelines.adoc#assembly-file-metadata

logging/log_storage/cluster-logging-loki.adoc Outdated Show resolved Hide resolved

logging/log_storage/log-storage-overview.adoc Outdated Show resolved Hide resolved

logging/log_storage/log-storage-overview.adoc Outdated Show resolved Hide resolved

logging/log_storage/log-storage-overview.adoc Outdated Show resolved Hide resolved

ousleyp added peer-review-done and removed peer-review-in-progress peer-review-needed labels

abrennan89 force-pushed the OBSDOCS-460-storage branch from acb640c to 9f45af0 Compare

December 1, 2023 21:05

openshift-ci bot removed the lgtm label

openshift-ci bot commented Dec 1, 2023

New changes are detected. LGTM label has been removed.

Contributor Author

abrennan89 commented Dec 1, 2023

@ousleyp thanks so much for the great review!
I took most of the suggestions if you want to take another look, otherwise I will merge next week, since I believe I will need some manual CPs for older OCP versions 😄
Happy Friday! 🥳

Member

ousleyp commented Dec 1, 2023

@ousleyp thanks so much for the great review! I took most of the suggestions if you want to take another look, otherwise I will merge next week, since I believe I will need some manual CPs for older OCP versions 😄 Happy Friday! 🥳

Sounds perfectly reasonable to me! Happy Friday!! :)


          remove duplicated content, collate install docs

189405f

abrennan89 force-pushed the OBSDOCS-460-storage branch from 9f45af0 to 189405f Compare

December 4, 2023 15:38

abrennan89 merged commit 3cf9bce into openshift:main

1 check passed

Contributor Author

abrennan89 commented Dec 4, 2023

/cherrypick enterprise-4.15

Contributor Author

abrennan89 commented Dec 4, 2023

/cherrypick enterprise-4.14

Contributor Author

abrennan89 commented Dec 4, 2023

/cherrypick enterprise-4.13

Contributor Author

abrennan89 commented Dec 4, 2023

/cherrypick enterprise-4.12

Contributor Author

abrennan89 commented Dec 4, 2023

/cherrypick enterprise-4.11

openshift-cherrypick-robot mentioned this pull request

[enterprise-4.15] [OBSDOCS-152] Collate storage docs and remove duplicated files #68842

Merged

openshift-cherrypick-robot commented Dec 4, 2023

@abrennan89: new pull request created: #68842

In response to this:

/cherrypick enterprise-4.15

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/test-infra repository.

openshift-cherrypick-robot commented Dec 4, 2023

@abrennan89: new pull request created: #68843

In response to this:

/cherrypick enterprise-4.14

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/test-infra repository.

openshift-cherrypick-robot mentioned this pull request

[enterprise-4.14] [OBSDOCS-152] Collate storage docs and remove duplicated files #68843

Merged

openshift-cherrypick-robot commented Dec 4, 2023

@abrennan89: #67049 failed to apply on top of branch "enterprise-4.13":

Applying: remove duplicated content, collate install docs
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map.yml
M	_topic_maps/_topic_map_osd.yml
M	_topic_maps/_topic_map_rosa.yml
M	logging/cluster-logging-deploying.adoc
M	logging/cluster-logging-loki.adoc
M	modules/cluster-logging-manual-rollout-rolling.adoc
M	post_installation_configuration/storage-configuration.adoc
M	service_mesh/v2x/ossm-reference-jaeger.adoc
M	snippets/logging-compatibility-snip.adoc
M	snippets/logging-stable-updates-snip.adoc
M	virt/support/virt-troubleshooting.adoc
Falling back to patching base and 3-way merge...
Auto-merging virt/support/virt-troubleshooting.adoc
Auto-merging snippets/logging-stable-updates-snip.adoc
Auto-merging snippets/logging-compatibility-snip.adoc
Auto-merging service_mesh/v2x/ossm-reference-jaeger.adoc
Auto-merging post_installation_configuration/storage-configuration.adoc
Removing modules/logging-deploy-loki-console.adoc
Auto-merging modules/cluster-logging-manual-rollout-rolling.adoc
Removing modules/cluster-logging-loki-deploy.adoc
Auto-merging logging/log_storage/cluster-logging-loki.adoc
CONFLICT (content): Merge conflict in logging/log_storage/cluster-logging-loki.adoc
Auto-merging logging/cluster-logging-deploying.adoc
CONFLICT (content): Merge conflict in logging/cluster-logging-deploying.adoc
Auto-merging _topic_maps/_topic_map_rosa.yml
Auto-merging _topic_maps/_topic_map_osd.yml
Auto-merging _topic_maps/_topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 remove duplicated content, collate install docs
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherrypick enterprise-4.13

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/test-infra repository.

openshift-cherrypick-robot commented Dec 4, 2023

@abrennan89: #67049 failed to apply on top of branch "enterprise-4.12":

Applying: remove duplicated content, collate install docs
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map.yml
M	_topic_maps/_topic_map_osd.yml
M	_topic_maps/_topic_map_rosa.yml
M	logging/cluster-logging-deploying.adoc
M	logging/log_collection_forwarding/log-forwarding.adoc
M	modules/cluster-logging-manual-rollout-rolling.adoc
M	network_observability/installing-operators.adoc
M	post_installation_configuration/storage-configuration.adoc
M	service_mesh/v1x/ossm-custom-resources.adoc
M	snippets/logging-compatibility-snip.adoc
M	snippets/logging-stable-updates-snip.adoc
A	virt/support/virt-troubleshooting.adoc
Falling back to patching base and 3-way merge...
CONFLICT (modify/delete): virt/support/virt-troubleshooting.adoc deleted in HEAD and modified in remove duplicated content, collate install docs. Version remove duplicated content, collate install docs of virt/support/virt-troubleshooting.adoc left in tree.
Auto-merging snippets/logging-stable-updates-snip.adoc
Auto-merging snippets/logging-compatibility-snip.adoc
Auto-merging service_mesh/v1x/ossm-custom-resources.adoc
Auto-merging post_installation_configuration/storage-configuration.adoc
Auto-merging network_observability/installing-operators.adoc
Removing modules/logging-deploy-loki-console.adoc
Auto-merging modules/cluster-logging-manual-rollout-rolling.adoc
Removing modules/cluster-logging-loki-deploy.adoc
Auto-merging logging/log_collection_forwarding/log-forwarding.adoc
Auto-merging logging/cluster-logging-deploying.adoc
CONFLICT (content): Merge conflict in logging/cluster-logging-deploying.adoc
Auto-merging _topic_maps/_topic_map_rosa.yml
Auto-merging _topic_maps/_topic_map_osd.yml
Auto-merging _topic_maps/_topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 remove duplicated content, collate install docs
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherrypick enterprise-4.12

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/test-infra repository.

openshift-cherrypick-robot commented Dec 4, 2023

@abrennan89: #67049 failed to apply on top of branch "enterprise-4.11":

Applying: remove duplicated content, collate install docs
Using index info to reconstruct a base tree...
M	_topic_maps/_topic_map.yml
M	_topic_maps/_topic_map_osd.yml
M	_topic_maps/_topic_map_rosa.yml
M	logging/cluster-logging-deploying.adoc
M	logging/cluster-logging-loki.adoc
M	logging/log_collection_forwarding/log-forwarding.adoc
M	modules/cluster-logging-loki-deploy.adoc
M	modules/cluster-logging-manual-rollout-rolling.adoc
M	network_observability/installing-operators.adoc
M	post_installation_configuration/storage-configuration.adoc
A	scalability_and_performance/optimization/optimizing-storage.adoc
M	service_mesh/v1x/ossm-custom-resources.adoc
M	snippets/logging-compatibility-snip.adoc
M	snippets/logging-stable-updates-snip.adoc
A	virt/support/virt-troubleshooting.adoc
Falling back to patching base and 3-way merge...
CONFLICT (modify/delete): virt/support/virt-troubleshooting.adoc deleted in HEAD and modified in remove duplicated content, collate install docs. Version remove duplicated content, collate install docs of virt/support/virt-troubleshooting.adoc left in tree.
Auto-merging snippets/logging-stable-updates-snip.adoc
Auto-merging snippets/logging-compatibility-snip.adoc
Auto-merging service_mesh/v1x/ossm-custom-resources.adoc
Auto-merging scalability_and_performance/optimizing-storage.adoc
CONFLICT (content): Merge conflict in scalability_and_performance/optimizing-storage.adoc
Auto-merging post_installation_configuration/storage-configuration.adoc
Auto-merging network_observability/installing-operators.adoc
Removing modules/logging-deploy-loki-console.adoc
Auto-merging modules/cluster-logging-manual-rollout-rolling.adoc
CONFLICT (modify/delete): modules/cluster-logging-loki-deploy.adoc deleted in remove duplicated content, collate install docs and modified in HEAD. Version HEAD of modules/cluster-logging-loki-deploy.adoc left in tree.
Auto-merging logging/log_storage/cluster-logging-loki.adoc
CONFLICT (content): Merge conflict in logging/log_storage/cluster-logging-loki.adoc
Auto-merging logging/log_collection_forwarding/log-forwarding.adoc
Auto-merging logging/cluster-logging-deploying.adoc
CONFLICT (content): Merge conflict in logging/cluster-logging-deploying.adoc
Auto-merging _topic_maps/_topic_map_rosa.yml
CONFLICT (content): Merge conflict in _topic_maps/_topic_map_rosa.yml
Auto-merging _topic_maps/_topic_map_osd.yml
CONFLICT (content): Merge conflict in _topic_maps/_topic_map_osd.yml
Auto-merging _topic_maps/_topic_map.yml
error: Failed to merge in the changes.
hint: Use 'git am --show-current-patch=diff' to see the failed patch
Patch failed at 0001 remove duplicated content, collate install docs
When you have resolved this problem, run "git am --continue".
If you prefer to skip this patch, run "git am --skip" instead.
To restore the original branch and stop patching, run "git am --abort".

In response to this:

/cherrypick enterprise-4.11

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/test-infra repository.

abrennan89 changed the title ~~[OBSDOCS-152] Collate storage docs and remove duplicated files~~ OBSDOCS-152: Collate storage docs and remove duplicated files

This was referenced Dec 4, 2023

[enterprise-4.13] OBSDOCS-152: Collate storage docs and remove duplicated files #68844

Merged

[enterprise-4.12] OBSDOCS-152: Collate storage docs and remove duplicated files #68845

Merged

[enterprise-4.11] OBSDOCS-152: Collate storage docs and remove duplicated files #68849

Merged

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

xperimental xperimental approved these changes

periklis periklis left review comments

anpingli anpingli left review comments

ousleyp ousleyp left review comments

gkarager gkarager left review comments