Hey Thomas, We currently have an Installation Guide (which is specific to our build, but can be easily tweaked to refer to the upstream install method and includes a Proxy installation guide as well as a guide on using 3rd-party SSL certificates) and a Client Life Cycle Management Guide, which combines a User Guide with a Reference Guide.
Our documentation is not CC licensed yet, but if the Spacewalk project is interested, I will start the process with our legal team to relicense them. I wanted to see if there was interest before starting that process, because legal stuff can sometimes take longer than imagined. :) I wonder if it's worth combining forces between the upstream documentation (which is Creative Commons 3.0 SA licensed), our documentation and perhaps the SUSE Manager documentation and creating a ReadTheDocs.org project for Spacewalk so that the project documentation can be hosted and managed in the Spacewalk git repo. That way, we can also update the links within Spacewalk itself to point to Spacewalk-specific documentation, instead of to the Satellite/upstream docs. If so, I'm happy to volunteer to convert the existing wiki-based and upstream documentation into Markdown suitable for ReadTheDocs and then submit pull requests to the main Spacewalk repo. Thoughts? > On 2 Sep 2015, at 1:51 am, Tomas Lestach <tlest...@redhat.com> wrote: > > Hello Avi, > > what kind of documentation do you plan to work on? > > Spacewalk currently has some limited user documentation on Spacewalk wiki > pages. Except > of that we generate actual developer documentation with every Spacewalk > release. > > Otherwise we point users to the latest released Red Hat Satellite docs, > produced by > Red Hat professionals. :-) > > http://spacewalk.redhat.com/documentation.html > > Regards, > -- > Tomas Lestach > Red Hat Satellite Engineering, Red Hat > > > ----- Original Message ----- >> From: "Avi Miller" <avi.mil...@oracle.com> >> To: spacewalk-devel@redhat.com >> Sent: Sunday, August 30, 2015 12:20:49 AM >> Subject: [Spacewalk-devel] Spacewalk documentation >> >> Hey Spacewalkers, >> >> Is the upstream team interested in augmenting/increasing the >> available Spacewalk documentation? We're starting to develop more >> Spacewalk-related documentation and I was thinking about whether it >> was worth trying to merge upstream or not. >> >> If you did want more documentation, is there a particular >> format/layout/requirement that we should review? >> >> Thanks, >> Avi >> >> -- >> Oracle <http://www.oracle.com> >> Avi Miller | Product Management Director | +61 (3) 8616 3496 >> Oracle Linux and Virtualization >> 417 St Kilda Road, Melbourne, Victoria 3004 Australia >> >> >> _______________________________________________ >> Spacewalk-devel mailing list >> Spacewalk-devel@redhat.com >> https://www.redhat.com/mailman/listinfo/spacewalk-devel >> > > _______________________________________________ > Spacewalk-devel mailing list > Spacewalk-devel@redhat.com > https://www.redhat.com/mailman/listinfo/spacewalk-devel -- Oracle <http://www.oracle.com> Avi Miller | Product Management Director | +61 (3) 8616 3496 Oracle Linux and Virtualization 417 St Kilda Road, Melbourne, Victoria 3004 Australia _______________________________________________ Spacewalk-devel mailing list Spacewalk-devel@redhat.com https://www.redhat.com/mailman/listinfo/spacewalk-devel
