[PATCH v2 1/5] docs: reporting-issues: mention text is best viewed rendered
From: Thorsten Leemhuis
Date: Tue Mar 17 2026 - 08:43:47 EST
Add a comment before the step-by-step guide explaining that the document
is best viewed in the rendered form, as there the internal links will
work that later patches will add.
Signed-off-by: Thorsten Leemhuis <linux@xxxxxxxxxxxxx>
---
v2
- Drop the switch from double to single quotes
v1 – https://lore.kernel.org/all/4f7e2de2a2336c52e55cc49dcda627a4e86b8793.1761481839.git.linux@xxxxxxxxxxxxx/
- Initial version
---
Documentation/admin-guide/reporting-issues.rst | 10 ++++++++++
1 file changed, 10 insertions(+)
diff --git a/Documentation/admin-guide/reporting-issues.rst b/Documentation/admin-guide/reporting-issues.rst
index a68e6d90927471..049dd9b663513d 100644
--- a/Documentation/admin-guide/reporting-issues.rst
+++ b/Documentation/admin-guide/reporting-issues.rst
@@ -48,6 +48,16 @@ Once the report is out, answer any questions that come up and help where you
can. That includes keeping the ball rolling by occasionally retesting with newer
releases and sending a status update afterwards.
+..
+ Note: If you see this note, you are reading the text's source file. You
+ might want to switch to a rendered version: It makes it a lot easier to
+ read and navigate this document -- especially when you want to look something
+ up in the reference section, then jump back to where you left off.
+..
+ Find the latest rendered version of this text here:
+ https://docs.kernel.org/admin-guide/reporting-issues.html
+
+
Step-by-step guide how to report issues to the kernel maintainers
=================================================================
--
2.53.0