Hi! For now, I'm translating this guide from English into Japanese, and let me give you some comments in the followings, since some your descriptions come to my attention. * * * * * * * * * * * * * * * * * * * * * 1.---- [Line 48-54] <p> Just like any package in Portage, jffnms can be installed with <c>emerge</c>: </p> <pre caption="Installing Jffnms"> # <i>emerge jffnms</i> </pre> =>I think it'd be better to add descriptions about Jffnms USE flags. Since Jffnms use USE flags regarding to "postgres" or "mysql", which have influences over PostgreSQL and MySQL installtions and set-up. Also, it seems that Jffnms and other related packages are masked for now. I think these masked packages are need to be refferd in this guide. And as long as referring to jffnms ebuild file, PHP should be used version 4, not version 5. Also it seems that "wddx" USE flag should be used to install PHP. Thus, I think adding these topics are more friendly to readers. * * * * * * * * * * * * * * * * * * * * * 2.---- [Line 347-355] <p> The poller process is responsible for gathering data from hosts. In order to collect this data at regular intervals, it must be added to crontab. </p> <pre caption="Setting up udp port monitoring and discovery"> # <i>crontab -u jffnms /opt/jffnms/docs/unix/crontab</i> # <i>crontab -e -u jffnms</i> </pre> =>It seems that the part of "<pre cation" should be regarding to crontab, not port monitoring and discovery. * * * * * * * * * * * * * * * * * * * * * 3.---- I think it'd be better that adding a new section about explainations of Jffnms initial configuration (like, open your web-browser http://SERVERNAME/htdocs/admin/setup.php, then it's time to configure Jffnms configuration settings! But further settings are beyond this guide, please reffer to some links in the Support section. etc) Thank you for your support in advance, --- Taku Murakami <murakami.taku@gmail.com>
Hi Taku, You have very interesting suggestions about our Jffnms documentation. 1) I can provide notes with regards about Jffnms' USE flags. 2) I choose the caption "Setting up udp port monitoring and discovery" because I was thinking on the desired result of the action, not the tool used to achieve that. 3) Do you mean adding a section explaining how to setup jffnms? That'd would be ok for me, though it will take some time to do that. @docs-team: Pardon for my ignorance on the topic, but am I supposed to provide patches to the doc on the site? Or should I provide the whole doc?
Hi Otavio, Thank you for reply. > 1) I can provide notes with regards about Jffnms' USE flags. Thanks. I think it'd be better, since not all of readers are familiar with Gentoo's package system. > 2) I choose the caption "Setting up udp port monitoring and discovery" because > I was thinking on the desired result of the action, not the tool used to > achieve that. OK, I understand. But the previous caption is also titled "Setting up udp port monitoring and discovery". So, some different title like "Collecting data at regular intervals" might be more appropriate in this caption, I think. > 3) Do you mean adding a section explaining how to setup jffnms? That'd would be > ok for me, though it will take some time to do that. Yes, since some readers might be confused where they should go to setup their Jffnms initially. And presenting information, such as the initial setup URL page, can be more helpful to readers. Of course, I can't complain adding another section take you some time. But I'd be appreciated if you could do that.
(In reply to comment #1) > @docs-team: Pardon for my ignorance on the topic, but am I supposed to provide > patches to the doc on the site? Or should I provide the whole doc? Patches are fine. If you don't have a checkout of gentoo/xml/htdocs/doc/en/yourfile.xml, you can use either sources.gentoo.org or just append "?passthru=1" to the end of the URL to your guide in order to get the XML source.
Well, since I'm a bit busy with real life I'm posting here to give a feedback on this bug: I noted the suggestions on this bug as well as on 128854 and I'll provide the doc team with a patch in at most 7 days (more likely to be posted between April 21th and 23th). Thanks for suggestions
Created attachment 85278 [details, diff] suggestions.diff This patch applies all the suggestions on this bug to the actual Jffnms doc on our site. Thanks.
Great. Thank you for your patch. I'll try to retest with use of the jffnms.xml which is applied this patch as well as bug#128854. From the test result, I think I can confirm the validity of your patch or give more feedback. In case there is something to report, I'll send patch next time. Maybe it make things more smoothly. But since I also a little bit busy recently, I'm not sure when I'll be able to respond. So, I think it's ok to be commited the modification in this patch if docs-teem don't mind. Thanks.
Both committed. Thanks for the patches.
