Improving the docs/ repo

[krtaylor]

On 10/23/19 10:22 AM, Adriana Kobylak wrote:
> 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.

This is absolutely the way it *should* be. Commits and/or wip. For the 
IRC averse and design documents, it lets the community know what you are 
planning and gives them the ability to be involved early on.

Kurt Taylor (krtaylor)