From 25a914229a4ed191271af867434cf1891c16ad99 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Fri, 26 Feb 2021 00:38:11 +1000 Subject: [PATCH] doc/dev: rewrite t8y "reporting the issue" This commit rewrites the "Reporting the Issue" section, reflecting my better understanding of the various tools and parties in play. I also added a TL;DR-style summary (or argument) paragraph at the top of the section. Signed-off-by: Zac Dover --- ...tion-testing-teuthology-debugging-tips.rst | 28 +++++++++++-------- 1 file changed, 17 insertions(+), 11 deletions(-) diff --git a/doc/dev/developer_guide/testing_integration_tests/tests-integration-testing-teuthology-debugging-tips.rst b/doc/dev/developer_guide/testing_integration_tests/tests-integration-testing-teuthology-debugging-tips.rst index 899aad675e6..9f2ff0b11c0 100644 --- a/doc/dev/developer_guide/testing_integration_tests/tests-integration-testing-teuthology-debugging-tips.rst +++ b/doc/dev/developer_guide/testing_integration_tests/tests-integration-testing-teuthology-debugging-tips.rst @@ -84,17 +84,23 @@ will include the command that failed. Reporting the Issue ------------------- -After you have triaged the cause of the failure and you have determined that the -failure was not caused by the developer's code change, this might indicate a -known failure for the upstream branch (in our case, the upstream branch is -octopus). If the failure was not caused by a developer's code change, go to -https://tracker.ceph.com and look for tracker issues related to the failure by using keywords spotted in the failure under investigation. - -If a similar issue has been reported via a tracker.ceph.com ticket, add to it a -link to the new test run and any relevant feedback. If you don't find a ticket -referring to an issue similar to the one that you have discovered, create a new -tracker ticket for it. If you are not familiar with the cause of failure, ask -one of the team members for help. +In short: first check to see if your job failure was caused by a known issue, +and if it wasn't, raise a tracker ticket. + +After you have triaged the cause of the failure and you have determined that it +wasn't caused by the changes that you made to the code, this might indicate +that you have encountered a known failure in the upstream branch (in the +example we're considering in this section, the upstream branch is "octopus"). +If the failure was not caused by the changes you made to the code, go to +https://tracker.ceph.com and look for tracker issues related to the failure by +using keywords spotted in the failure under investigation. + +If you find a similar issue on https://tracker.ceph.com, leave a comment on +that issue explaining the failure as you understand it and make sure to +include a link to your recent test run. If you don't find a similar issue, +create a new tracker ticket for this issue and explain the cause of your job's +failure as thoroughly as you can. If you're not sure what caused the job's +failure, ask one of the team members for help. Debugging an issue using interactive-on-error --------------------------------------------- -- 2.47.3