All of lore.kernel.org
 help / color / mirror / Atom feed
From: Adriana Kobylak <anoo@linux.ibm.com>
To: krtaylor <kurt.r.taylor@gmail.com>
Cc: Gunnar Mills <gmills@linux.vnet.ibm.com>,
	openbmc@lists.ozlabs.org,
	openbmc <openbmc-bounces+anoo=linux.ibm.com@lists.ozlabs.org>
Subject: Re: Improving the docs/ repo
Date: Wed, 23 Oct 2019 10:22:44 -0500	[thread overview]
Message-ID: <ae161ca3003366f6e1f260b83d932cc1@linux.vnet.ibm.com> (raw)
In-Reply-To: <3a4d96b9-8810-e57b-690d-5fd791bc57c0@gmail.com>

On 2019-10-23 08:51, krtaylor wrote:
> On 10/22/19 11:38 AM, Gunnar Mills wrote:
>> Looking to improve the docs/ repository.
>> Is anyone interested in getting involved in improving the document 
>> repository? Looking for either ideas or contributions.
>> 
>> Some ideas:
>> Better document the process for submitting documents which should 
>> improve the quality of documentation being submitted.
>> 
>> Design template improvement, spell out any additional expectations 
>> that come in review. E.g. All fields must be filled out, involve the 
>> community before submitting a template, avoid internal acronyms, 
>> expand on when the template is needed.

How do people feel about having smaller commits for the docs, like we 
encourage for source code? Would it make it easier to review? An example 
for designs would be one commit with the problem statement, next commit 
adds the requirements, next adds one solution proposal, etc.

  reply	other threads:[~2019-10-23 15:22 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2019-10-22 16:38 Improving the docs/ repo Gunnar Mills
2019-10-23 13:51 ` krtaylor
2019-10-23 15:22   ` Adriana Kobylak [this message]
2019-10-23 16:39     ` Vijay Khemka
2019-10-24 12:12     ` krtaylor

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=ae161ca3003366f6e1f260b83d932cc1@linux.vnet.ibm.com \
    --to=anoo@linux.ibm.com \
    --cc=gmills@linux.vnet.ibm.com \
    --cc=kurt.r.taylor@gmail.com \
    --cc=openbmc-bounces+anoo=linux.ibm.com@lists.ozlabs.org \
    --cc=openbmc@lists.ozlabs.org \
    /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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.