Katello Docs Day Result

Hi All

A good portion of the Katello team met yesterday to discuss and work on
Katello's Documentation.

We ended up focusing on two main options for hosting:

  • hosting via readthedocs.org
  • hosting via jeykll (either via github pages or our own jeykll instance)

Due to the preferences for Markdown formatting by many of those present
and the desire to host static content (api docs, bastion docs, etc…)
we are highly leaning towards hosting our own jeykll instance. This is
similar to how theforeman.org is done and would likely replace katello.org.

In the shorter term we are working on documentation in anticipation of
katello 1.5 and opening Pull Requests to a new repo
https://github.com/Katello/katello.org with the documentation.

Here is the etherpad we are currently using to track the docs work.
http://pad-katello.rhcloud.com/p/docs-day.

-Justin

Great! :slight_smile: +1 for jekyll and replacing katello.org

··· On 17.04.14 3:50, Justin Sherrill wrote: > Hi All > > A good portion of the Katello team met yesterday to discuss and work on > Katello's Documentation. > > We ended up focusing on two main options for hosting: > > * hosting via readthedocs.org > * hosting via jeykll (either via github pages or our own jeykll > instance) > > Due to the preferences for Markdown formatting by many of those present > and the desire to host static content (api docs, bastion docs, etc...) > we are highly leaning towards hosting our own jeykll instance. This is > similar to how theforeman.org is done and would likely replace katello.org. > > > In the shorter term we are working on documentation in anticipation of > katello 1.5 and opening Pull Requests to a new repo > https://github.com/Katello/katello.org with the documentation. > > Here is the etherpad we are currently using to track the docs work. > http://pad-katello.rhcloud.com/p/docs-day. > > -Justin >

FWIW Alex Wood just did some awesome work on a similar project to get
candlepin's website updated and off trac using markdown, jekyll, and
openshift.

New site: http://website-candlepinproject.rhcloud.com/

Source: https://github.com/candlepin/candlepinproject.org

··· On Mon, Apr 28, 2014 at 5:14 AM, Petr Chalupa wrote:

Great! :slight_smile: +1 for jekyll and replacing katello.org

On 17.04.14 3:50, Justin Sherrill wrote:

Hi All

A good portion of the Katello team met yesterday to discuss and work on
Katello’s Documentation.

We ended up focusing on two main options for hosting:

  • hosting via readthedocs.org
  • hosting via jeykll (either via github pages or our own jeykll
    instance)

Due to the preferences for Markdown formatting by many of those present
and the desire to host static content (api docs, bastion docs, etc…)
we are highly leaning towards hosting our own jeykll instance. This is
similar to how theforeman.org is done and would likely replace
katello.org.

In the shorter term we are working on documentation in anticipation of
katello 1.5 and opening Pull Requests to a new repo
https://github.com/Katello/katello.org with the documentation.

Here is the etherpad we are currently using to track the docs work.
http://pad-katello.rhcloud.com/p/docs-day.

-Justin


You received this message because you are subscribed to the Google Groups
"foreman-dev" group.
To unsubscribe from this group and stop receiving emails from it, send an
email to foreman-dev+unsubscribe@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.