[katello-devel] Developer documentation

[Petr Chalupa]

created https://trello.com/c/fO46zToU

On 14.06.13 9:54, Petr Chalupa wrote:
> A huge +1 from me as well. Thanks David.
> Lets create a Github issue or Trello story to track it.
>
> We should also create a issue/story about migration of Katello.org to
> Jenkins and github pages.
>
> Petr
>
> On 13.06.13 17:11, Eric D Helms wrote:
>>
>>
>>
>> On Thu, Jun 13, 2013 at 10:49 AM, David Davis <daviddavis at redhat.com
>> <mailto:daviddavis at redhat.com>> wrote:
>>
>>     Petr and I were discussing where to put some developer documentation
>>     recently and we figured we'd probably open up the discussion to
>>     everyone. Since we've added YARD to our project, we now have another
>>     place where we can store docs related to Katello (see
>>     http://katello.github.io/katello/).
>>
>>
>> We've discussed this in the past and I feel like a lot of people were on
>> board. I can't recall the specific attachments people had to the wiki
>> page. A huge +1 from me.
>>
>>     I think there would be some advantages to moving our developer
>>     documentation into our repo/YARD like being able to review changes
>>     via pull requests, being able to link to the code, and having the
>>     docs in a more convenient place for developers. That said, there are
>>     also some disadvantages too like having to move a lot of existing
>>     documentation over.
>>
>> I would argue this is an advantage as it means the documentation can get
>> reviewed and cleaned-up as part of the move.
>>
>>
>>     Please respond though if you have any opinions about what guidelines
>>     we should use for where to put documentation.
>>
>>     David
>>
>>     _______________________________________________
>>     katello-devel mailing list
>>     katello-devel at redhat.com <mailto:katello-devel at redhat.com>
>>     https://www.redhat.com/mailman/listinfo/katello-devel
>>
>>
>>
>>
>> _______________________________________________
>> katello-devel mailing list
>> katello-devel at redhat.com
>> https://www.redhat.com/mailman/listinfo/katello-devel
>>
>
> _______________________________________________
> katello-devel mailing list
> katello-devel at redhat.com
> https://www.redhat.com/mailman/listinfo/katello-devel