summaryrefslogtreecommitdiffstats
path: root/Documentation/doc-guide
diff options
context:
space:
mode:
authorVegard Nossum <vegard.nossum@oracle.com>2024-01-11 10:48:38 +0100
committerJonathan Corbet <corbet@lwn.net>2024-01-30 13:16:46 -0700
commit60804e5889fe3b87d71be9b50322cfacf21117e1 (patch)
tree3694aeaf4d9add92380f5ce5180989ffce3bc9fb /Documentation/doc-guide
parente5a5276695b0df12eea8a694afc8bca87a8162a4 (diff)
downloadlinux-stable-60804e5889fe3b87d71be9b50322cfacf21117e1.tar.gz
linux-stable-60804e5889fe3b87d71be9b50322cfacf21117e1.tar.bz2
linux-stable-60804e5889fe3b87d71be9b50322cfacf21117e1.zip
docs: add blurb about target audience to maintainer-profile
It's good to be clear about who the intended target audience for any given piece of documentation is, as this will help us put new text in the correct place. Let's encourage submitters to state it explicitly rather than relying on where they placed it in the directory hierarchy as there isn't necessarily a one-to-one correspondence between them. Target audience: documentation contributors and reviewers. Signed-off-by: Vegard Nossum <vegard.nossum@oracle.com> Acked-by: Randy Dunlap <rdunlap@infradead.org> Signed-off-by: Jonathan Corbet <corbet@lwn.net> Link: https://lore.kernel.org/r/20240111094838.3695697-1-vegard.nossum@oracle.com
Diffstat (limited to 'Documentation/doc-guide')
-rw-r--r--Documentation/doc-guide/maintainer-profile.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/Documentation/doc-guide/maintainer-profile.rst b/Documentation/doc-guide/maintainer-profile.rst
index 755d39f0d407..db3636d0d71d 100644
--- a/Documentation/doc-guide/maintainer-profile.rst
+++ b/Documentation/doc-guide/maintainer-profile.rst
@@ -27,6 +27,13 @@ documentation and ensure that no new errors or warnings have been
introduced. Generating HTML documents and looking at the result will help
to avoid unsightly misunderstandings about how things will be rendered.
+All new documentation (including additions to existing documents) should
+ideally justify who the intended target audience is somewhere in the
+changelog; this way, we ensure that the documentation ends up in the correct
+place. Some possible categories are: kernel developers (experts or
+beginners), userspace programmers, end users and/or system administrators,
+and distributors.
+
Key cycle dates
---------------