Re: [yast-devel] moving linuxrc documentation to github

2016-12-02 Thread Ancor Gonzalez Sosa
On 12/01/2016 03:46 PM, Devin Waas wrote:
> Hello YaSTheads,
> 
> in an effort to make documentation updated and consistent, I'm
> considering moving the linuxrc entries of the wiki[1] to github.
> 
> The motivations are:
> 1) we'll have docs and source in the same place (thus reducing the
> scattering of information)
> 2) we'll be able to render the docs on readthedocs.io/wherever
> 3) we'll have the benefits of a version control system (history/reviews)

Leaving the technical benefits aside, there is something like a rule of
thumb we are following with the YaST documentation:

- developer oriented documentation -> use git exactly as you suggested
- user oriented documentation -> keep the historical and well known
opensuse wiki

I can't wait for the day in which the openSUSE project completely change
the documentation approach/tooling (there have been several attempts
like adopting activedoc in doc.opensuse.org), but as long as wiki.o.o
continues being the expected place for documentation, we should probably
play by the rules.

Cheers.
-- 
Ancor González Sosa
YaST Team at SUSE Linux GmbH
-- 
To unsubscribe, e-mail: yast-devel+unsubscr...@opensuse.org
To contact the owner, e-mail: yast-devel+ow...@opensuse.org



Re: [yast-devel] moving linuxrc documentation to github

2016-12-01 Thread Johannes Meixner


Hello,

On Dec 1 15:46 Devin Waas wrote (excerpt):

moving the linuxrc entries of the wiki[1] to github.

...

https://en.opensuse.org/SDB:Linuxrc


Don't forget to adapt all openSUSE and SUSE 'internal'
stuff (e.g. manuals and whatever) that links to it, cf.
https://en.opensuse.org/Special:WhatLinksHere/SDB:Linuxrc

And don't forget to also adapt all 'external' stuff like
any pages on whatever other web severs that link to it ;-)

Seriously:
You would at least need to change
https://en.opensuse.org/SDB:Linuxrc
into some kind of automated forwarder that can somehow
redirect to the new place where the actual content is.
(I don't know how to do that with a Wiki.)


Kind Regards
Johannes Meixner
--
SUSE LINUX GmbH - GF: Felix Imendoerffer, Jane Smithard,
Graham Norton - HRB 21284 (AG Nuernberg)

--
To unsubscribe, e-mail: yast-devel+unsubscr...@opensuse.org
To contact the owner, e-mail: yast-devel+ow...@opensuse.org