3509 2012-11-28 20:12:17 +0000 Need better Yocto Project Documentation Components 2014-10-07 15:39:43 +0000 1 1 5 Infrastructure Bugzilla bugzilla unspecified x86 Multiple RESOLVED FIXED 17 June 2014: IN PROGRESS REVIEW Medium normal Future 1 srifenbark mhalstead infras.bug.watcher Infras.watcher sgw srifenbark --- --- No (bug/feature does not impact docs) oldest_to_newest 27808 0 srifenbark 2012-11-28 20:12:17 +0000 we need a general classification of "Documentation", which I think we have and then the documentation components need to break out into the available manuals: * Reference Manual * Quick Start * Kernel Architecture Manual * BSP Guide * Development Manual * Application Developer's Guide * Mega-manual * general This way when you find a bug against a YP manual you can specifically identify the exact manual. We could use "general" for documentation problems that can't be sourced to a specific manual (e.g. new features, stuff that spreads across multiple manuals, etc.) 29725 1 srifenbark 2013-02-11 20:52:11 +0000 the components for the YP documentation set have changed: * ref-manual - Yocto Project Reference Manual * yocto-project-qs - Yocto Project Quick Start * kernel-dev - Yocto Project Linux Kernel Development Manual * profile-manual - Yocto Project Profiling and Tracing Manual * bsp-guide - Yocto Project Board Support Package (BSP) Developer's Guide * adt-manual - Yocto Project Application Developer's Guide * mega-manual - (no title for this document) We need a component for each of these manuals so bugs can be filed against them individually. We also need a case where we file a bug against the documentation in general with no associated manual. Scott 29727 2 mhalstead 2013-02-11 21:08:04 +0000 I'll add mega-manual. Is the development manual no longer needed? Is profile-manual is a component of the developer manual or ADT/SDK docs? * profile-manual - Yocto Project Profiling and Tracing Manual * mega-manual - (no title for this document) Do you still need a category for general documentation bugs? These five are represented. I'll update the descriptions where needed. Visit https://bugzilla.yoctoproject.org/enter_bug.cgi?classification=Documentation to see them all at once. * ref-manual - Yocto Project Reference Manual * yocto-project-qs - Yocto Project Quick Start * kernel-dev - Yocto Project Linux Kernel Development Manual * bsp-guide - Yocto Project Board Support Package (BSP) Developer's Guide * adt-manual - Yocto Project Application Developer's Guide 29728 3 mhalstead 2013-02-11 21:36:50 +0000 I've added a general section. https://bugzilla.yoctoproject.org/describecomponents.cgi?product=General%20Docs And a mega-manual product https://bugzilla.yoctoproject.org/describecomponents.cgi?product=Mega%20Manual I'm adding version information now. These questions are still relevant. Is the development manual no longer needed? Is profile-manual is a component of the developer manual or ADT/SDK docs? * profile-manual - Yocto Project Profiling and Tracing Manual 29735 4 srifenbark 2013-02-12 00:24:51 +0000 Michael, I forgot the development manual: * dev-manual - Yocto Project Development Manual Profile manual is a new manual as is the kernel-dev manual. The old kernel manual (kernel-manual) will be gone for 1.4. The adt-manual still exists but has a different title - Yocto Project Application Developer's Guide. 38382 5 srifenbark 2013-10-31 17:54:20 +0000 Michael, Documentation components are now the following: * Reference Manual * Quick Start * Linux Kernel Development Manual * BSP Guide * Development Manual * Application Developer's Guide * Profile and Tracing Manual * Mega-manual * General Can we get these categories under documentation? 38393 6 mhalstead 2013-10-31 18:45:11 +0000 * Reference Manual (https://bugzilla.yoctoproject.org/describecomponents.cgi?product=Reference) * Quick Start (https://bugzilla.yoctoproject.org/describecomponents.cgi?product=Quick%20Start) * Linux Kernel Development Manual this is currently called Kernel Development manual. Do we need to rename it? (https://bugzilla.yoctoproject.org/describecomponents.cgi?product=Kernel%20Development) * BSP Guide, renamed (https://bugzilla.yoctoproject.org/describecomponents.cgi?product=BSP%20Guide) * Development Manual, renamed (https://bugzilla.yoctoproject.org/describecomponents.cgi?product=Development%20Manual) * Application Developer's Guide is part of ADT Docs. Does it need a separate listing? (https://bugzilla.yoctoproject.org/describecomponents.cgi?product=ADT%20Docs) * Profile and Tracing Manual, renamed (https://bugzilla.yoctoproject.org/describecomponents.cgi?product=Profile%20and%20Tracing%20Manual) * Mega-manual (https://bugzilla.yoctoproject.org/describecomponents.cgi?product=Mega%20Manual) * general (https://bugzilla.yoctoproject.org/describecomponents.cgi?product=General%20Docs) 38404 7 srifenbark 2013-10-31 20:50:35 +0000 Kernel Development Manual is fine. No need to rename that. What else is part of ADT Docs? All I know about is the Application Developer's Guide. The old manual was call the ADT manual, which is moot. 43999 8 srifenbark 2014-06-17 08:11:30 +0000 Michael, We probably need one now for the BitBake User Manual as it is published alongside the YP documentation. The only other issue with this is that ADT manual. There should only be a single manual. Application Developer's Guide. This should not be a part of "ADT Docs" We don't need an "ADT Docs" category. Thanks, Scott 46072 9 mhalstead 2014-10-03 01:42:32 +0000 I've added the BitBake User Manual product and component. I can't remove or hide ADT Docs while there are open bugs assigned there. I can rename it though. Would that work? 46125 10 srifenbark 2014-10-06 15:34:45 +0000 Michael, I think we are good on this now. All the manuals are covered and the description of the "ADT Docs" notes that it is the application development manual, which is the real title. I suppose if you wanted to and it was not too much trouble you could rename "ADT Docs" to "ADT Manual". Thanks, Scott 46176 11 mhalstead 2014-10-07 15:39:43 +0000 Rename complete.