Skip to content

RFE-821 - Adding to the support section. #23316

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
Merged
bobfuru merged 1 commit into from
Jul 27, 2020
Merged

RFE-821 - Adding to the support section. #23316

bobfuru merged 1 commit into from
Jul 27, 2020

Conversation

@pneedle-rh
Copy link
Contributor

@pneedle-rh pneedle-rh commented Jun 26, 2020 •
edited
Loading

Applies to enterprise-4.5 onward. This is the first phase of a new Troubleshooting Guide for OCP 4. Initially content is being added to the Support book.

This relates to https://issues.redhat.com/browse/RFE-821.

Previews available at:

https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/getting-support.html
https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/gathering-cluster-data.html
https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/summarizing-cluster-specifications.html
https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/troubleshooting/troubleshooting-installations.html
https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/troubleshooting/verifying-node-health.html
https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/troubleshooting/troubleshooting-crio-issues.html
https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/troubleshooting/troubleshooting-operator-issues.html
https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/troubleshooting/investigating-pod-issues.html
https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/troubleshooting/troubleshooting-s2i.html
https://troubleshooting_guide--ocpdocs.netlify.app/openshift-enterprise/latest/support/troubleshooting/diagnosing-oc-issues.html

@pneedle-rh
Copy link
Contributor Author

pneedle-rh commented Jun 26, 2020

@openshift/team-documentation for peer review please. Please can someone also add 'Peer Review Needed', 'branch/enterprise-4.5', 'labels and 'Next Release' milestone? Thanks!'. This content is for enterprise-4.5 onward.

@pneedle-rh pneedle-rh force-pushed the troubleshooting_guide branch 3 times, most recently from c752422 to b339ca5 Compare June 26, 2020 16:01
@openshift-docs-preview-bot
Copy link

openshift-docs-preview-bot commented Jun 26, 2020

The preview will be available shortly at:

@pneedle-rh pneedle-rh force-pushed the troubleshooting_guide branch from b339ca5 to 563d96e Compare June 26, 2020 16:11
@bobfuru bobfuru self-requested a review June 26, 2020 16:30
@bobfuru bobfuru added this to the Future Release milestone Jun 26, 2020
sferich888
sferich888 approved these changes Jun 26, 2020
View reviewed changes
Copy link
Contributor

@sferich888 sferich888 left a comment

Choose a reason for hiding this comment

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

This looks great, I have a few nits, here and there but overall this is a strong foundation for us to build on.

modules/understanding-pod-error-states.adoc Outdated
Copy link
Contributor

@sferich888 sferich888 Jun 26, 2020

Choose a reason for hiding this comment

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

Is there a way this can automatically be generated?

@deads2k @mfojtik

Copy link
Contributor Author

@pneedle-rh pneedle-rh Jul 6, 2020

Choose a reason for hiding this comment

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

@deads2k @mfojtik can you please confirm this? Thanks!

@pneedle-rh pneedle-rh force-pushed the troubleshooting_guide branch from 563d96e to bfd24c8 Compare June 26, 2020 17:49
bobfuru
bobfuru reviewed Jun 26, 2020
View reviewed changes
Copy link
Contributor

@bobfuru bobfuru left a comment •
edited
Loading

Choose a reason for hiding this comment

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

Hey Paul - This is an unparalleled effort and will be an enormous asset to our customers. Thanks for letting me review it.

My comments are mostly of the nitpick variety, calling out a few of our OCP and ISG style conventions, such as serial commas and using attributes like {product-title} wherever possible.

You'll also see at times where I suggested adding some more articles to the verbiage, such as "Gather the journald unit logs" rather than "Gather journald unit logs". I think this would help make it sound more human-to-human, but you may have chosen to exclude some of this language to cut down on length or to conform to troubleshooting/support norms, which would be understandable.

Let me know if you need clarification or want to discuss anything further. Great work, Paul!

@bobfuru bobfuru added the peer-review-done Signifies that the peer review team has reviewed this PR label Jun 26, 2020
@pneedle-rh pneedle-rh force-pushed the troubleshooting_guide branch 4 times, most recently from b5902d9 to e2a8cba Compare June 29, 2020 13:04
bergerhoffer
bergerhoffer reviewed Jun 29, 2020
View reviewed changes
Copy link
Contributor

@bergerhoffer bergerhoffer 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 from a run through of a few of the sections

@pneedle-rh pneedle-rh force-pushed the troubleshooting_guide branch 11 times, most recently from ae16a11 to c4f665d Compare June 29, 2020 16:32
bergerhoffer
bergerhoffer reviewed Jun 29, 2020
View reviewed changes
Copy link
Contributor

@bergerhoffer bergerhoffer left a comment

Choose a reason for hiding this comment

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

Last batch of comments. Ton of great info here!

@pneedle-rh pneedle-rh force-pushed the troubleshooting_guide branch 3 times, most recently from 6b29595 to c395a51 Compare July 23, 2020 10:35
@pneedle-rh
Copy link
Contributor Author

pneedle-rh commented Jul 23, 2020

@xltian I believe I have now responded to each of the QE comments from the team in this document. Can you please let me know whether there are any more QE reviews to go? Can you please confirm whether the QE team are now happy for this PR to be merged? Thanks!

@pneedle-rh pneedle-rh force-pushed the troubleshooting_guide branch 2 times, most recently from d6f0f71 to eba2b5b Compare July 23, 2020 11:27
@zhouying7780
Copy link

zhouying7780 commented Jul 24, 2020

Look good to me for modules/specifying-oc-log-levels.adoc

gpei
gpei reviewed Jul 24, 2020
View reviewed changes
@jinyunma
Copy link

jinyunma commented Jul 24, 2020

looks good to me for  "troubleshooting-installations" section

@wsun1
Copy link

wsun1 commented Jul 24, 2020

@pneedle-rh , most of sections look good to QE, once @gpei 's comment is resolved, QE is fine for this PR.

@pneedle-rh pneedle-rh force-pushed the troubleshooting_guide branch from eba2b5b to 67974ee Compare July 24, 2020 09:36
@pneedle-rh
Copy link
Contributor Author

pneedle-rh commented Jul 24, 2020

@pneedle-rh , most of sections look good to QE, once @gpei 's comment is resolved, QE is fine for this PR.

Thank you @wsun1, that is great. I have now resolved @gpei's comment.

@bobfuru @bergerhoffer can you please let me know if you have any further suggestions before this PR is merged? A number of changes were made following QE review. Thanks!

bobfuru
bobfuru reviewed Jul 24, 2020
View reviewed changes
bobfuru
bobfuru reviewed Jul 24, 2020
View reviewed changes
@pneedle-rh pneedle-rh force-pushed the troubleshooting_guide branch 2 times, most recently from 2f793ca to 8dc7e4f Compare July 24, 2020 15:33
adellape
adellape reviewed Jul 24, 2020
View reviewed changes
Copy link
Contributor

@adellape adellape left a comment •
edited
Loading

Choose a reason for hiding this comment

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

NICE. 😙:ok_hand:

bobfuru
bobfuru reviewed Jul 24, 2020
View reviewed changes
Copy link
Contributor

@bobfuru bobfuru left a comment

Choose a reason for hiding this comment

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

Looks great! A couple of places where the formatting was off but the rest of my comments are tiny nits. Thanks for letting me review this again.

@pneedle-rh pneedle-rh force-pushed the troubleshooting_guide branch from 8dc7e4f to aa00760 Compare July 27, 2020 10:05
@pneedle-rh pneedle-rh force-pushed the troubleshooting_guide branch from aa00760 to dfd9ac4 Compare July 27, 2020 10:33
@pneedle-rh
Copy link
Contributor Author

pneedle-rh commented Jul 27, 2020 •
edited
Loading

@bobfuru my understanding is that this PR has now passed through peer, SME and QE approval. If you are happy with my responses to your final review comments, can you please merge and CP for branch/enterprise-4.5 and branch/enterprise-4.6? Thanks!

@bobfuru
Copy link
Contributor

bobfuru commented Jul 27, 2020

LGTM

@bobfuru bobfuru merged commit fbf4bbf into openshift:master Jul 27, 2020
@bobfuru
Copy link
Contributor

bobfuru commented Jul 27, 2020

/cherrypick enterprise-4.5

@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Jul 27, 2020

@bobfuru: #23316 failed to apply on top of branch "enterprise-4.5":

Details

In response to this:

/cherrypick enterprise-4.5

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.

@bobfuru
Copy link
Contributor

bobfuru commented Jul 27, 2020

/cherrypick enterprise-4.6

@openshift-cherrypick-robot
Copy link

openshift-cherrypick-robot commented Jul 27, 2020

@bobfuru: #23316 failed to apply on top of branch "enterprise-4.6":

Details

In response to this:

/cherrypick enterprise-4.6

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.

This was referenced Jul 27, 2020
Merged
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bergerhoffer bergerhoffer bergerhoffer left review comments

+9 more reviewers

@jboxman jboxman jboxman left review comments

@gpei gpei gpei left review comments

@vikram-redhat vikram-redhat vikram-redhat left review comments

@adellape adellape adellape left review comments

@zhaozhanqi zhaozhanqi zhaozhanqi left review comments

@zhouying7780 zhouying7780 zhouying7780 left review comments

@bobfuru bobfuru bobfuru left review comments

@jinyunma jinyunma jinyunma left review comments

@sferich888 sferich888 sferich888 approved these changes

Reviewers whose approvals may not affect merge requirements

Assignees

@zhaozhanqi zhaozhanqi

Labels

branch/enterprise-4.5 branch/enterprise-4.6 peer-review-done Signifies that the peer review team has reviewed this PR size/XXL Denotes a PR that changes 1000+ lines, ignoring generated files.

Projects

None yet

Milestone

Next Release

Development

Successfully merging this pull request may close these issues.