[Bug 230664] New: Incorrect chapter reference in start-up guide
https://bugzilla.novell.com/show_bug.cgi?id=230664 Summary: Incorrect chapter reference in start-up guide Product: openSUSE 10.2 Version: Final Platform: Other OS/Version: Other Status: NEW Severity: Normal Priority: P5 - None Component: Documentation AssignedTo: rwalter@novell.com ReportedBy: richard.bos@xs4all.nl QAContact: ke@novell.com On the top of page 142 in the start up guide that comes with openSUSE-10.2 a reference is made to Chapter 26, Using NIS and Chapter 27 LDAP. This is in the NOTE section. There is no Chapter 26 and 27 in the start up guide, or the reference to another book is left out. -- Configure bugmail: https://bugzilla.novell.com/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are on the CC list for the bug, or are watching someone who is.
https://bugzilla.novell.com/show_bug.cgi?id=230664 ke@novell.com changed: What |Removed |Added ---------------------------------------------------------------------------- AssignedTo|rwalter@novell.com |taroth@novell.com ------- Comment #1 from ke@novell.com 2007-01-02 03:53 MST ------- Tanja to check, please. -- Configure bugmail: https://bugzilla.novell.com/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are on the CC list for the bug, or are watching someone who is.
https://bugzilla.novell.com/show_bug.cgi?id=230664 taroth@novell.com changed: What |Removed |Added ---------------------------------------------------------------------------- Status|NEW |RESOLVED Resolution| |FIXED ------- Comment #2 from taroth@novell.com 2007-01-08 09:14 MST ------- Sorry for the rather late response due to vacation... The reference above points in fact to another book, called "Reference". If a link points to another book, the book's name is given in parentheses behind the chapter name. (Please find our documentation conventions in the chapter "About This Guide", p. ix in this case). Please note that the Reference Guide is unfortunately not printed - you can either download the PDF from http://www.novell.com/documentation/opensuse102 or install it from the package "opensuse-manual_en-pdf" - it can then be found in your installed system under /usr/share/docs. HTML versions of the books shipped with openSUSE 10.2 can also be found under /usr/share/docs or accessed from the help centers (KDE Help Center/Yelp) of your installed desktop (KDE/GNOME). -- Configure bugmail: https://bugzilla.novell.com/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are on the CC list for the bug, or are watching someone who is.
https://bugzilla.novell.com/show_bug.cgi?id=230664 richard.bos@xs4all.nl changed: What |Removed |Added ---------------------------------------------------------------------------- Status|RESOLVED |REOPENED Resolution|FIXED | ------- Comment #3 from richard.bos@xs4all.nl 2007-01-08 12:51 MST ------- Tanja, Without your explanation I would _never_ know, that the chapters should be looked up in the opensuse-manual_en manual (and that is a shame). Right now the text reads: "For more information on these, refer to Ch. 26, Using nis (^Reference) and Ch. 27, LDAP - A directory service (^Reference)." Now what is (^Reference), it can be anything like an encyclopedia or some some novel?? I have the feeling that it is variable that is not populated. I think that the sentence should read (e.g.): "For more information on these, refer to Ch. 26, Using nis (^1) and Ch. 27, LDAP - A directory service (^1)." With an explanation of (^1) somewhere in the appendix, what (^1) is: Appendix references ------------------------ 1. opensuse-manual_en to be found at /usr/share/doc/manual/opensuse-manual_en/manual or http://www.novell.com/documentation/opensuse102/ BTW: nice to know that the opensuse-manual_en is still available :)) -- Configure bugmail: https://bugzilla.novell.com/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are on the CC list for the bug, or are watching someone who is.
https://bugzilla.novell.com/show_bug.cgi?id=230664 taroth@novell.com changed: What |Removed |Added ---------------------------------------------------------------------------- Status|REOPENED |RESOLVED Resolution| |WORKSFORME ------- Comment #4 from taroth@novell.com 2007-01-09 01:49 MST ------- Richard, from your answer I assume that you probably didn't get me right: the manual the link is pointing is actually called "Reference" (as a look at the title page of this manual reveals), "opensuse-manual_en" is the name of the rpm package. I agree that for the future we should think about the title "Reference" again as it is probably too generic. But again, the conventions we use in documentation (also for our references in the text) are mentioned in every introductory chapter of our manuals ("About This Guide", section "Documentation Conventions"). Where to find the other manuals delivered with openSUSE _is_ also described in each introduction of our manuals: both the link to the doc Web site and the place where to look for the manuals in your installed system are given in "About This Guide", section "Additional Documentation". Information about where to find the documentation packages on the installation media is covered in the openSUSE 10.2 Release Notes (see heading "Availability of Manuals"). -- Configure bugmail: https://bugzilla.novell.com/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are on the CC list for the bug, or are watching someone who is.
https://bugzilla.novell.com/show_bug.cgi?id=230664 ------- Comment #5 from richard.bos@xs4all.nl 2007-01-09 12:11 MST ------- Pfff, now it's fully clear... I read the "Documentation Conventions" yesterday, but that did not make it clear (enough). I think that when the last bullet would be: "Dancing Penquins (Chapter Penguins, ^Another Book): This is a reference to a chapter in another book." that it would have clearer. Further more I skimmed the chapter with Additional Documentation and have seen the word(!) Reference, never realizing that it is the title of a book. Now the opensuse-manual (/usr/share/doc/manual/opensuse-manual_en/manual/) and Reference (http://www.novell.com/documentation/opensuse102/ -> reference) are exactly the same books, but rendered differently. Just refer to the opensuse-manual instead of Reference, that would have prevent all confusion: "For more information on these, refer to Ch. 26, Using nis (^opensuse manual) and Ch. 27, LDAP - A directory service (^opensuse manual)." Another suggestion that would have helped me (and I think others): - Add the books to the index at the back of book, or have them mentioned in a seperate appendix. I mean I have searched the book (index, appendix), before I opened the bug, but I did not find what I looked for (which is the book Reference....) I hope that you'll remove this confusion from the start-up guide! -- Configure bugmail: https://bugzilla.novell.com/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are on the CC list for the bug, or are watching someone who is.
https://bugzilla.novell.com/show_bug.cgi?id=230664 ------- Comment #6 from taroth@novell.com 2007-01-10 00:57 MST ------- Richard, thank you for your input! We will rephrase the sentence in the Documentation Conventions to make it clearer and will consider your further suggestions for the next release. -- Configure bugmail: https://bugzilla.novell.com/userprefs.cgi?tab=email ------- You are receiving this mail because: ------- You are on the CC list for the bug, or are watching someone who is.
participants (1)
-
bugzilla_noreply@novell.com