Red Hat Bugzilla – Bug 1298713
Why does the documentation guide direct you to the output of logs?
Last modified: 2016-04-18 21:55:42 EDT
Section Number and Name:
15.3. DEPLOYING THE EFK STACK
Describe the issue:
Just before step 2, the documentation says:
When it runs, check the logs of the resulting pod (oc logs -f <pod_name>) for some instructions to follow after deployment. More details are given below.
Which seems to provide some fairly standardized information, why is this _not_ directly included in the guide for deploying the EFK stack?
Suggestions for improvement:
Include this information directly into the documentation so the user can continue to just follow the guide.
I could be incorrect and the information is simply spread about the docs in other locations, please correct me if this is the case.
I talked to the relevant people about this, and took a look myself, and it's a case of misleading words.
Checking the output of the logs isn't entirely necessary, and really only contains the steps also found in the docs, but personalised for your cluster. The main reason for checking the logs is to ensure the pod was deployed correctly.
This info has been submitted in this PR, which will hopefully merge soon:
Let me know if there's anything else for this BZ.
I read the proposed changes and they make much more sense, I agree that it seems to have been an issue of misleading words.
Thank you for that clarification!
This BZ has been fixed in the following section of PR #1641:
Moving this to complete.