[yast-devel] YaST module documentation
Hi, I'm looking for documentation or a guide on how to write a yast module. Is there anything available? Or is there a module you'd recommend to look at first? Regards, Nanuk -- Nanuk Krinner - Systems Management Engineer SUSE LINUX Products GmbH, Maxfeldstr. 5, D-90409 Nuernberg Tel: +49-911-74053-577 - nkrinner@suse.de GF: Jeff Hawn, Jennifer Guild, Felix Imendörffer, HRB 21284 (AG Nürnberg) -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
On Thu, 28 Nov 2013 15:21:39 +0100 Nanuk Krinner <nkrinner@suse.de> wrote:
Hi,
I'm looking for documentation or a guide on how to write a yast module. Is there anything available? Or is there a module you'd recommend to look at first?
Regards, Nanuk
Hi Nanuk, welcome to yast development. For documentation there is some ancient parts available at [1] but after conversion to ruby big part of it is no longer valid. We plan to make new documentation which we start at [2], but it is far from complete now. For modules that you can take as example I recommend yast2-services-manager that is new module to handle systemd services and do not use deprecated stuff from ycp conversion[3]. There is plan to write one more new module, but it is not yet started. If you have any questions feel free to ask us, we can then update documentation to include all important stuff. Also we can point you to more specific document that describe part in which you are interested in. Josef [1] http://doc.opensuse.org/projects/YaST/openSUSE11.3/ [2] https://en.opensuse.org/openSUSE:YaST_development_reboot [3] https://github.com/yast/yast-services-manager -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
Hi Josef, On Thu, 28 Nov 2013 15:28:41 +0100 Josef Reidinger <jreidinger@suse.cz> wrote: [...]
If you have any questions feel free to ask us, we can then update documentation to include all important stuff. Also we can point you to more specific document that describe part in which you are interested in.
Thanks for the fast response! I'll let you know when I have more questions. Regards, Nanuk
Josef
[1] http://doc.opensuse.org/projects/YaST/openSUSE11.3/ [2] https://en.opensuse.org/openSUSE:YaST_development_reboot [3] https://github.com/yast/yast-services-manager
-- Nanuk Krinner - Systems Management Engineer SUSE LINUX Products GmbH, Maxfeldstr. 5, D-90409 Nuernberg Tel: +49-911-74053-577 - nkrinner@suse.de GF: Jeff Hawn, Jennifer Guild, Felix Imendörffer, HRB 21284 (AG Nürnberg) -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
On 11/28/2013 03:28 PM, Josef Reidinger wrote:
On Thu, 28 Nov 2013 15:21:39 +0100 Nanuk Krinner <nkrinner@suse.de> wrote:
Hi,
I'm looking for documentation or a guide on how to write a yast module. Is there anything available? Or is there a module you'd recommend to look at first?
Regards, Nanuk
Hi Nanuk, welcome to yast development. For documentation there is some ancient parts available at [1] but after conversion to ruby big part of it is no longer valid. We plan to make new documentation which we start at [2], but it is far from complete now. For modules that you can take as example I recommend yast2-services-manager that is new module to handle systemd services and do not use deprecated stuff from ycp conversion[3]. There is plan to write one more new module, but it is not yet started. If you have any questions feel free to ask us, we can then update documentation to include all important stuff. Also we can point you to more specific document that describe part in which you are interested in.
A very useful advise Josef gave me when I was going to start my own module some days ago (I'm just copying and pasting his words): "It is important to understand at start directory structure under src initial mapping is at https://github.com/yast/ycp-killer/#new-yast-module-structure but it miss explanation. In general the most important are modules (which is singleton holder and provider of shared functionality), clients (scripts called to perform action), include (old deprecated way to include shared code) and new lib (which is common ruby code here). If you plan to write something from scratch I recommend to use only clients and lib, having common ruby modules, classes etc in lib and clients which you plan to run in clients." This paragraph should be somewhere, was really useful to me. Cheers. -- Ancor González Sosa openSUSE Team at SUSE Linux GmbH -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
On Thu, 28 Nov 2013 16:08:48 +0100 Ancor Gonzalez Sosa <ancor@suse.de> wrote:
On 11/28/2013 03:28 PM, Josef Reidinger wrote:
On Thu, 28 Nov 2013 15:21:39 +0100 Nanuk Krinner <nkrinner@suse.de> wrote:
Hi,
I'm looking for documentation or a guide on how to write a yast module. Is there anything available? Or is there a module you'd recommend to look at first?
Regards, Nanuk
Hi Nanuk, welcome to yast development. For documentation there is some ancient parts available at [1] but after conversion to ruby big part of it is no longer valid. We plan to make new documentation which we start at [2], but it is far from complete now. For modules that you can take as example I recommend yast2-services-manager that is new module to handle systemd services and do not use deprecated stuff from ycp conversion[3]. There is plan to write one more new module, but it is not yet started. If you have any questions feel free to ask us, we can then update documentation to include all important stuff. Also we can point you to more specific document that describe part in which you are interested in.
A very useful advise Josef gave me when I was going to start my own module some days ago (I'm just copying and pasting his words):
"It is important to understand at start directory structure under src initial mapping is at https://github.com/yast/ycp-killer/#new-yast-module-structure but it miss explanation. In general the most important are modules (which is singleton holder and provider of shared functionality), clients (scripts called to perform action), include (old deprecated way to include shared code) and new lib (which is common ruby code here). If you plan to write something from scratch I recommend to use only clients and lib, having common ruby modules, classes etc in lib and clients which you plan to run in clients."
This paragraph should be somewhere, was really useful to me.
Cheers.
Hi Ancor, in fact I am just working on wiki page with this structure in spare time between NI dev&testing, so hopefully It will be public soon. Josef -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
On Thu, 28 Nov 2013 16:28:05 +0100 Josef Reidinger <jreidinger@suse.cz> wrote:
On Thu, 28 Nov 2013 16:08:48 +0100 Ancor Gonzalez Sosa <ancor@suse.de> wrote:
On 11/28/2013 03:28 PM, Josef Reidinger wrote:
On Thu, 28 Nov 2013 15:21:39 +0100 Nanuk Krinner <nkrinner@suse.de> wrote:
Hi,
I'm looking for documentation or a guide on how to write a yast module. Is there anything available? Or is there a module you'd recommend to look at first?
Regards, Nanuk
Hi Nanuk, welcome to yast development. For documentation there is some ancient parts available at [1] but after conversion to ruby big part of it is no longer valid. We plan to make new documentation which we start at [2], but it is far from complete now. For modules that you can take as example I recommend yast2-services-manager that is new module to handle systemd services and do not use deprecated stuff from ycp conversion[3]. There is plan to write one more new module, but it is not yet started. If you have any questions feel free to ask us, we can then update documentation to include all important stuff. Also we can point you to more specific document that describe part in which you are interested in.
A very useful advise Josef gave me when I was going to start my own module some days ago (I'm just copying and pasting his words):
"It is important to understand at start directory structure under src initial mapping is at https://github.com/yast/ycp-killer/#new-yast-module-structure but it miss explanation. In general the most important are modules (which is singleton holder and provider of shared functionality), clients (scripts called to perform action), include (old deprecated way to include shared code) and new lib (which is common ruby code here). If you plan to write something from scratch I recommend to use only clients and lib, having common ruby modules, classes etc in lib and clients which you plan to run in clients."
This paragraph should be somewhere, was really useful to me.
Cheers.
Hi Ancor, in fact I am just working on wiki page with this structure in spare time between NI dev&testing, so hopefully It will be public soon.
Josef
And initial version [1]. It is wiki, so feel free to improve it, extend it or ask me if something is not clear, so I can make it better for other developers. Josef [1] http://en.opensuse.org/openSUSE:YaST:_Code_Organization -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
Hello Josef, Am Donnerstag, 28. November 2013, 17:10:33 schrieb Josef Reidinger:
On Thu, 28 Nov 2013 16:28:05 +0100 And initial version [1]. It is wiki, so feel free to improve it, extend it or ask me if something is not clear, so I can make it better for other developers.
Josef
Can any make a Docu from the YasT2 Module witch Variables Indexes is used in Ldap The background is, when you have a external LDAP Server it is a Problem to find out the correct Variables or the needed Indexes usw. -- mit freundlichen Grüßen / best Regards, Günther J. Niederwimmer -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
On Thu, 28 Nov 2013 22:09:49 +0100 Günther J. Niederwimmer <gjn@gjn.priv.at> wrote:
Hello Josef,
Am Donnerstag, 28. November 2013, 17:10:33 schrieb Josef Reidinger:
On Thu, 28 Nov 2013 16:28:05 +0100 And initial version [1]. It is wiki, so feel free to improve it, extend it or ask me if something is not clear, so I can make it better for other developers.
Josef
Can any make a Docu from the YasT2 Module witch Variables Indexes is used in Ldap
The background is, when you have a external LDAP Server it is a Problem to find out the correct Variables or the needed Indexes usw.
Hi Günther, I don't understand what you exactly need. Can you be more specific what documentation you need? I recognize that you need something with ldap-client, so I add yardoc configuration to this module and generate online documentation [1]. If you need something specific, please try to be more specific, I don't understand what you mean with Variable Indexes. If you can point me to source code, it can also helps to understand which part you are interested in. Josef [1] http://www.rubydoc.info/github/yast/yast-ldap-client/master/frames -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
On Thu, Nov 28, 2013 at 05:10:33PM +0100, Josef Reidinger wrote:
And initial version [1]. It is wiki, so feel free to improve it, extend it or ask me if something is not clear, so I can make it better for other developers.
Josef
Thank you! I have now documented the less common src/* subdirectories. -- Martin Vidner, Cloud & Systems Management Team http://en.opensuse.org/User:Mvidner Kuracke oddeleni v restauraci je jako fekalni oddeleni v bazenu
participants (5)
-
Ancor Gonzalez Sosa
-
Günther J. Niederwimmer
-
Josef Reidinger
-
Martin Vidner
-
Nanuk Krinner