Re: [Spacewalk-devel] Spacewalk documentation

[Tomas Lestach]

Hello Avi,

we're completely open to such possibility and would be happy to
host community documentation.

I'd suggest one modification.
Back in 2012 there was Spacewalk developer docs directly in the
git repository. We've removed it [1], because searching across
the repository using 'git grep' returned too many documentation
results, that were not relevant, when searching for source code.

So, not to have the documentation together with source code in one
git repository, what about if we would create a separate docs git
repository in the spacewalkproject organization [2] for this purpose?
We can grant direct access to such repository for involved people.

--
Tomas Lestach
Red Hat Satellite Engineering, Red Hat

[1] 
https://github.com/spacewalkproject/spacewalk/commit/6dff309698c686f85e2cf16f8226902b3d08efe2
[2] https://github.com/spacewalkproject


- Original Message -
> From: "Avi Miller" 
> To: spacewalk-devel@redhat.com
> Sent: Tuesday, September 1, 2015 11:02:42 PM
> Subject: Re: [Spacewalk-devel] Spacewalk documentation
> 
> 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 
> > 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" 
> >> 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 
> >> 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 
> 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

Re: [Spacewalk-devel] Spacewalk documentation

[Avi Miller]

Hey Thomas,

> On 8 Sep 2015, at 1:29 am, Tomas Lestach  wrote:
> 
> we're completely open to such possibility and would be happy to
> host community documentation.

Awesome.

> So, not to have the documentation together with source code in one
> git repository, what about if we would create a separate docs git
> repository in the spacewalkproject organization [2] for this purpose?
> We can grant direct access to such repository for involved people.

Also great. Plenty of projects do this too. Sites like readthedocs.org use an 
upstream git repo as the source for the documentation, but that doesn't have to 
be the same repo as the code itself. 

Therefore, I will start the internal process to get our documentation shifted 
to Creative Commons as well (to match the Satellite and SUSE Manager licenses) 
and will restate my willingness to act as "editor" (for want of a better word) 
to combine the three sets of documentation into RST for readthedocs.org.

I will let you know once I'm ready for repos to be created.

Cheers,
Avi

--
Oracle 
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

Re: [Spacewalk-devel] Spacewalk documentation

[Matthew Barnes]

Hi Avi,
I'm willing to assist if you need or want any help.
Matt



Sent from my Verizon Wireless 4G LTE smartphone


 Original message 
From: Avi Miller 
Date: 09/07/2015 4:43 PM (GMT-04:00)
To: spacewalk-devel@redhat.com
Subject: Re: [Spacewalk-devel] Spacewalk documentation

Hey Thomas,

> On 8 Sep 2015, at 1:29 am, Tomas Lestach  wrote:
>
> we're completely open to such possibility and would be happy to
> host community documentation.

Awesome.

> So, not to have the documentation together with source code in one
> git repository, what about if we would create a separate docs git
> repository in the spacewalkproject organization [2] for this purpose?
> We can grant direct access to such repository for involved people.

Also great. Plenty of projects do this too. Sites like readthedocs.org use an 
upstream git repo as the source for the documentation, but that doesn't have to 
be the same repo as the code itself.

Therefore, I will start the internal process to get our documentation shifted 
to Creative Commons as well (to match the Satellite and SUSE Manager licenses) 
and will restate my willingness to act as "editor" (for want of a better word) 
to combine the three sets of documentation into RST for readthedocs.org.

I will let you know once I'm ready for repos to be created.

Cheers,
Avi

--
Oracle 
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



ARBITRATION FORUMS INC.'S CONFIDENTIALITY NOTICE: This e-mail transmission and 
any attachments may contain legally confidential and privileged material for 
the sole use of the intended recipient(s). Any review or distribution by others 
is strictly prohibited. If you are not the intended recipient, please inform 
the sender and delete all copies of this message.

___
Spacewalk-devel mailing list
Spacewalk-devel@redhat.com
https://www.redhat.com/mailman/listinfo/spacewalk-devel

Re: [Spacewalk-devel] Spacewalk documentation

[Avi Miller]

Hey,

> On 8 Sep 2015, at 6:45 am, Matthew Barnes  wrote:
> 
> I'm willing to assist if you need or want any help.

Amazing, thanks. I need to get my legal team to approve a license shift of our 
documentation (emails have been sent to get all the VP/SVP approvals) and once 
that's done I'll write up an outline of my plan to incorporate the three 
sources into a single set of Spacewalk-specific documentation. 

We can then look at distributing the effort based on that plan. I suspect it'll 
probably be easiest if we split by document and my plan is to maintain the 
Satellite documentation naming, so we can maintain the Spacewalk help section 
UI, just point it to a different set of documents. 

Cheers,
Avi

--
Oracle 
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

Re: [Spacewalk-devel] Spacewalk documentation

[Matthew Barnes]

Understood I am standing by for further instructions, as things develop feel 
free to offload any work you feel is appropriate.

Matt



Sent from my Verizon Wireless 4G LTE smartphone


 Original message 
From: Avi Miller 
Date: 09/07/2015 5:06 PM (GMT-04:00)
To: spacewalk-devel@redhat.com
Subject: Re: [Spacewalk-devel] Spacewalk documentation

Hey,

> On 8 Sep 2015, at 6:45 am, Matthew Barnes  wrote:
>
> I'm willing to assist if you need or want any help.

Amazing, thanks. I need to get my legal team to approve a license shift of our 
documentation (emails have been sent to get all the VP/SVP approvals) and once 
that's done I'll write up an outline of my plan to incorporate the three 
sources into a single set of Spacewalk-specific documentation.

We can then look at distributing the effort based on that plan. I suspect it'll 
probably be easiest if we split by document and my plan is to maintain the 
Satellite documentation naming, so we can maintain the Spacewalk help section 
UI, just point it to a different set of documents.

Cheers,
Avi

--
Oracle 
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



ARBITRATION FORUMS INC.'S CONFIDENTIALITY NOTICE: This e-mail transmission and 
any attachments may contain legally confidential and privileged material for 
the sole use of the intended recipient(s). Any review or distribution by others 
is strictly prohibited. If you are not the intended recipient, please inform 
the sender and delete all copies of this message.

___
Spacewalk-devel mailing list
Spacewalk-devel@redhat.com
https://www.redhat.com/mailman/listinfo/spacewalk-devel