)]}'
{"doc/source/contributor/grenade-upgrade.rst":[{"robot_id":"zuul","robot_run_id":"1c2b9238055c4f5d987537c3e80290cc","url":"https://zuul.teim.app/t/main/buildset/1c2b9238055c4f5d987537c3e80290cc","author":{"_account_id":28006,"name":"teim-ci","display_name":"teim-ci","email":"ci@seanmooney.info","username":"ci-sean-mooney","status":"this is a third-party ci account run by sean-k-mooney on irc\nhosted at zuul.teim.app"},"tag":"autogenerated:zuul:automatic-ci","change_message_id":"809b8ea091f6dbd2cc9dabab8d0f18801446e48b","patch_set":4,"id":"0b2dc93f_a518dcfd","line":1,"updated":"2026-04-10 10:43:53.000000000","message":"The grenade-upgrade.rst is a relative symlink (../../../devstack/upgrade/README.rst) which may break the Sphinx build depending on how the document is published. Symlinks in RST source trees are fragile and not all Sphinx builders follow them correctly.\n\n**Severity**: HIGH | **Confidence**: 0.8\n\n**Risk**: Sphinx build may fail or produce a broken page if the symlink is not resolved. ReadTheDocs and some CI builders do not preserve symlinks.\n\n**Priority**: Before merge\n**Why This Matters**: A broken doc page for grenade upgrade testing defeats the purpose of documenting it, and build failures block doc publication for the entire project.\n\n**Recommendation**:\nReplace the symlink with an .. include:: directive or copy the content into a proper RST file with a reference back to the source. For example, create a new grenade-upgrade.rst file with \u0027.. include:: ../../../devstack/upgrade/README.rst\u0027 or use a proper Sphinx cross-reference.","commit_id":"df9ed4998badee36d509f6e3b41b186e24169963"}],"doc/source/contributor/tempest-testing.rst":[{"robot_id":"zuul","robot_run_id":"cef697a5aee844a5ad66fc48912cc578","url":"https://zuul.teim.app/t/main/buildset/cef697a5aee844a5ad66fc48912cc578","author":{"_account_id":28006,"name":"teim-ci","display_name":"teim-ci","email":"ci@seanmooney.info","username":"ci-sean-mooney","status":"this is a third-party ci account run by sean-k-mooney on irc\nhosted at zuul.teim.app"},"tag":"autogenerated:zuul:automatic-ci","change_message_id":"7bd1859725e0d7aae92c267972c28bbf075d0f7e","patch_set":1,"id":"4e6a957d_8f0b376b","line":25,"updated":"2026-04-01 11:42:35.000000000","message":"The prerequisites mention \u0027fake driver\u0027 as an option alongside real hardware and emulated devices, but there is no guidance on how to enable the fake driver, which is the simplest path for new contributors wanting to run tempest tests.\n\n**Severity**: SUGGESTION | **Confidence**: 0.8\n\n**Benefit**: Lowering the barrier to entry for new contributors who want to verify tempest tests without needing hardware or NVMe emulation setup.\n\n**Recommendation**:\nAdd a brief note in the Prerequisites section explaining that the fake driver can be enabled by adding \u0027CYBORG_ENABLED_DRIVERS\u003dfake_driver\u0027 to local.conf, or link to the devstack_setup guide which already covers this.","commit_id":"7c26a12589a97eaa05cc5e72444b542e20f6083d"},{"robot_id":"zuul","robot_run_id":"cef697a5aee844a5ad66fc48912cc578","url":"https://zuul.teim.app/t/main/buildset/cef697a5aee844a5ad66fc48912cc578","author":{"_account_id":28006,"name":"teim-ci","display_name":"teim-ci","email":"ci@seanmooney.info","username":"ci-sean-mooney","status":"this is a third-party ci account run by sean-k-mooney on irc\nhosted at zuul.teim.app"},"tag":"autogenerated:zuul:automatic-ci","change_message_id":"7bd1859725e0d7aae92c267972c28bbf075d0f7e","patch_set":1,"id":"91c2bd08_b554fa07","line":79,"updated":"2026-04-01 11:42:35.000000000","message":"Section underline for \u0027List Cyborg tempest plugin\u0027 (line 79-81) uses 28 dashes but the title text is 27 characters, creating a mismatch. RST is lenient about this but it is inconsistent with the exact-length convention used throughout the rest of the file and other Cyborg contributor docs.\n\n**Severity**: WARNING | **Confidence**: 0.8\n\n**Impact**: While Sphinx tolerates mismatched underline lengths, it can cause warnings during the build and is inconsistent with the project\u0027s existing documentation style.\n\n**Suggestion**:\nChange the underline to exactly 27 dashes to match \u0027List Cyborg tempest plugin\u0027 (27 characters), consistent with how all other section underlines in the file use exact-length matching.","commit_id":"7c26a12589a97eaa05cc5e72444b542e20f6083d"},{"robot_id":"zuul","robot_run_id":"cef697a5aee844a5ad66fc48912cc578","url":"https://zuul.teim.app/t/main/buildset/cef697a5aee844a5ad66fc48912cc578","author":{"_account_id":28006,"name":"teim-ci","display_name":"teim-ci","email":"ci@seanmooney.info","username":"ci-sean-mooney","status":"this is a third-party ci account run by sean-k-mooney on irc\nhosted at zuul.teim.app"},"tag":"autogenerated:zuul:automatic-ci","change_message_id":"7bd1859725e0d7aae92c267972c28bbf075d0f7e","patch_set":1,"id":"b4f6b5b6_af50f32e","line":100,"updated":"2026-04-01 11:42:35.000000000","message":"Empty line at the end of the \u0027Run All Cyborg Tests\u0027 section (between lines 100 and 102) introduces a blank line between the section heading underline and the body text, which is valid RST but inconsistent with the tight spacing used in most other sections of this document.\n\n**Severity**: WARNING | **Confidence**: 0.7\n\n**Impact**: Minor visual inconsistency in the rendered documentation. The extra blank line may create slightly more vertical space in the HTML output compared to other sections.\n\n**Suggestion**:\nRemove the extra blank line between the \u0027Run All Cyborg Tests\u0027 section heading and its body paragraph for consistency with the rest of the document.","commit_id":"7c26a12589a97eaa05cc5e72444b542e20f6083d"},{"robot_id":"zuul","robot_run_id":"cef697a5aee844a5ad66fc48912cc578","url":"https://zuul.teim.app/t/main/buildset/cef697a5aee844a5ad66fc48912cc578","author":{"_account_id":28006,"name":"teim-ci","display_name":"teim-ci","email":"ci@seanmooney.info","username":"ci-sean-mooney","status":"this is a third-party ci account run by sean-k-mooney on irc\nhosted at zuul.teim.app"},"tag":"autogenerated:zuul:automatic-ci","change_message_id":"7bd1859725e0d7aae92c267972c28bbf075d0f7e","patch_set":1,"id":"706cc6cd_69548cdf","line":110,"updated":"2026-04-01 11:42:35.000000000","message":"Malformed tempest run command: \u0027tempest run -\u0027 uses a stray dash before \u0027--config-file\u0027, making the command incorrect and potentially confusing to users who copy-paste it.\n\n**Severity**: HIGH | **Confidence**: 0.9\n\n**Risk**: Users copying the command with the stray \u0027-\u0027 will get an error from tempest, causing confusion and wasted debugging time.\n\n**Priority**: Before merge\n**Why This Matters**: Documentation with incorrect commands defeats the purpose of a testing guide and erodes trust in the project documentation.\n\n**Recommendation**:\nChange \u0027tempest run - --config-file etc/tempest.conf -regex cyborg_tempest_plugin.tests.api\u0027 to \u0027tempest run --config-file etc/tempest.conf --regex cyborg_tempest_plugin.tests.api\u0027 on line 110. Also check line 116 which has the same stray dash pattern.","commit_id":"7c26a12589a97eaa05cc5e72444b542e20f6083d"},{"robot_id":"zuul","robot_run_id":"cef697a5aee844a5ad66fc48912cc578","url":"https://zuul.teim.app/t/main/buildset/cef697a5aee844a5ad66fc48912cc578","author":{"_account_id":28006,"name":"teim-ci","display_name":"teim-ci","email":"ci@seanmooney.info","username":"ci-sean-mooney","status":"this is a third-party ci account run by sean-k-mooney on irc\nhosted at zuul.teim.app"},"tag":"autogenerated:zuul:automatic-ci","change_message_id":"7bd1859725e0d7aae92c267972c28bbf075d0f7e","patch_set":1,"id":"6197283f_1b0466e7","line":116,"updated":"2026-04-01 11:42:35.000000000","message":"Malformed tempest run command on line 116: \u0027tempest run -\u0027 has the same stray dash before \u0027--config-file\u0027 as line 110, producing an invalid command.\n\n**Severity**: HIGH | **Confidence**: 0.9\n\n**Risk**: Users following the scenario test instructions will encounter a command error, preventing them from running scenario tests.\n\n**Priority**: Before merge\n**Why This Matters**: Consistent documentation errors across multiple commands suggest the author may not have tested these commands, raising concerns about all command accuracy in the document.\n\n**Recommendation**:\nChange \u0027tempest run - --config-file etc/tempest.conf -regex cyborg_tempest_plugin.tests.scenario\u0027 to \u0027tempest run --config-file etc/tempest.conf --regex cyborg_tempest_plugin.tests.scenario\u0027. Also fix line 110 which has the same issue.","commit_id":"7c26a12589a97eaa05cc5e72444b542e20f6083d"},{"robot_id":"zuul","robot_run_id":"cef697a5aee844a5ad66fc48912cc578","url":"https://zuul.teim.app/t/main/buildset/cef697a5aee844a5ad66fc48912cc578","author":{"_account_id":28006,"name":"teim-ci","display_name":"teim-ci","email":"ci@seanmooney.info","username":"ci-sean-mooney","status":"this is a third-party ci account run by sean-k-mooney on irc\nhosted at zuul.teim.app"},"tag":"autogenerated:zuul:automatic-ci","change_message_id":"7bd1859725e0d7aae92c267972c28bbf075d0f7e","patch_set":1,"id":"8f78670b_e1564a38","line":134,"updated":"2026-04-01 11:42:35.000000000","message":"Double spaces before \u0027--config-file\u0027 on line 134: \u0027tempest run  --config-file\u0027 has two spaces between \u0027run\u0027 and \u0027--config-file\u0027, inconsistent with the single-space formatting used elsewhere in the same file.\n\n**Severity**: WARNING | **Confidence**: 0.9\n\n**Impact**: Cosmetic inconsistency in documentation formatting that could cause confusion or look unpolished in the rendered output.\n\n**Suggestion**:\nRemove the extra space on line 134 so it reads \u0027tempest run --config-file etc/tempest.conf --regex cyborg_tempest_plugin.tests.api.test_devices.TestDevices.test_list_devices\u0027.","commit_id":"7c26a12589a97eaa05cc5e72444b542e20f6083d"},{"robot_id":"zuul","robot_run_id":"cef697a5aee844a5ad66fc48912cc578","url":"https://zuul.teim.app/t/main/buildset/cef697a5aee844a5ad66fc48912cc578","author":{"_account_id":28006,"name":"teim-ci","display_name":"teim-ci","email":"ci@seanmooney.info","username":"ci-sean-mooney","status":"this is a third-party ci account run by sean-k-mooney on irc\nhosted at zuul.teim.app"},"tag":"autogenerated:zuul:automatic-ci","change_message_id":"7bd1859725e0d7aae92c267972c28bbf075d0f7e","patch_set":1,"id":"1f2706cc_9d0a41fa","line":136,"updated":"2026-04-01 11:42:35.000000000","message":"The \u0027Detailed Test Logs\u0027 section could include a cross-reference to Tempest\u0027s official logging documentation for users who need more information about interpreting test logs.\n\n**Severity**: SUGGESTION | **Confidence**: 0.6\n\n**Benefit**: Users encountering test failures would have a direct reference for understanding tempest\u0027s logging format and log file locations.\n\n**Recommendation**:\nAdd a link to the Tempest logging documentation (https://docs.openstack.org/tempest/latest/runner.html) in the \u0027Detailed Test Logs\u0027 section for users who need more information about interpreting test logs.","commit_id":"7c26a12589a97eaa05cc5e72444b542e20f6083d"},{"robot_id":"zuul","robot_run_id":"cef697a5aee844a5ad66fc48912cc578","url":"https://zuul.teim.app/t/main/buildset/cef697a5aee844a5ad66fc48912cc578","author":{"_account_id":28006,"name":"teim-ci","display_name":"teim-ci","email":"ci@seanmooney.info","username":"ci-sean-mooney","status":"this is a third-party ci account run by sean-k-mooney on irc\nhosted at zuul.teim.app"},"tag":"autogenerated:zuul:automatic-ci","change_message_id":"7bd1859725e0d7aae92c267972c28bbf075d0f7e","patch_set":1,"id":"ca396ec4_a3e45155","line":167,"updated":"2026-04-01 11:42:35.000000000","message":"The document uses \u0027source ~/devstack/openrc admin admin\u0027 on line 167 but other existing contributor docs (devstack_setup.rst line 95) use \u0027source openrc admin admin\u0027 without the ~/devstack/ prefix, which assumes a specific working directory.\n\n**Severity**: SUGGESTION | **Confidence**: 0.8\n\n**Benefit**: Consistency across contributor documentation reduces cognitive load and prevents confusion about correct paths.\n\n**Recommendation**:\nConsider aligning with the existing convention in devstack_setup.rst by using \u0027source openrc admin admin\u0027 and noting the assumption that the user is in the ~/devstack directory, or keep the full path but add a note that the user should adjust the path if their DevStack is installed elsewhere.","commit_id":"7c26a12589a97eaa05cc5e72444b542e20f6083d"},{"robot_id":"zuul","robot_run_id":"cef697a5aee844a5ad66fc48912cc578","url":"https://zuul.teim.app/t/main/buildset/cef697a5aee844a5ad66fc48912cc578","author":{"_account_id":28006,"name":"teim-ci","display_name":"teim-ci","email":"ci@seanmooney.info","username":"ci-sean-mooney","status":"this is a third-party ci account run by sean-k-mooney on irc\nhosted at zuul.teim.app"},"tag":"autogenerated:zuul:automatic-ci","change_message_id":"7bd1859725e0d7aae92c267972c28bbf075d0f7e","patch_set":1,"id":"ef44670a_cafe8ba8","line":174,"updated":"2026-04-01 11:42:35.000000000","message":"The \u0027Adding New Tests\u0027 section could benefit from mentioning tempest coding conventions or referencing the Tempest test writing guide to help new test authors follow best practices.\n\n**Severity**: SUGGESTION | **Confidence**: 0.7\n\n**Benefit**: Better guidance for contributors writing new tempest tests, improving test quality and reducing review cycles.\n\n**Recommendation**:\nConsider adding a reference to the Tempest coding guidelines or the Tempest test writing guide in the \u0027Adding New Tests\u0027 section, and mention using tempestlib base test classes.","commit_id":"7c26a12589a97eaa05cc5e72444b542e20f6083d"},{"robot_id":"zuul","robot_run_id":"cef697a5aee844a5ad66fc48912cc578","url":"https://zuul.teim.app/t/main/buildset/cef697a5aee844a5ad66fc48912cc578","author":{"_account_id":28006,"name":"teim-ci","display_name":"teim-ci","email":"ci@seanmooney.info","username":"ci-sean-mooney","status":"this is a third-party ci account run by sean-k-mooney on irc\nhosted at zuul.teim.app"},"tag":"autogenerated:zuul:automatic-ci","change_message_id":"7bd1859725e0d7aae92c267972c28bbf075d0f7e","patch_set":1,"id":"d676dace_e1ddb986","line":191,"updated":"2026-04-01 11:42:35.000000000","message":"The \u0027Adding New Tests\u0027 section uses numbered list items 1-5 but items 3-5 are very brief single-line entries without the detail level of items 1-2, creating an uneven list structure.\n\n**Severity**: SUGGESTION | **Confidence**: 0.7\n\n**Benefit**: Improved readability and consistency in the documentation structure.\n\n**Recommendation**:\nEither expand items 3-5 with more detail (similar to how nvme-driver.rst provides thorough explanations) or convert them to bullet points since they are general guidance rather than sequential steps.","commit_id":"7c26a12589a97eaa05cc5e72444b542e20f6083d"},{"robot_id":"zuul","robot_run_id":"1c2b9238055c4f5d987537c3e80290cc","url":"https://zuul.teim.app/t/main/buildset/1c2b9238055c4f5d987537c3e80290cc","author":{"_account_id":28006,"name":"teim-ci","display_name":"teim-ci","email":"ci@seanmooney.info","username":"ci-sean-mooney","status":"this is a third-party ci account run by sean-k-mooney on irc\nhosted at zuul.teim.app"},"tag":"autogenerated:zuul:automatic-ci","change_message_id":"809b8ea091f6dbd2cc9dabab8d0f18801446e48b","patch_set":4,"id":"5e11d8dc_b6e36232","line":79,"updated":"2026-04-10 10:43:53.000000000","message":"The section heading \u0027List Cyborg tempest plugin\u0027 uses dash underline of only 4 dashes (\u0027----\u0027) which is too short for the heading text (28 chars). RST section underlines should be at least as long as the heading text.\n\n**Severity**: WARNING | **Confidence**: 0.9\n\n**Impact**: Sphinx will emit a warning and the section hierarchy may render incorrectly. Long-term, this creates a SEVERE/WARNING in doc builds that contributors must triage.\n\n**Suggestion**:\nExtend the underline to at least match the heading length. Change \u0027----\u0027 to \u0027--------------------------\u0027 (28 dashes) or longer.","commit_id":"df9ed4998badee36d509f6e3b41b186e24169963"},{"robot_id":"zuul","robot_run_id":"1c2b9238055c4f5d987537c3e80290cc","url":"https://zuul.teim.app/t/main/buildset/1c2b9238055c4f5d987537c3e80290cc","author":{"_account_id":28006,"name":"teim-ci","display_name":"teim-ci","email":"ci@seanmooney.info","username":"ci-sean-mooney","status":"this is a third-party ci account run by sean-k-mooney on irc\nhosted at zuul.teim.app"},"tag":"autogenerated:zuul:automatic-ci","change_message_id":"809b8ea091f6dbd2cc9dabab8d0f18801446e48b","patch_set":4,"id":"5ab9a14b_6803d3d3","line":92,"updated":"2026-04-10 10:43:53.000000000","message":"The tempest-testing.rst has inconsistent heading underline lengths. Section \u0027Run All Cyborg Tests\u0027 uses 5 dashes but the heading is 21 characters. Also \u0027Detailed Test Logs\u0027 uses 4 dashes for 18 characters.\n\n**Severity**: SUGGESTION | **Confidence**: 0.9\n\n**Benefit**: Consistent and valid RST formatting ensures clean Sphinx builds without warnings and correct section hierarchy rendering.\n\n**Recommendation**:\nEnsure all section underlines are at least as long as their heading text. For \u0027Run All Cyborg Tests\u0027 use at least 21 dashes. For \u0027Detailed Test Logs\u0027 use at least 18 dashes. Apply the same fix to \u0027Check Cyborg Service Logs\u0027 (23 chars, needs 23 dashes) and \u0027Verify Device Discovery\u0027 (24 chars, needs 24 dashes).","commit_id":"df9ed4998badee36d509f6e3b41b186e24169963"}]}