[yast-devel] First steps in the new tutorial
Writing the new tutorial about developing a YaST module from scratch is being more time consuming than I expected (and I actually didn't expected it to be fast). At least, there is a first draft of the first two "lessons" here: http://ancorgs.github.io/yast-journalctl-tutorial/ As you can see, I'm using the same repository for both the tutorial itself (in the gh-pages branch) and the example code (tagging every step in git). I like it this way because everything is self-contained and (hopefully) easy to follow. As a bonus, we have full control over the appearance, which I used to mimic the YaST home page's look and feel. Please, read and provide feedback. Cheers. -- Ancor González Sosa YaST 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
Dne 15.12.2014 v 11:48 Ancor Gonzalez Sosa napsal(a): [...]
Please, read and provide feedback.
I have read the tutorial and it looks very good, great work! IMHO something like that was missing for Yast. As you state "for newbies written by a newbie" - that's very important as the experienced developers usually don't see the obvious obstacles for newbies... I really like that you started with the UI mockup, that's usually very important for newbies to have something you can see and interact with. Just go ahead with the missing steps :-) -- Best Regards Ladislav Slezák Yast Developer ------------------------------------------------------------------------ SUSE LINUX, s.r.o. e-mail: lslezak@suse.cz Lihovarská 1060/12 tel: +420 284 028 960 190 00 Prague 9 fax: +420 284 028 951 Czech Republic http://www.suse.cz/ -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
Dne 15.12.2014 v 14:28 Ladislav Slezak napsal(a): [...]
Just go ahead with the missing steps :-)
Just a note: I'd put some generic Ruby programming links (like [1] or [2]) after the sentence "... no general Ruby subjects will be explained." at the beginning. Just in case someone is interested in hacking Yast but does not have any experience with Ruby, to point to some starting point... [1] http://ruby-doc.com/docs/ProgrammingRuby/ [2] http://ruby-doc.org/ -- Best Regards Ladislav Slezák Yast Developer ------------------------------------------------------------------------ SUSE LINUX, s.r.o. e-mail: lslezak@suse.cz Lihovarská 1060/12 tel: +420 284 028 960 190 00 Prague 9 fax: +420 284 028 951 Czech Republic http://www.suse.cz/ -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
On 12/15/2014 02:44 PM, Ladislav Slezak wrote:
Dne 15.12.2014 v 14:28 Ladislav Slezak napsal(a): [...]
Just go ahead with the missing steps :-)
Just a note: I'd put some generic Ruby programming links (like [1] or [2]) after the sentence "... no general Ruby subjects will be explained." at the beginning.
Just in case someone is interested in hacking Yast but does not have any experience with Ruby, to point to some starting point...
I added the third step, and a link to ruby-doc.org in the intro. I'll try to write a new step every one or two days (I'd NEED to switch to other task at least once per day). Cheers. -- Ancor González Sosa YaST 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 12/15/2014 05:10 PM, Ancor Gonzalez Sosa wrote:
On 12/15/2014 02:44 PM, Ladislav Slezak wrote:
Dne 15.12.2014 v 14:28 Ladislav Slezak napsal(a): [...]
Just go ahead with the missing steps :-)
Just a note: I'd put some generic Ruby programming links (like [1] or [2]) after the sentence "... no general Ruby subjects will be explained." at the beginning.
Just in case someone is interested in hacking Yast but does not have any experience with Ruby, to point to some starting point...
I added the third step, and a link to ruby-doc.org in the intro. I'll try to write a new step every one or two days (I'd NEED to switch to other task at least once per day).
And here you are the fourth step (SCR and unit tests). http://ancorgs.github.io/yast-journalctl-tutorial/step4.html Cheers. -- Ancor González Sosa YaST 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 12/17/2014 04:35 PM, Ancor Gonzalez Sosa wrote:
On 12/15/2014 05:10 PM, Ancor Gonzalez Sosa wrote:
On 12/15/2014 02:44 PM, Ladislav Slezak wrote:
Dne 15.12.2014 v 14:28 Ladislav Slezak napsal(a): [...]
Just go ahead with the missing steps :-)
Just a note: I'd put some generic Ruby programming links (like [1] or [2]) after the sentence "... no general Ruby subjects will be explained." at the beginning.
Just in case someone is interested in hacking Yast but does not have any experience with Ruby, to point to some starting point...
I added the third step, and a link to ruby-doc.org in the intro. I'll try to write a new step every one or two days (I'd NEED to switch to other task at least once per day).
And here you are the fourth step (SCR and unit tests). http://ancorgs.github.io/yast-journalctl-tutorial/step4.html
Good news: - I added a fifth step. - I reorganized some content. It feels more fluent now. - I included the feedback from Lada on IRC. Bad news: - With the reorganization I decided I needed a 7th chapter, so even with the new content I'm again 2 steps away from the finish line. - I rewrote the repository history, if you were following the tutorial, you'll need to clone it again. Cheers. -- Ancor González Sosa YaST 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 12/19/2014 01:17 PM, Ancor Gonzalez Sosa wrote:
On 12/17/2014 04:35 PM, Ancor Gonzalez Sosa wrote:
And here you are the fourth step (SCR and unit tests). http://ancorgs.github.io/yast-journalctl-tutorial/step4.html
Good news: - I added a fifth step. - I reorganized some content. It feels more fluent now. - I included the feedback from Lada on IRC.
Bad news: - With the reorganization I decided I needed a 7th chapter, so even with the new content I'm again 2 steps away from the finish line. - I rewrote the repository history, if you were following the tutorial, you'll need to clone it again.
Chapter 6 comes with the same "feature" again. A fresh clone of the code is needed again since I needed to rewrite history one more time. http://ancorgs.github.io/yast-journalctl-tutorial/step6.html Cheers. -- Ancor González Sosa YaST 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 12/24/2014 05:04 PM, Ancor Gonzalez Sosa wrote:
On 12/19/2014 01:17 PM, Ancor Gonzalez Sosa wrote:
On 12/17/2014 04:35 PM, Ancor Gonzalez Sosa wrote:
And here you are the fourth step (SCR and unit tests). http://ancorgs.github.io/yast-journalctl-tutorial/step4.html
Good news: - I added a fifth step. - I reorganized some content. It feels more fluent now. - I included the feedback from Lada on IRC.
Bad news: - With the reorganization I decided I needed a 7th chapter, so even with the new content I'm again 2 steps away from the finish line. - I rewrote the repository history, if you were following the tutorial, you'll need to clone it again.
Chapter 6 comes with the same "feature" again. A fresh clone of the code is needed again since I needed to rewrite history one more time.
http://ancorgs.github.io/yast-journalctl-tutorial/step6.html
And finally the last step. http://ancorgs.github.io/yast-journalctl-tutorial/step7.html This chapter is about packaging. I'm not very proficient with OBS and packaging in general, so review is even more encouraged than usual. After some final touches (like actually following the tutorial in a fresh installed openSUSE and replacing some placeholder texts), I'll consider the tutorial ready to be moved under the yast organization and linked from the github.io page. Cheers. -- Ancor González Sosa YaST 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 12/30/2014 09:57 AM, Ancor Gonzalez Sosa wrote:
like actually following the tutorial in a fresh installed openSUSE and replacing some placeholder texts
Done. -- Ancor González Sosa YaST 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 Tue, 30 Dec 2014 09:57:33 +0100 Ancor Gonzalez Sosa <ancor@suse.de> wrote:
On 12/24/2014 05:04 PM, Ancor Gonzalez Sosa wrote:
On 12/19/2014 01:17 PM, Ancor Gonzalez Sosa wrote:
On 12/17/2014 04:35 PM, Ancor Gonzalez Sosa wrote:
And here you are the fourth step (SCR and unit tests). http://ancorgs.github.io/yast-journalctl-tutorial/step4.html
Good news: - I added a fifth step. - I reorganized some content. It feels more fluent now. - I included the feedback from Lada on IRC.
Bad news: - With the reorganization I decided I needed a 7th chapter, so even with the new content I'm again 2 steps away from the finish line. - I rewrote the repository history, if you were following the tutorial, you'll need to clone it again.
Chapter 6 comes with the same "feature" again. A fresh clone of the code is needed again since I needed to rewrite history one more time.
http://ancorgs.github.io/yast-journalctl-tutorial/step6.html
And finally the last step.
http://ancorgs.github.io/yast-journalctl-tutorial/step7.html
This chapter is about packaging. I'm not very proficient with OBS and packaging in general, so review is even more encouraged than usual.
After some final touches (like actually following the tutorial in a fresh installed openSUSE and replacing some placeholder texts), I'll consider the tutorial ready to be moved under the yast organization and linked from the github.io page.
Cheers.
I review chapter 7 and few notes: - nice to talk about check:osc, I forget that I implement it :) - I missing link to documentation of Yast::Task configuration options when you use it, so user know what to use if he need something advanced ( like different BS instance ). - adding desktop to default license ignore pattern sounds like good idea, I can add it to packaging_tasks itself as for me it is not yast specific In general nice tutorial and we can think how to make it even easier :) Josef -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
On 01/05/2015 10:02 AM, Josef Reidinger wrote:
I review chapter 7 and few notes:
- nice to talk about check:osc, I forget that I implement it :)
- I missing link to documentation of Yast::Task configuration options when you use it, so user know what to use if he need something advanced ( like different BS instance ).
Added. It's a shame that sometimes the documentation disappears from rubydoc and needs to be regenerated. Does somebody know the reason? Cheers. -- Ancor González Sosa YaST 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 Tue, Dec 30, 2014 at 09:57:33AM +0100, Ancor Gonzalez Sosa wrote:
http://ancorgs.github.io/yast-journalctl-tutorial/step7.html
git add Rakefile git commit --amend --no-edit rake osc:commit Wasn't osc:build intended to be there? Petr
On 01/06/2015 05:43 PM, Petr Gajdos wrote:
On Tue, Dec 30, 2014 at 09:57:33AM +0100, Ancor Gonzalez Sosa wrote:
http://ancorgs.github.io/yast-journalctl-tutorial/step7.html
git add Rakefile git commit --amend --no-edit rake osc:commit
Wasn't osc:build intended to be there?
Yes. Fixed. Thanks. -- Ancor González Sosa YaST 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
Hello, Am Dienstag, 30. Dezember 2014 schrieb Ancor Gonzalez Sosa:
And finally the last step.
http://ancorgs.github.io/yast-journalctl-tutorial/step7.html
Interesting tutorial, thanks a lot for writing it! One interesting point to add would be: How many hours did you need for writing the code you describe in the tutorial? (Including the time for reading documentation etc.) I don't expect an exact answer like "20 hours 42 minutes and 10 seconds", but a rough number would be interesting. Regards, Christian Boltz PS: Please don't expect me to write YaST modules in the future. I already have (more than) enough stuff on my TODO list, and don't want to learn another programming language. --
bei Bernd ist alles Zufall. Glaubst Du nicht, dass da Kristallkugel.pl zugeschlagen hat? Ich bin mir sicher, dass Bernd sowas auf seinem Rechner hat ;-) [> Michael Schulz u. Manfred Tremmel über Bernd Brodesser in suse-linux]
-- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
On 01/07/2015 09:30 PM, Christian Boltz wrote:
Hello,
Am Dienstag, 30. Dezember 2014 schrieb Ancor Gonzalez Sosa:
And finally the last step.
http://ancorgs.github.io/yast-journalctl-tutorial/step7.html
Interesting tutorial, thanks a lot for writing it!
One interesting point to add would be: How many hours did you need for writing the code you describe in the tutorial? (Including the time for reading documentation etc.)
I don't expect an exact answer like "20 hours 42 minutes and 10 seconds", but a rough number would be interesting.
I'm not sure if I'm the right person to answer that question. All I can say is that writing the tutorial itself was quite time-consuming but I don't know how hard/long would it be to follow it. If somebody in this list does it, please report back. ;-)
Regards,
Christian Boltz
PS: Please don't expect me to write YaST modules in the future. I already have (more than) enough stuff on my TODO list, and don't want to learn another programming language.
Well, that excludes Christian as time reporter :-) Cheers. -- Ancor González Sosa YaST 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 Wed, 24 Dec 2014 17:04:51 +0100 Ancor Gonzalez Sosa <ancor@suse.de> wrote:
On 12/19/2014 01:17 PM, Ancor Gonzalez Sosa wrote:
On 12/17/2014 04:35 PM, Ancor Gonzalez Sosa wrote:
And here you are the fourth step (SCR and unit tests). http://ancorgs.github.io/yast-journalctl-tutorial/step4.html
Good news: - I added a fifth step. - I reorganized some content. It feels more fluent now. - I included the feedback from Lada on IRC.
Bad news: - With the reorganization I decided I needed a 7th chapter, so even with the new content I'm again 2 steps away from the finish line. - I rewrote the repository history, if you were following the tutorial, you'll need to clone it again.
Chapter 6 comes with the same "feature" again. A fresh clone of the code is needed again since I needed to rewrite history one more time.
http://ancorgs.github.io/yast-journalctl-tutorial/step6.html
Cheers.
notes: - chapter 5 mention 1 step, but there is actually two steps :) Otherwise chapter 5 is good. - chapter 6 looks good, I do not find anything hard to understand, just code getting more complex, but I do not see way how to avoid it. Josef -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
On Wed, 17 Dec 2014 16:35:08 +0100 Ancor Gonzalez Sosa <ancor@suse.de> wrote:
On 12/15/2014 05:10 PM, Ancor Gonzalez Sosa wrote:
On 12/15/2014 02:44 PM, Ladislav Slezak wrote:
Dne 15.12.2014 v 14:28 Ladislav Slezak napsal(a): [...]
Just go ahead with the missing steps :-)
Just a note: I'd put some generic Ruby programming links (like [1] or [2]) after the sentence "... no general Ruby subjects will be explained." at the beginning.
Just in case someone is interested in hacking Yast but does not have any experience with Ruby, to point to some starting point...
I added the third step, and a link to ruby-doc.org in the intro. I'll try to write a new step every one or two days (I'd NEED to switch to other task at least once per day).
And here you are the fourth step (SCR and unit tests). http://ancorgs.github.io/yast-journalctl-tutorial/step4.html
Cheers.
notes: - I think direct link to Target agent documentation can help, especially because agent name is system and not target :)...also something is wrong as link from README in core documentation lead to 404 http://www.rubydoc.info/github/yast/yast-core/doc/systemagent.md - "since the SCR agent parsing the file "/etc/sysconfig/clock" is attached to the path ".sysconfig.clock"" is quite confusing as it is not general rule and driven only by scrconf file. It can lead developer to idea that if he need agent for /etc/test/test he need to use ".test.test" which is not true as he can use whatever he want, just define it in scrconf - I know my english is not perfect, but I think there should be "relies on" instead of "which relies in " Josef -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
On 01/05/2015 10:18 AM, Josef Reidinger wrote:
On Wed, 17 Dec 2014 16:35:08 +0100 Ancor Gonzalez Sosa <ancor@suse.de> wrote:
On 12/15/2014 05:10 PM, Ancor Gonzalez Sosa wrote:
On 12/15/2014 02:44 PM, Ladislav Slezak wrote:
Dne 15.12.2014 v 14:28 Ladislav Slezak napsal(a): [...]
Just go ahead with the missing steps :-)
Just a note: I'd put some generic Ruby programming links (like [1] or [2]) after the sentence "... no general Ruby subjects will be explained." at the beginning.
Just in case someone is interested in hacking Yast but does not have any experience with Ruby, to point to some starting point...
I added the third step, and a link to ruby-doc.org in the intro. I'll try to write a new step every one or two days (I'd NEED to switch to other task at least once per day).
And here you are the fourth step (SCR and unit tests). http://ancorgs.github.io/yast-journalctl-tutorial/step4.html
Cheers.
notes:
- I think direct link to Target agent documentation can help, especially because agent name is system and not target :)...also something is wrong as link from README in core documentation lead to 404 http://www.rubydoc.info/github/yast/yast-core/doc/systemagent.md
I have intentionally avoided deep links to documentation when possible. I prefer to link to rubydoc's landing page for each repo, because nobody will remember to update the tutorial while reorganizing the documentation of a repository. About the name, I used Target because it's always mentioned like this in [1]. If it's more accurate to say "the System agent, attached to the .target path". We should then change both rubydoc and the tutorial to keep everything in sync. [1]http://www.rubydoc.info/github/yast/yast-core/file/doc/systemagent.md
- "since the SCR agent parsing the file "/etc/sysconfig/clock" is attached to the path ".sysconfig.clock"" is quite confusing as it is not general rule and driven only by scrconf file. It can lead developer to idea that if he need agent for /etc/test/test he need to use ".test.test" which is not true as he can use whatever he want, just define it in scrconf
Not sure if I get the point here.
- I know my english is not perfect, but I think there should be "relies on" instead of "which relies in "
No determiners involved, so your English is trustworthy in this case ;) Fixed. -- Ancor González Sosa YaST 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 Wed, 07 Jan 2015 13:25:13 +0100 Ancor Gonzalez Sosa <ancor@suse.de> wrote:
On 01/05/2015 10:18 AM, Josef Reidinger wrote:
On Wed, 17 Dec 2014 16:35:08 +0100 Ancor Gonzalez Sosa <ancor@suse.de> wrote:
On 12/15/2014 05:10 PM, Ancor Gonzalez Sosa wrote:
On 12/15/2014 02:44 PM, Ladislav Slezak wrote:
Dne 15.12.2014 v 14:28 Ladislav Slezak napsal(a): [...]
Just go ahead with the missing steps :-)
Just a note: I'd put some generic Ruby programming links (like [1] or [2]) after the sentence "... no general Ruby subjects will be explained." at the beginning.
Just in case someone is interested in hacking Yast but does not have any experience with Ruby, to point to some starting point...
I added the third step, and a link to ruby-doc.org in the intro. I'll try to write a new step every one or two days (I'd NEED to switch to other task at least once per day).
And here you are the fourth step (SCR and unit tests). http://ancorgs.github.io/yast-journalctl-tutorial/step4.html
Cheers.
notes:
- I think direct link to Target agent documentation can help, especially because agent name is system and not target :)...also something is wrong as link from README in core documentation lead to 404 http://www.rubydoc.info/github/yast/yast-core/doc/systemagent.md
I have intentionally avoided deep links to documentation when possible. I prefer to link to rubydoc's landing page for each repo, because nobody will remember to update the tutorial while reorganizing the documentation of a repository.
About the name, I used Target because it's always mentioned like this in [1]. If it's more accurate to say "the System agent, attached to the .target path". We should then change both rubydoc and the tutorial to keep everything in sync. [1]http://www.rubydoc.info/github/yast/yast-core/file/doc/systemagent.md
To be honest this just show how agents are over-engineered :) I am fine with current state, so we should just fix link in README to not lead to 404
- "since the SCR agent parsing the file "/etc/sysconfig/clock" is attached to the path ".sysconfig.clock"" is quite confusing as it is not general rule and driven only by scrconf file. It can lead developer to idea that if he need agent for /etc/test/test he need to use ".test.test" which is not true as he can use whatever he want, just define it in scrconf
Not sure if I get the point here.
I probably get wrong text. But I am not sure if it make sense to mention such agent here as journalctl do not use this agent and only system one. Or I overlook it?
- I know my english is not perfect, but I think there should be "relies on" instead of "which relies in "
No determiners involved, so your English is trustworthy in this case ;) Fixed.
Thanks Josef -- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
On 01/07/2015 01:32 PM, Josef Reidinger wrote:
On Wed, 07 Jan 2015 13:25:13 +0100 Ancor Gonzalez Sosa <ancor@suse.de> wrote:
On 01/05/2015 10:18 AM, Josef Reidinger wrote:
- "since the SCR agent parsing the file "/etc/sysconfig/clock" is attached to the path ".sysconfig.clock"" is quite confusing as it is not general rule and driven only by scrconf file. It can lead developer to idea that if he need agent for /etc/test/test he need to use ".test.test" which is not true as he can use whatever he want, just define it in scrconf
Not sure if I get the point here.
I probably get wrong text. But I am not sure if it make sense to mention such agent here as journalctl do not use this agent and only system one. Or I overlook it?
No you didn't. It's not used in the code. It's just an example of how SCR is used to call agents. I though it would be useful to have a simple example before diving into the code. On one hand, because I though the example was quite straightforward when compared to the target agent. On the other hand, to show the usage of SCR.Read and not only SCR.Execute. We can remove the example if everybody agrees that it can be a source of confusion. Cheers. -- Ancor González Sosa YaST 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 01/07/2015 01:32 PM, Josef Reidinger wrote:
On Wed, 07 Jan 2015 13:25:13 +0100 Ancor Gonzalez Sosa <ancor@suse.de> wrote:
On 01/05/2015 10:18 AM, Josef Reidinger wrote:
- I think direct link to Target agent documentation can help, especially because agent name is system and not target :)...also something is wrong as link from README in core documentation lead to 404 http://www.rubydoc.info/github/yast/yast-core/doc/systemagent.md
I have intentionally avoided deep links to documentation when possible. I prefer to link to rubydoc's landing page for each repo, because nobody will remember to update the tutorial while reorganizing the documentation of a repository.
About the name, I used Target because it's always mentioned like this in [1]. If it's more accurate to say "the System agent, attached to the .target path". We should then change both rubydoc and the tutorial to keep everything in sync. [1]http://www.rubydoc.info/github/yast/yast-core/file/doc/systemagent.md
To be honest this just show how agents are over-engineered :) I am fine with current state, so we should just fix link in README to not lead to 404
Easier said than done. :-) The main problem is that YARD uses a different syntax to link documentation files than the one used in Github flavored markdown. So you have to choose: proper links in Github or proper links in rubydoc.info. The point here is that yast-core is not really a ruby project and using YARD (rubydoc.info) for it feels kinda unnatural. I'd say we already talked about using simply markdown+readthedocs.org for yast-core documentation. Didn't we? I'll register the project in readthedocs and remove all current links to rubydoc.info tomorrow if nobody is against it. Would removing the .yardopts file have some impact somewhere? Cheers. -- Ancor González Sosa YaST 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 Wed, 07 Jan 2015 16:02:12 +0100 Ancor Gonzalez Sosa <ancor@suse.de> wrote:
On 01/07/2015 01:32 PM, Josef Reidinger wrote:
On Wed, 07 Jan 2015 13:25:13 +0100 Ancor Gonzalez Sosa <ancor@suse.de> wrote:
On 01/05/2015 10:18 AM, Josef Reidinger wrote:
- I think direct link to Target agent documentation can help, especially because agent name is system and not target :)...also something is wrong as link from README in core documentation lead to 404 http://www.rubydoc.info/github/yast/yast-core/doc/systemagent.md
I have intentionally avoided deep links to documentation when possible. I prefer to link to rubydoc's landing page for each repo, because nobody will remember to update the tutorial while reorganizing the documentation of a repository.
About the name, I used Target because it's always mentioned like this in [1]. If it's more accurate to say "the System agent, attached to the .target path". We should then change both rubydoc and the tutorial to keep everything in sync. [1]http://www.rubydoc.info/github/yast/yast-core/file/doc/systemagent.md
To be honest this just show how agents are over-engineered :) I am fine with current state, so we should just fix link in README to not lead to 404
Easier said than done. :-)
The main problem is that YARD uses a different syntax to link documentation files than the one used in Github flavored markdown. So you have to choose: proper links in Github or proper links in rubydoc.info.
The point here is that yast-core is not really a ruby project and using YARD (rubydoc.info) for it feels kinda unnatural. I'd say we already talked about using simply markdown+readthedocs.org for yast-core documentation. Didn't we?
Sounds reasonable for me.
I'll register the project in readthedocs and remove all current links to rubydoc.info tomorrow if nobody is against it. Would removing the .yardopts file have some impact somewhere?
Maybe it is used to genera yast-core-devel-doc, you should better check it. Otherwise if we plan to stop using rudydoc.info for core, it make sense to remove this config. Josef
Cheers.
-- To unsubscribe, e-mail: yast-devel+unsubscribe@opensuse.org To contact the owner, e-mail: yast-devel+owner@opensuse.org
On 01/07/2015 04:02 PM, Ancor Gonzalez Sosa wrote:
The point here is that yast-core is not really a ruby project and using YARD (rubydoc.info) for it feels kinda unnatural. I'd say we already talked about using simply markdown+readthedocs.org for yast-core documentation. Didn't we?
Yes, we did. Last November https://github.com/yast/yast-core/pull/89#discussion_r20146107 BTW, the documentation is already at http://yast-core.readthedocs.org/ and correctly linked from both the tutorial and http://yast.github.io Cheers. -- Ancor González Sosa YaST 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
participants (5)
-
Ancor Gonzalez Sosa -
Christian Boltz -
Josef Reidinger -
Ladislav Slezak -
Petr Gajdos