From: Mark Brown <broonie@kernel.org>
To: Mike Rapoport <rppt@linux.ibm.com>
Cc: ksummit <ksummit-discuss@lists.linuxfoundation.org>
Subject: Re: [Ksummit-discuss] [TECH TOPIC] Documentation
Date: Fri, 12 Jun 2020 11:58:09 +0100 [thread overview]
Message-ID: <20200612105809.GC5396@sirena.org.uk> (raw)
In-Reply-To: <20200612091939.GG2051223@linux.ibm.com>
[-- Attachment #1.1: Type: text/plain, Size: 1301 bytes --]
On Fri, Jun 12, 2020 at 12:19:39PM +0300, Mike Rapoport wrote:
> On Fri, Jun 12, 2020 at 11:18:52AM +0300, Laurent Pinchart wrote:
> > This would however leave some developers in an uncomfortable situation.
> > While writing documentation is no fun for most of us, it gets much worse
> > for developers who are less fluent in English. Learning how to write
> > good documentation is hard enough without having to also learn a new
> > language. I think this is a problem that needs to be addressed on its
> > own.
> I think we should make a distinction between adding new documentation
> and updating the existing one. I agree that writing documentation is not
> easy, especially when you need to write it from scratch. But making
> small amends to the existing documentation along with the code changes
> so that docs and code would still much is not that difficult.
> For such cases a request to have documentation update as a part of the
> changes wouldn't be too much to ask.
I wouldn't underestimate the barriers this can create for developers who
are less fluent in English, take a browse through changelogs sometime.
There's a big jump from being able to write understandable code and
communicate what it's about to being able to write clear and useful
documentation.
[-- Attachment #1.2: signature.asc --]
[-- Type: application/pgp-signature, Size: 488 bytes --]
[-- Attachment #2: Type: text/plain, Size: 186 bytes --]
_______________________________________________
Ksummit-discuss mailing list
Ksummit-discuss@lists.linuxfoundation.org
https://lists.linuxfoundation.org/mailman/listinfo/ksummit-discuss
next prev parent reply other threads:[~2020-06-12 10:58 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
2020-06-09 20:53 [Ksummit-discuss] [TECH TOPIC] Documentation Jonathan Corbet
2020-06-10 8:49 ` Dan Carpenter
2020-06-11 8:21 ` Daniel Vetter
2020-06-11 14:48 ` Linus Walleij
2020-06-11 18:03 ` Shuah Khan
2020-06-11 18:28 ` Joe Perches
2020-06-11 19:44 ` Shuah Khan
2020-06-12 8:18 ` Laurent Pinchart
2020-06-12 9:19 ` Mike Rapoport
2020-06-12 10:58 ` Mark Brown [this message]
2020-06-12 15:48 ` Shuah Khan
2020-06-12 9:07 ` Mike Rapoport
2020-06-12 16:08 ` Shuah Khan
2020-06-13 16:42 ` Julia Lawall
2020-06-13 16:51 ` Joe Perches
2020-06-13 17:04 ` Julia Lawall
2020-06-14 13:23 ` Matthew Wilcox
2020-06-14 14:13 ` Mike Rapoport
2020-06-15 9:46 ` Jani Nikula
2020-06-18 9:04 ` Mike Rapoport
2020-06-18 14:40 ` Joe Perches
[not found] ` <20200709122118.0ffaea91@coco.lan>
2020-07-09 11:42 ` Joe Perches
2020-07-09 12:11 ` Mike Rapoport
2020-07-09 16:59 ` Joe Perches
2020-07-09 17:29 ` Mike Rapoport
2020-07-09 17:57 ` Andrew Lunn
[not found] ` <104986.1594328429@turing-police>
2020-07-10 0:03 ` Joe Perches
2020-06-13 17:05 ` Laurent Pinchart
2020-06-18 9:08 ` Mike Rapoport
-- strict thread matches above, loose matches on Subject: below --
2019-06-12 14:54 Jonathan Corbet
2019-06-12 18:22 ` Shuah Khan
2019-06-12 19:12 ` Martin K. Petersen
2019-06-12 19:43 ` Shuah Khan
2019-06-13 14:25 ` Mauro Carvalho Chehab
2019-06-14 21:40 ` Shuah Khan
2019-06-15 0:05 ` Mauro Carvalho Chehab
2019-06-17 10:12 ` Mauro Carvalho Chehab
2019-06-17 17:21 ` Mauro Carvalho Chehab
2019-06-12 20:33 ` Kate Stewart
2019-06-13 14:17 ` Mauro Carvalho Chehab
2019-06-13 14:57 ` Mauro Carvalho Chehab
2019-06-13 18:48 ` Greg KH
2019-06-13 19:01 ` Mauro Carvalho Chehab
2019-06-20 18:36 ` Kees Cook
2019-06-20 19:28 ` Jonathan Corbet
2019-07-22 14:52 ` Mauro Carvalho Chehab
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20200612105809.GC5396@sirena.org.uk \
--to=broonie@kernel.org \
--cc=ksummit-discuss@lists.linuxfoundation.org \
--cc=rppt@linux.ibm.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).