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

[David Davis]

I like working with the Github files much better than Trac. However, my concern would be the use of it for user docs. I think user docs have a different audience than dev docs--an audience that might not know how to use git or Github. 

I wonder though if there's maybe some way we could put the user docs into a specific folder and then somehow automatically publish them to a web address. I think that would solve the problem.

David

----- Original Message -----
| From: "Petr Chalupa" <pchalupa at redhat.com>
| To: "Justin Sherrill" <jsherril at redhat.com>
| Cc: "foreman-dev" <foreman-dev at googlegroups.com>, katello-devel at redhat.com
| Sent: Monday, October 14, 2013 2:32:11 AM
| Subject: Re: [katello-devel] [Katello] Git-based katello user docs
| 
| 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
| 
| _______________________________________________
| katello-devel mailing list
| katello-devel at redhat.com
| https://www.redhat.com/mailman/listinfo/katello-devel
|