summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorThorsten Leemhuis <linux@leemhuis.info>2026-03-17 13:33:04 +0100
committerJonathan Corbet <corbet@lwn.net>2026-03-22 14:47:53 -0600
commitc423d3295a760da0f2943c5c14f9c3e8fae04390 (patch)
treed1358267c4d33bba27a029867dbaca9521193219
parenta0529bbe70d74e495b682933955e5938245ad84b (diff)
downloadlwn-c423d3295a760da0f2943c5c14f9c3e8fae04390.tar.gz
lwn-c423d3295a760da0f2943c5c14f9c3e8fae04390.zip
docs: reporting-issues: mention text is best viewed rendered
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@leemhuis.info> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Message-ID: <f8e3577df4a231b66e8f638f7b41614bf15b49ab.1773750701.git.linux@leemhuis.info>
-rw-r--r--Documentation/admin-guide/reporting-issues.rst10
1 files changed, 10 insertions, 0 deletions
diff --git a/Documentation/admin-guide/reporting-issues.rst b/Documentation/admin-guide/reporting-issues.rst
index a68e6d909274..049dd9b66351 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
=================================================================