[katello-devel] [Katello] Git-based katello user docs

[Petr Chalupa]

I totally agree +100 :)

I would be for migrating wiki completely to git and MD files.

On 14.10.13 5:40, Justin Sherrill wrote:
>
> The katello project has sorely lacked good user documentation in the
> past and I've started work on remedying some of that.  Instead of going
> the normal wiki route, I thought about trying simple markdown files in git:
>
> https://github.com/jlsherrill/katello/blob/docs/doc/guides/content.md
> https://github.com/jlsherrill/katello/blob/docs/doc/guides/content_views.md
>
> (The content views documentation is still more or less a WIP)
>
> I wanted to get people's thoughts before I continued working or opened
> up a pull request.  After working through 1 1/2 pages, it seems much
> much easier than working with the trac-based fedora wiki.  A few of the
> benefits:
>
> * Much easier uploading of images (especially multiple images)
> * Easier syntax IMHO
> * Built in versioning
> * When editing within github itself, you can preview without a page
> reload.  A simple thing, but very nice.
> * Doc changes can be included with code pull requests. ("Hey, did you
> forget to update the docs??")
> * Doc updates/additions go through a review
>
> Thoughts?
>
> -Justin
>
> _______________________________________________
> katello-devel mailing list
> katello-devel at redhat.com
> https://www.redhat.com/mailman/listinfo/katello-devel