Re: Docs falling out of sync with code

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Wed, Sep 21, 2016 at 9:33 PM, Dan Mick <dmick@xxxxxxxxxx> wrote:
> On 09/21/2016 03:29 PM, Sage Weil wrote:
>> On Wed, 21 Sep 2016, Dan Mick wrote:
>>> The upstream docs at http://ceph.com/docs can tend to become out of
>>> date.  We don't have much process to track things that need doc work.
>>>
>>> As a start, I propose we add a "docs needed" flag to tracker.ceph.com so
>>> that we can at least search things that add or change features through a
>>> tracker issue, and a "docs needed" label to github, so we can track it
>>> on PRs as well.
>>>
>>> Thoughts?  We can make this happen pretty quickly, and of course it's no
>>> perfect lock, but at least it may start contributors and reviewers
>>> thinking about the issue.
>>
>> We can make a 'needs-docs' tag for PRs in github.  If they don't block the
>> merge, then we can still search for them in open or closed prs, and make a
>> point of removing the tag once the docs are eventually updated.
>>
>> For the tracker, maybe a category for each project instead of a
>> separate tracker?  Not sure..
>>
>> sage
>
> Seemed like general consensus, so I've added both a "Needs Doc" checkbox
> to tracker and a "needs-doc" tag for PRs and GH issues.  See how they feel.

This is great Dan. Thank you!
>
> --
> To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
> the body of a message to majordomo@xxxxxxxxxxxxxxx
> More majordomo info at  http://vger.kernel.org/majordomo-info.html
--
To unsubscribe from this list: send the line "unsubscribe ceph-devel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html



[Index of Archives]     [CEPH Users]     [Ceph Large]     [Information on CEPH]     [Linux BTRFS]     [Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]
  Powered by Linux