reef-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Markus Weimer <mar...@weimo.de>
Subject Re: Location of build information
Date Tue, 22 Mar 2016 01:10:15 GMT
Now that the vote on [Documentation] commits is solved, the remaining
issue is whether we'd like to move the build instructions from the
wiki to the source code. Mariia, does the [Documentation] commit rule
address your concerns?

Markus

On Mon, Mar 14, 2016 at 11:43 PM, Brian Cho <chobrian@gmail.com> wrote:
> The messages all raise valid concerns.
>
> +1 placing build instructions with the source.
> +1 having an abbreviated commit process for the documentation.
>
> -Brian
>
> On Tue, Mar 15, 2016 at 11:29 AM, Markus Weimer <markus@weimo.de> wrote:
>
>> On 2016-03-14 18:32, Mariia Mykhailova wrote:
>>
>>> I'd rather keep it all in wiki and have README.md point to it,
>>> instead of the other way around, because then we can improve our
>>> instructions without creating separate JIRAs, PRs, reviews etc.
>>>
>>
>> True. On the other hand, our documentation also applies to a specific
>> version of REEF. For instance, the build instructions will soon say that
>> you can build REEF in Visual Studio 2015, which became true only
>> recently (and won't be true for the upcoming 0.14 release).
>>
>> We should probably separate the discussion of how expensive the
>> documentation updates are from the location of the documentation. For
>> instance, we can agree to have a [Documentation] in the commit message
>> for stuff that only changes the documentation and completely skip JIRA
>> and the review stage for those.
>>
>> Markus
>>

Mime
View raw message