Merge lp:~flocculant/xubuntu-docs/cont1704 into lp:xubuntu-docs/zesty
- cont1704
- Merge into zesty
| Status: | Merged |
|---|---|
| Approved by: | Pasi Lallinaho on 2017-02-17 |
| Approved revision: | 629 |
| Merged at revision: | 628 |
| Proposed branch: | lp:~flocculant/xubuntu-docs/cont1704 |
| Merge into: | lp:xubuntu-docs/zesty |
| Diff against target: |
428 lines (+70/-68) 10 files modified
contributor-docs/C/common-reference.xml (+0/-1) contributor-docs/C/development.xml (+2/-3) contributor-docs/C/documentation.xml (+20/-17) contributor-docs/C/getting-started.xml (+3/-3) contributor-docs/C/index.xml (+1/-1) contributor-docs/C/processes-release-cycle.xml (+5/-6) contributor-docs/C/qa-bugs.xml (+10/-9) contributor-docs/C/qa-team.xml (+8/-12) contributor-docs/C/qa-tester.xml (+12/-9) contributor-docs/C/qa-testing.xml (+9/-7) |
| To merge this branch: | bzr merge lp:~flocculant/xubuntu-docs/cont1704 |
| Related bugs: |
| Reviewer | Review Type | Date Requested | Status |
|---|---|---|---|
| David Pires | 2017-01-25 | Needs Fixing on 2017-02-11 | |
| Pasi Lallinaho | Needs Fixing on 2017-02-07 | ||
|
Review via email:
|
|||
Commit Message
Description of the Change
Most changes are self-explanatory.
QA pages - important to remove references to Trello.
Documentation:
Currently we have in the translate section - only exist in xubuntu, mainly built for xubuntu, essential for xubuntu.
Suggest changing the order to exist, essential, mainly.
Additionally - lightdm greeter settings in in essential, greeter is in mainly - suggest swapping these around - greeter being more essential than settings for it.
light-locker settings no longer exists in xubuntu - that now all being part of xfce power manager
| Kev Bowring (flocculant) wrote : | # |
some changed locally as per in-line
| David Pires (slickymaster) wrote : | # |
The overall changes are OK. Don't see any issues with the order change of the packages to be translated nor with the swapping of the LightDM Greeter Settings with the LightDM Greeter.
Light Locker Settings and the references to Trello really had to go.
There are still some minor issues, which I commented inline, that should be fixed. But apart from those and if no team members oppose I can merge this.
| Kev Bowring (flocculant) wrote : | # |
see inline comments.
| David Pires (slickymaster) wrote : | # |
Inline proposal to use 'ISOs' and 'PPAs' instead of 'ISO's' and 'PPA's', in accordance to the Oxford Dictionaries Online rule.
- 629. By Kev Bowring on 2017-02-13
-
Changes as per review
Preview Diff
| 1 | === modified file 'contributor-docs/C/common-reference.xml' |
| 2 | --- contributor-docs/C/common-reference.xml 2015-11-24 17:07:12 +0000 |
| 3 | +++ contributor-docs/C/common-reference.xml 2017-02-13 18:00:31 +0000 |
| 4 | @@ -149,7 +149,6 @@ |
| 5 | <title>Useful QA Links</title> |
| 6 | |
| 7 | <itemizedlist> |
| 8 | - <listitem><para><ulink url="https://trello.com/b/IV66JCHl/xubuntu-qa">Xubuntu QA Trello</ulink></para></listitem> |
| 9 | <listitem><para><ulink url="https://launchpad.net/~xubuntu-qa">Xubuntu QA</ulink></para></listitem> |
| 10 | <listitem><para><ulink url="https://launchpad.net/~xubuntu-testers">Xubuntu Testers</ulink></para></listitem> |
| 11 | <listitem><para><ulink url="http://iso.qa.ubuntu.com/qatracker">ISO Tracker</ulink></para></listitem> |
| 12 | |
| 13 | === modified file 'contributor-docs/C/development.xml' |
| 14 | --- contributor-docs/C/development.xml 2015-11-22 14:44:04 +0000 |
| 15 | +++ contributor-docs/C/development.xml 2017-02-13 18:00:31 +0000 |
| 16 | @@ -1,5 +1,5 @@ |
| 17 | <?xml version="1.0" encoding="UTF-8"?> |
| 18 | -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
| 19 | +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
| 20 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ |
| 21 | <!ENTITY % xubuntu-common SYSTEM "../../libs-common/xubuntu-common.ent"> |
| 22 | %xubuntu-common; |
| 23 | @@ -16,9 +16,8 @@ |
| 24 | <section id="development-packageset"> |
| 25 | <title>Xubuntu packageset</title> |
| 26 | |
| 27 | - <para>The Xubuntu team maintains a certain subset of packages in the Ubuntu archive. The <ulink url="http://people.canonical.com/~ubuntu-archive/packagesets/&devel-codename;/xubuntu">Xubuntu packageset for the current development release</ulink>.</para> |
| 28 | + <para>The Xubuntu team maintains a subset of packages in the Ubuntu archive. The Xubuntu packageset for the current development release can be found listed at the packageset <ulink url="http://people.canonical.com/~ubuntu-archive/packagesets/">archive</ulink>archive.</para> |
| 29 | |
| 30 | - <note><para>All per-release packageset lists are available at <ulink url="http://people.canonical.com/~ubuntu-archive/packagesets/">http://people.canonical.com/~ubuntu-archive/packagesets/</ulink>.</para></note> |
| 31 | </section> |
| 32 | |
| 33 | <section id="development-ppa"> |
| 34 | |
| 35 | === modified file 'contributor-docs/C/documentation.xml' |
| 36 | --- contributor-docs/C/documentation.xml 2016-09-10 16:08:33 +0000 |
| 37 | +++ contributor-docs/C/documentation.xml 2017-02-13 18:00:31 +0000 |
| 38 | @@ -25,17 +25,19 @@ |
| 39 | <section id="docs-editing"> |
| 40 | <title>Editing the User Documentation</title> |
| 41 | <para>Changes to the user documentation should be made to the .xml files under <code>user-docs/C/</code>. Once edited and saved, push changes to your local branch as detailed in <xref linkend="common-reference" /></para> |
| 42 | + |
| 43 | + <para>Changes to the contributor documentation should be made to the .xml files under <code>contributor-docs/C/</code>. Once edited and saved, push changes to your local branch as detailed in <xref linkend="common-reference" /></para> |
| 44 | </section> |
| 45 | |
| 46 | <section id="docs-packages"> |
| 47 | <title>Packages to be translated</title> |
| 48 | |
| 49 | - <para>These are the packages that the Xubuntu team considers important and should take a precedence when translating.</para> |
| 50 | + <para>These are packages that the Xubuntu team considers important, and should take precedence when translating.</para> |
| 51 | |
| 52 | <section id="docs-packages-xubuntu-only"> |
| 53 | <title>The packages that only exist in Xubuntu</title> |
| 54 | |
| 55 | - <para>These packages only exist in Xubuntu, so their translation is up to the Xubuntu translators solely. These are of high importance for the Xubuntu team.</para> |
| 56 | + <para>These packages only exist in Xubuntu, so their translation is solely dealt with by Xubuntu translators. These are of high importance for the Xubuntu team.</para> |
| 57 | |
| 58 | <itemizedlist> |
| 59 | <listitem><para><ulink url="https://translations.launchpad.net/xubuntu-docs">Xubuntu Documentation</ulink></para></listitem> |
| 60 | @@ -44,38 +46,39 @@ |
| 61 | </itemizedlist> |
| 62 | </section> |
| 63 | |
| 64 | + <section id="docs-packages-xubuntu-used"> |
| 65 | + <title>Used by and essential for Xubuntu</title> |
| 66 | + |
| 67 | + <para>These packages are used by Xubuntu and provide essential features to the Xubuntu experience. When these are translated, the base system is immediately more usable for more people.</para> |
| 68 | + |
| 69 | + <itemizedlist> |
| 70 | + <listitem><para><ulink url="https://translations.launchpad.net/catfish-search">Catfish</ulink></para></listitem> |
| 71 | + <listitem><para><ulink url="https://translations.launchpad.net/lightdm-gtk-greeter">LightDM GTK+ Greeter</ulink></para></listitem> |
| 72 | + <listitem><para><ulink url="https://www.transifex.com/projects/p/xfce4-whiskermenu-plugin/">Whiskermenu</ulink></para></listitem> |
| 73 | + </itemizedlist> |
| 74 | + </section> |
| 75 | + </section> |
| 76 | + |
| 77 | + |
| 78 | <section id="docs-packages-xubuntu-mainly"> |
| 79 | <title>Mainly built for and used by Xubuntu</title> |
| 80 | |
| 81 | <para>These packages exist outside Xubuntu, but they are mainly built to fit a need in Xubuntu. Unless/until they are spread much wider than now (and have gathered the interest of other translation groups), the Xubuntu translators should take care of translating these packages.</para> |
| 82 | |
| 83 | <itemizedlist> |
| 84 | - <listitem><para><ulink url="https://translations.launchpad.net/lightdm-gtk-greeter">LightDM GTK+ Greeter</ulink></para></listitem> |
| 85 | - <listitem><para><ulink url="https://translations.launchpad.net/light-locker-settings">Light Locker Settings</ulink></para></listitem> |
| 86 | + <listitem><para><ulink url="https://translations.launchpad.net/lightdm-gtk-greeter-settings/">LightDM GTK+ Greeter Settings</ulink></para></listitem> |
| 87 | <listitem><para><ulink url="https://translations.launchpad.net/menulibre">MenuLibre</ulink></para></listitem> |
| 88 | <listitem><para><ulink url="https://translations.launchpad.net/mugshot">Mugshot</ulink></para></listitem> |
| 89 | </itemizedlist> |
| 90 | </section> |
| 91 | |
| 92 | - <section id="docs-packages-xubuntu-used"> |
| 93 | - <title>Used by and essential for Xubuntu</title> |
| 94 | - |
| 95 | - <para>These packages are used by Xubuntu and provide essential features to the Xubuntu experience. when these are translated, the base system is immediately more usable for more people.</para> |
| 96 | - |
| 97 | - <itemizedlist> |
| 98 | - <listitem><para><ulink url="https://translations.launchpad.net/catfish-search">Catfish</ulink></para></listitem> |
| 99 | - <listitem><para><ulink url="https://translations.launchpad.net/lightdm-gtk-greeter-settings/">LightDM GTK+ Greeter Settings</ulink></para></listitem> |
| 100 | - <listitem><para><ulink url="https://www.transifex.com/projects/p/xfce4-whiskermenu-plugin/">Whiskermenu</ulink></para></listitem> |
| 101 | - </itemizedlist> |
| 102 | - </section> |
| 103 | - </section> |
| 104 | |
| 105 | <section id="docs-translation-guidelines"> |
| 106 | <title>Translation guidelines for Xubuntu packages</title> |
| 107 | |
| 108 | <para>These guidelines apply mostly to the Xubuntu documentation. They can generally be applied to any translation with minor modification. If unsure, ask the Documentation team members for assistance.</para> |
| 109 | |
| 110 | - <para>The <ulink url="https://wiki.ubuntu.com/Translations/Contact/Teams">language-specific translation groups</ulink> usually want to encourage some conventions; please be in touch with the appropriate language-specific group before translating.</para> |
| 111 | + <para>The <ulink url="https://wiki.ubuntu.com/Translations/Contact/Teams">language-specific translation groups</ulink> usually want to encourage some conventions; please contact the appropriate language-specific group before translating.</para> |
| 112 | |
| 113 | <para>More general translation guidelines can be found at the <ulink url="https://help.launchpad.net/Translations/Guide">Launchpad translations guide</ulink>.</para> |
| 114 | |
| 115 | |
| 116 | === modified file 'contributor-docs/C/getting-started.xml' |
| 117 | --- contributor-docs/C/getting-started.xml 2016-12-15 17:49:18 +0000 |
| 118 | +++ contributor-docs/C/getting-started.xml 2017-02-13 18:00:31 +0000 |
| 119 | @@ -1,5 +1,5 @@ |
| 120 | <?xml version="1.0" encoding="UTF-8"?> |
| 121 | -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
| 122 | +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
| 123 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ |
| 124 | <!ENTITY % xubuntu-common SYSTEM "../../libs-common/xubuntu-common.ent"> |
| 125 | %xubuntu-common; |
| 126 | @@ -18,14 +18,14 @@ |
| 127 | |
| 128 | <section id="irc-channel"> |
| 129 | <title>#xubuntu-devel</title> |
| 130 | - |
| 131 | + |
| 132 | <para>The IRC channel #xubuntu-devel is where most of the daily communication and cooperation about Xubuntu development happens. It's also the place to get to know people and get yourself known.</para> |
| 133 | </section> |
| 134 | |
| 135 | <section id="status-tracker"> |
| 136 | <title>Status Tracker</title> |
| 137 | |
| 138 | - <para>The development for the current Xubuntu release is tracked in the <ulink url="&status-tracker;">Xubuntu work items tracker</ulink>. In addition to showing the current status for blueprints and their individual work items, including bugs, the tracker displays some general data on progress. Finally, you can access the team calendar and join the development IRC channel #xubuntu-devel within it.</para> |
| 139 | + <para>The development for the current Xubuntu release is tracked in the <ulink url="&status-tracker;">Xubuntu work items tracker</ulink>. In addition to showing the current status for blueprints and their individual work items, the tracker displays some general progress. Finally, you can access the team calendar, Xubuntu wiki, development mailing list and join the development IRC channel #xubuntu-devel from it.</para> |
| 140 | </section> |
| 141 | </section> |
| 142 | </chapter> |
| 143 | |
| 144 | === modified file 'contributor-docs/C/index.xml' |
| 145 | --- contributor-docs/C/index.xml 2016-03-14 20:15:33 +0000 |
| 146 | +++ contributor-docs/C/index.xml 2017-02-13 18:00:31 +0000 |
| 147 | @@ -57,7 +57,7 @@ |
| 148 | |
| 149 | <para>This documentation is a reference for all Xubuntu contributors. The chapters of this documentation provides information on the development processes - both social and technical - that the Xubuntu contributors use as a guideline in their work.</para> |
| 150 | |
| 151 | - <para>There are two main appendice for this documentation:</para> |
| 152 | + <para>There are two main appendices for this documentation:</para> |
| 153 | |
| 154 | <para><itemizedlist> |
| 155 | <listitem><para><xref linkend="xsd" />, which is the primary guideline in Xubuntu development.</para></listitem> |
| 156 | |
| 157 | === modified file 'contributor-docs/C/processes-release-cycle.xml' |
| 158 | --- contributor-docs/C/processes-release-cycle.xml 2015-11-22 14:44:04 +0000 |
| 159 | +++ contributor-docs/C/processes-release-cycle.xml 2017-02-13 18:00:31 +0000 |
| 160 | @@ -1,5 +1,5 @@ |
| 161 | <?xml version="1.0" encoding="UTF-8"?> |
| 162 | -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
| 163 | +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
| 164 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ |
| 165 | <!ENTITY % xubuntu-common SYSTEM "../../libs-common/xubuntu-common.ent"> |
| 166 | %xubuntu-common; |
| 167 | @@ -26,7 +26,7 @@ |
| 168 | <listitem><para>Finalizing specifications</para></listitem> |
| 169 | </itemizedlist> |
| 170 | |
| 171 | - <para>During the brainstorming phase the contributors determine what they would like to work on during the release cycle, including proposals for changes in default applications. Anybody can items to the list. Settling on the goals in advance will make planning, focusing and estimating the likelihood for the features to be implemented easier.</para> |
| 172 | + <para>During the brainstorming phase the contributors determine what they would like to work on during the release cycle, including proposals for changes in default applications. Anybody can add items to the list. Settling on the goals in advance will make planning, focusing and estimating the likelihood for the features to be implemented easier.</para> |
| 173 | |
| 174 | <para>After the brainstorming is over and before or on the Feature Definition Freeze day, the Xubuntu team will approve or reject the proposed blueprints. Any items with no assignee or rationale will be automatically rejected, but having them will not guarantee that the blueprint is approved. Other criteria include, but are not limited to: likelihood of getting the feature implemented, maintenance weight in the future, possible stability issues, influence on other blueprints, et cetera. The approved blueprints compose the roadmap for the release being developed.</para> |
| 175 | |
| 176 | @@ -78,8 +78,7 @@ |
| 177 | <?dbhtml list-presentation="table"?> |
| 178 | <segtitle>Scheduled time</segtitle><segtitle>Action</segtitle> |
| 179 | <seglistitem><seg>7 days before release</seg><seg>Pre-reminder for milestone testing</seg></seglistitem> |
| 180 | - <seglistitem><seg>5 days before release</seg><seg>Smoketest images - automatic, reported by Jenkins</seg></seglistitem> |
| 181 | - <seglistitem><seg>3 days before release</seg><seg>Once appropriate testing area set up, call for testing and start milestone testing</seg></seglistitem> |
| 182 | + <seglistitem><seg>2 to 3 days before release</seg><seg>Once appropriate testing area set up, call for testing and start milestone testing</seg></seglistitem> |
| 183 | <seglistitem><seg>Release day</seg><seg>Mark images ready on the ISO tracker once the release team is confident to do so</seg></seglistitem> |
| 184 | </segmentedlist> |
| 185 | </section> |
| 186 | @@ -87,9 +86,9 @@ |
| 187 | <section id="release-cycle-testing-package"> |
| 188 | <title>Package testing</title> |
| 189 | |
| 190 | - <para>The QA team will schedule package testing sprints to happen during the cycle between milestone testing to ensure applications that are included in Xubuntu have sufficient amount of testing conducted.</para> |
| 191 | + <para>When being used the QA team will schedule package testing sprints to happen during the cycle between milestone testing to ensure applications that are included in Xubuntu have sufficient amount of testing conducted.</para> |
| 192 | |
| 193 | - <para>Additional testing should be conducted when a new default application is to be included in the next Xubuntu release, when an application has a substantially large update in the middle of the cycle or when developers request specific testing for a specific update to an application.</para> |
| 194 | + <para>Regardless of whether package testing is taking place during a development cycle, additional testing should be conducted for a new default application is to be included in the next Xubuntu release, when an existing application has a substantially large update in the middle of the cycle or when developers request specific testing for a specific update to an application.</para> |
| 195 | |
| 196 | <para>Calls for package testing sprints will be sent out as required.</para> |
| 197 | </section> |
| 198 | |
| 199 | === modified file 'contributor-docs/C/qa-bugs.xml' |
| 200 | --- contributor-docs/C/qa-bugs.xml 2015-11-22 14:44:04 +0000 |
| 201 | +++ contributor-docs/C/qa-bugs.xml 2017-02-13 18:00:31 +0000 |
| 202 | @@ -1,5 +1,5 @@ |
| 203 | <?xml version="1.0" encoding="UTF-8"?> |
| 204 | -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
| 205 | +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
| 206 | "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ |
| 207 | <!ENTITY % xubuntu-common SYSTEM "../../libs-common/xubuntu-common.ent"> |
| 208 | %xubuntu-common; |
| 209 | @@ -35,30 +35,32 @@ |
| 210 | |
| 211 | <para>In the most situations, it is easiest to file a bug by opening a new Terminal and type ubuntu-bug package-name, where package-name is the package you want to file bug against. If you don’t know which package you should file the bug against, refer to the instructions on <ulink url="https://wiki.ubuntu.com/Bugs/FindRightPackage">finding the right package</ulink>. When filing the bug, it is better to have too much information than too little.</para> |
| 212 | </section> |
| 213 | - |
| 214 | + |
| 215 | + <note><para>If you are unsure of the package name to report against, you can use your mouse to click on the application window, in a terminal run <code>ubuntu-bug -w</code>, click to close the message window and then click on the application window</para></note> |
| 216 | + |
| 217 | <section id="qa-bugs-ppa"> |
| 218 | <title>Reporting bugs with PPAs</title> |
| 219 | |
| 220 | <para>When you encounter a bug with a package from a PPA, you’ll need to file the bug report manually. Once you’ve got the offending package name, go to http://bugs.launchpad.net/ubuntu/+source/<emphasis>PACKAGENAME</emphasis>/+filebug.</para> |
| 221 | |
| 222 | - <para>Crash logs related to the package can be found in /var/crash/. This directory requires superuser (sudo) permissions to view and extract the contents. These logs can be particularly valuable to include in your bug report, but be sure to review them as they may contain sensitive or personally identifiable material.</para> |
| 223 | + <para>Crash logs related to the package can be found in /var/crash/. This directory sometimes requires superuser (sudo) permissions to view and extract the contents. These logs can be particularly valuable to include in your bug report, but be sure to review them as they may contain sensitive or personally identifiable material.</para> |
| 224 | |
| 225 | <para>Be sure to follow the above general guidelines, and also add the ppa tag so it is clear to developers that this is an unsupported package.</para> |
| 226 | </section> |
| 227 | - |
| 228 | + |
| 229 | <section id="qa-bugs-triage"> |
| 230 | <title>Triaging bugs</title> |
| 231 | |
| 232 | <para>Triaging bugs is getting bug reports in a state where they are useful for developers by making sure bug reports have useful titles, descriptions, appropriate logs and more. To get started, read the page on <ulink url="https://wiki.ubuntu.com/Bugs/Triage">triaging bugs</ulink> in the Ubuntu wiki.</para> |
| 233 | - |
| 234 | - <para>After you have made yourself familiar with the aspects of triaging bugs, you can start triaging <ulink url="https://bugs.launchpad.net/~xubuntu-bugs/+packagebugs">Xubuntu bugs</ulink>. Please note that the bug status and importance can be only be changed by members of the <ulink url="https://wiki.ubuntu.com/UbuntuBugControl">Ubuntu Bug Control</ulink> team – in the beginning, you will need to report triaged bugs for the team in #ubuntu-bugs on Freenode. After you have demonstrated your ability to triage bugs, you will gain more responsibilities by the Bug Control team.</para> |
| 235 | + |
| 236 | + <para>After you have made yourself familiar with the aspects of triaging bugs, you can start triaging <ulink url="https://bugs.launchpad.net/~xubuntu-bugs/+packagebugs">Xubuntu bugs</ulink>. Please note that the bug status and importance can be only be changed by members of the <ulink url="https://wiki.ubuntu.com/UbuntuBugControl">Ubuntu Bug Control</ulink> team – in the beginning, you will need to report triaged bugs for the team in #ubuntu-bugs on Freenode. After you have demonstrated your ability to triage bugs, you will gain more responsibilities from the Bug Control team.</para> |
| 237 | |
| 238 | <para>As you gain experience on triaging Xubuntu bugs, you may want to take a look at new bugs that mention Xubuntu. Triaging new bugs is recommended for those who are more familiar with both triaging and Xubuntu generally, since not all of the new bugs mentioning Xubuntu are actually Xubuntu bugs.</para> |
| 239 | </section> |
| 240 | - |
| 241 | + |
| 242 | <section id="qa-bugs-upstream"> |
| 243 | <title>Forwarding bugs upstream</title> |
| 244 | - |
| 245 | + |
| 246 | <para>When bugs are forwarded upstream, all users of the relevant software will benefit from the debugging, triaging and patching work carried out by bug triagers and developers.</para> |
| 247 | |
| 248 | <para>Once it has been determined that a bug is not caused by a change in Xubuntu, bugs can be forwarded to their respective upstream projects to be reviewed. For example, all appropriate Xfce bugs should be filed in the <ulink url="https://bugzilla.xfce.org/">Xfce bug tracker</ulink>. In addition, to track the status of the bug in Ubuntu, the bug in Launchpad should be linked with the upstream bug.</para> |
| 249 | @@ -66,4 +68,3 @@ |
| 250 | <para>The Ubuntu wiki has an extensive page on <ulink url="https://wiki.ubuntu.com/Bugs/Upstream">forwarding bugs upstream</ulink> along with instructions on how to report bugs in the upstream bug trackers. Detailed information on the way to add an upstream bug to Launchpad can be found on the <ulink url="https://wiki.ubuntu.com/Bugs/Watches">Bugs/Watches</ulink> page on the Ubuntu wiki.</para> |
| 251 | </section> |
| 252 | </chapter> |
| 253 | - |
| 254 | |
| 255 | === modified file 'contributor-docs/C/qa-team.xml' |
| 256 | --- contributor-docs/C/qa-team.xml 2016-09-10 16:08:33 +0000 |
| 257 | +++ contributor-docs/C/qa-team.xml 2017-02-13 18:00:31 +0000 |
| 258 | @@ -14,7 +14,7 @@ |
| 259 | <chapter id="qa-team"> |
| 260 | <title>QA Team Responsibilies</title> |
| 261 | |
| 262 | - <note><para>In addition to the QA Team's Trello page, there are various QA tracker, wiki and Launchpad pages, the links to which can be found on <xref linkend="qa-team-links" />.</para></note> |
| 263 | + <note><para>There are various QA trackers, wiki and Launchpad pages, the links to which can be found on <xref linkend="qa-team-links" />.</para></note> |
| 264 | |
| 265 | <section id="qa-team-basics"> |
| 266 | <title>QA Team</title> |
| 267 | @@ -25,7 +25,7 @@ |
| 268 | |
| 269 | <para>Excluding testing itself, control of the testcases that we use for ISO and Package testing, along with communicating the testing requirements for any particular development cycle (hereafter cycle) to the community, makes up the bulk of the teams work in any given cycle.</para> |
| 270 | |
| 271 | - <para>Members of the QA team should check the current Xubuntu QA blueprint, and assign themselves to tasks they feel able to undertake. In addition it is helpful that they also have a Trello account in order to work with the QA Trello page.</para> |
| 272 | + <para>Members of the QA team should check the current Xubuntu QA blueprint, and assign themselves to tasks they feel able to undertake.</para> |
| 273 | </section> |
| 274 | |
| 275 | <section id="qa-team-testing"> |
| 276 | @@ -55,17 +55,17 @@ |
| 277 | |
| 278 | <itemizedlist> |
| 279 | <listitem><para>Image testcases we use are still correct.</para></listitem> |
| 280 | - <listitem><para>When the intention is that package testing will take place during the cycle, package testcases are still correct.</para></listitem> |
| 281 | + <listitem><para>When the intention is that package testing will take place during the cycle, package testcases required during the cycle are still correct.</para></listitem> |
| 282 | <listitem><para>The testsuites on the Package Tracker make sense for what we intend to test during the cycle. Differences between regular and LTS releases are often, but not always, needed.</para></listitem> |
| 283 | - <listitem><para>Scheduling of ISO, and when appropriate Package, testing should take place amongst the QA team. The resulting schedule should be posted on the Xubuntu QA Trello page with Due Dates, this ensures that the schedule shows on the tracker's calendar tab.</para></listitem> |
| 284 | + <listitem><para>Scheduling of ISO, and when appropriate Package, testing should take place amongst the QA team.</para></listitem> |
| 285 | </itemizedlist> |
| 286 | |
| 287 | <para>When there are changes to a package we test, following for example a bug fix, a further check of the testcase involved should take place. Further testing calls for that package should be made to check for regression during the cycle.</para> |
| 288 | |
| 289 | - <para>When a package during test constantly fails, or bug reports indicate a failure in a package for something not tested. The testcase for that package should be disabled temporarily. This should be noted on the Trello Disabled Tests list. The QA Lead is responsible for ensuring tests are both disabled and re-enabled when appropriate.</para> |
| 290 | - |
| 291 | - <para>Xubuntu ISO's are built and added to the tracker at approximately 02:00 UTC. This time can be changed by amending our build times on the <ulink url="http://bazaar.launchpad.net/~ubuntu-cdimage/ubuntu-cdimage/mainline/files/head:/etc/">ubuntu-cdimage crontab</ulink> and proposing the change.</para> |
| 292 | - |
| 293 | + <para>When a package during test constantly fails, or bug reports indicate a failure in a package for something not tested. The testcase for that package can be disabled temporarily. The QA Lead is responsible for ensuring tests are both disabled and re-enabled when appropriate.</para> |
| 294 | + |
| 295 | + <para>Xubuntu ISOs are built and added to the tracker at approximately 02:00 UTC. This time can be changed by amending our build times on the <ulink url="http://bazaar.launchpad.net/~ubuntu-cdimage/ubuntu-cdimage/mainline/files/head:/etc/">ubuntu-cdimage crontab</ulink> and proposing the change.</para> |
| 296 | + |
| 297 | </section> |
| 298 | |
| 299 | <section id="qa-team-testedits"> |
| 300 | @@ -101,7 +101,6 @@ |
| 301 | <para>Any member of the QA team can:</para> |
| 302 | |
| 303 | <itemizedlist> |
| 304 | - <listitem><para>Watch dates on the Trello schedule for upcoming testing calls via the tracker's <ulink url="http://tracker.xubuntu.org/#tab-calendar">calendar</ulink> tab</para></listitem> |
| 305 | <listitem><para>Mail the devel list with a testing call</para></listitem> |
| 306 | <listitem><para>Just prior to an upcoming ISO Milestone testing call, warn on the devel list</para></listitem> |
| 307 | <listitem><para>Make an ISO Milestone testing call</para></listitem> |
| 308 | @@ -131,9 +130,6 @@ |
| 309 | |
| 310 | <itemizedlist> |
| 311 | <listitem><para>QA Lead should set up the blueprints for both the QA team and the Bugs that the whole team uses</para></listitem> |
| 312 | - <listitem><para>Any member of the QA team can archive the previous cycle's Testing, Postponed and Done cards</para></listitem> |
| 313 | - <listitem><para>Set up new cycle cards for Testing, Postponed and Done</para></listitem> |
| 314 | - <listitem><para>Check that notes in the Tester Notes card is up to date</para></listitem> |
| 315 | <listitem><para>Check that the draft Release Note is up to date</para></listitem> |
| 316 | </itemizedlist> |
| 317 | </section> |
| 318 | |
| 319 | === modified file 'contributor-docs/C/qa-tester.xml' |
| 320 | --- contributor-docs/C/qa-tester.xml 2016-03-14 20:16:11 +0000 |
| 321 | +++ contributor-docs/C/qa-tester.xml 2017-02-13 18:00:31 +0000 |
| 322 | @@ -16,17 +16,17 @@ |
| 323 | <section id="qa-infra"> |
| 324 | <title>Getting ready to test</title> |
| 325 | |
| 326 | - <para>To successfully test for Xubuntu, so we know you have and you know what we need, you will need at a minimum 4 things: a Launchpad account, mailing list subscription, an image and something to test it on. This page will give you the basic information in order to do those things and more. </para> |
| 327 | + <para>To successfully test for Xubuntu, you will need at a minimum 4 things: a Launchpad account, mailing list subscription, an image and something to test it on. This page will give you the basic information in order to do those things and more. </para> |
| 328 | </section> |
| 329 | |
| 330 | <section id="qa-infra-specs"> |
| 331 | <title>Contacts</title> |
| 332 | |
| 333 | - <para>You need a Launchpad account - you'll use it to join the necessary Launchpad team(s) and it makes logging into the 2 QA trackers we use easier.</para> |
| 334 | - |
| 335 | - <para>We use one mailing list to detail what we intend to test during a cycle, we use the same list when we are calling for tests. The same list is used by the team to discuss the development of Xubuntu. So you will need to join the Xubuntu Devel <ulink url="https://lists.ubuntu.com/mailman/listinfo/xubuntu-devel"> Mailing</ulink> list.</para> |
| 336 | - |
| 337 | - <para>While it is not necessary to do so, we make much use of IRC, so having an account you can use to access the main #xubuntu-devel channel will help you, you can though access the channel via the IRC tab of the Xubuntu <ulink url="http://dev.xubuntu.org/">development</ulink> tracker.</para> |
| 338 | + <para>You need a Launchpad account,you'll use it to join the necessary Launchpad team(s). It makes logging into the 2 QA trackers possible.</para> |
| 339 | + |
| 340 | + <para>We use one mailing list to detail what we intend to test during a cycle, we use the same list when we are calling for tests. This list is also used by the team to discuss the development of Xubuntu. You will need to join the Xubuntu Devel <ulink url="https://lists.ubuntu.com/mailman/listinfo/xubuntu-devel"> Mailing</ulink> list.</para> |
| 341 | + |
| 342 | + <para>While it is not necessary to do so, we make much use of IRC, so having an account you can use to access the main #xubuntu-devel channel will help you, alternatively you can access the channel via the IRC tab of the Xubuntu <ulink url="http://dev.xubuntu.org/">development</ulink> tracker.</para> |
| 343 | |
| 344 | <para>Join the Xubuntu Testers <ulink url="https://launchpad.net/~xubuntu-testers">Launchpad</ulink> team.</para> |
| 345 | |
| 346 | @@ -36,9 +36,9 @@ |
| 347 | <section id="qa-infra-iso"> |
| 348 | <title>Getting the ISO</title> |
| 349 | |
| 350 | - <para>Iso's can be obtained through a few methods. The simplest method is to visit the <ulink url="http://iso.qa.ubuntu.com/">ISO</ulink> tracker. Follow the testcases through version to Xubuntu's group of tests. Then choose either 32 or 64 bit. Download links are available there</para> |
| 351 | + <para>ISOs can be obtained through a few methods. The simplest method is to visit the <ulink url="http://iso.qa.ubuntu.com/">ISO</ulink> tracker. Follow the testcases through version to Xubuntu's group of tests. Then choose either 32 or 64 bit. Download links are available there</para> |
| 352 | |
| 353 | - <para>When you intend to test more regularly, then you might find (especially if bandwidth is an issue for you) using the <ulink url="https://help.ubuntu.com/community/ZsyncCdImage">zsync</ulink> link more appropriate. This is will just grab the difference between your local copy and the current one.</para> |
| 354 | + <para>When testing more regularly, you might find (especially where bandwidth is an issue for you) using the <ulink url="https://help.ubuntu.com/community/ZsyncCdImage">zsync</ulink> link more appropriate. This is will just grab the difference between your local copy and the current one.</para> |
| 355 | |
| 356 | </section> |
| 357 | |
| 358 | @@ -50,7 +50,10 @@ |
| 359 | <para>There are two main methods of testing the ISO:</para> |
| 360 | |
| 361 | <itemizedlist> |
| 362 | - <listitem><para>Using a virtual machine enables you to carry on using a normal release and to test our ISO's. You can install a virtual machine by directly using your downloaded ISO.</para></listitem> |
| 363 | + <listitem><para>Using a virtual machine enables you to carry on using a normal release and to test our ISOs. You can install a virtual machine by directly using your downloaded ISO.</para></listitem> |
| 364 | + |
| 365 | + <note><para>While it is possible to use VirtualBox, past experience has shown that issues found when testing in VirtualBox are hard to replicate elsewhere. You might want to look into using <ulink url="https://help.ubuntu.com/community/KVM">KVM</ulink>. Members of Xubuntu QA have some experience with using this for testing and can help</para></note> |
| 366 | + |
| 367 | <listitem><para>Install the ISO to hardware where that possibility is available. This is more important towards the end of the development cycle. You will necessarily need to have the ISO in some bootable medium. A member of Xubuntu's Website team details a simple method for preparing a bootable <ulink url="http://princessleia.com/journal/2016/03/xubuntu-16-04-iso-testing-tips/">USB</ulink> stick with Gnome Disks.</para></listitem> |
| 368 | </itemizedlist> |
| 369 | </section> |
| 370 | |
| 371 | === modified file 'contributor-docs/C/qa-testing.xml' |
| 372 | --- contributor-docs/C/qa-testing.xml 2016-03-10 17:05:56 +0000 |
| 373 | +++ contributor-docs/C/qa-testing.xml 2017-02-13 18:00:31 +0000 |
| 374 | @@ -16,10 +16,12 @@ |
| 375 | <section id="qa-iso"> |
| 376 | <title>ISOs</title> |
| 377 | |
| 378 | - <para>In general links for specific isos for daily or milestone use can be found at the <ulink url="http://iso.qa.ubuntu.com/">ISO Tracker</ulink> a link exists to the <ulink url="http://cdimage.ubuntu.com/xubuntu/daily-live/current/">current</ulink> development daily iso. This can be useful, especially when setting up methods to download your testing iso, such as with <ulink url="https://help.ubuntu.com/community/ZsyncCdImage">zsync</ulink> |
| 379 | + <para>In general links for specific isos for daily or milestone use can be found at the <ulink url="http://iso.qa.ubuntu.com/">ISO Tracker</ulink> A link exists for the <ulink url="http://cdimage.ubuntu.com/xubuntu/daily-live/current/">current</ulink> development daily iso. This can be useful, especially when setting up methods to download your testing iso, such as with <ulink url="https://help.ubuntu.com/community/ZsyncCdImage">zsync</ulink> |
| 380 | + |
| 381 | + <note><para>You can find the last known boot and installation status of our ISOs at <ulink url="http://dev.xubuntu.org/#tab-qa">QA Status</ulink> of the development status tracker</para></note> |
| 382 | </para> |
| 383 | </section> |
| 384 | - |
| 385 | + |
| 386 | <section id="qa-testing-exploratory"> |
| 387 | <title>Exploratory Testing</title> |
| 388 | |
| 389 | @@ -27,7 +29,7 @@ |
| 390 | |
| 391 | <para>In essence, exploratory testing means running the development release and doing your daily tasks with the system and finally, filing bugs when you find them. This allows Xubuntu to get a much larger spread of testing than is possible with predefined tests.</para> |
| 392 | |
| 393 | - <para>A useful way to deal with this is dual (or multiple) boots. Where you can ensure you are able to access at all times a working version. In this way you can do as much work in the development release as is practical – all the while watching for bugs and regressions in the development release.</para> |
| 394 | + <para>A useful way to deal with this is dual (or multiple) boots. By dual (or multiple) booting you can ensure you are able to access at all times a working version while testing the development system. In this way you can do as much work in the development release as is practical – all the while watching for bugs and regressions in the development release.</para> |
| 395 | |
| 396 | <para>Issues which the development team are keen to address include, in addition to normally reported issues, usability bugs, missing icons, inconsistent functionality.</para> |
| 397 | </section> |
| 398 | @@ -43,11 +45,11 @@ |
| 399 | <listitem><para><ulink url="https://launchpad.net/~xubuntu-dev/+archive/ubuntu/ppa">Xubuntu daily builds</ulink> for daily Git and Bzr builds for packages related to Xubuntu and/or Xfce4</para></listitem> |
| 400 | </itemizedlist> |
| 401 | |
| 402 | - <para>In addition to these 3 main PPAs, developers also provide more specific PPAs for applications, such as the <ulink url="https://launchpad.net/~catfish-search/+archive/ubuntu/ppa">Catfish PPA</ulink> which provides catfish and both a daily and unstable version for testing when required.</para> |
| 403 | + <note><para>At times the development team use other PPAs to test specific packages. Details of these will be made known to testers when appropriate</para></note> |
| 404 | |
| 405 | <para>Installing these three PPAs means that you will be using and testing packages that developers are currently working with, this means that regressions found by you will not be present once they are released.</para> |
| 406 | |
| 407 | - <para>At times it is useful to remove a PPA. Using ppa-purge causes apt to disable a PPA source list and then change affected packages back to the default versions.</para> |
| 408 | + <para>Removing an in use PPA. Using ppa-purge causes apt to disable a PPA source list and then change affected packages back to the default versions.</para> |
| 409 | |
| 410 | <itemizedlist> |
| 411 | <listitem><para>Run <userinput>sudo apt-get install ppa-purge</userinput></para></listitem> |
| 412 | @@ -64,7 +66,7 @@ |
| 413 | |
| 414 | <itemizedlist> |
| 415 | <listitem><para>Check the devel mailing list close to the start of the cycle, where the decision as to which milestones we will participate in will be discussed.</para></listitem> |
| 416 | - <listitem><para>While milestone testing is in progress, please watch for rebuilds. These will take place either when we have reason to rebuild, eg following a bug fix landing, or more likely when the Ubuntu Release Team have cause to do so.</para></listitem> |
| 417 | + <listitem><para>While milestone testing is in progress, please watch for rebuilds. A rebuilt iso will have .something appended to the iso name (eg. "".1"). These will take place either when we have reason to rebuild, eg following a bug fix landing, or more likely when the Ubuntu Release Team have cause to do so.</para></listitem> |
| 418 | </itemizedlist> |
| 419 | </section> |
| 420 | |
| 421 | @@ -108,6 +110,6 @@ |
| 422 | |
| 423 | <para>For releases where we are making use of the Package Tracker, calls for package testing will be made to the xubuntu-devel mailing list as required. This could be a call from QA or Developers.</para> |
| 424 | |
| 425 | - <para>A schedule of planned tests is mailed to the Xubuntu Devel mailing list close to the cycle start,the schedule is shown on the <ulink url="https://trello.com/b/IV66JCHl/xubuntu-qa">QA Trello</ulink> page. Reminders of upcoming package test requirements are mailed to the Xubuntu devel mailing list as required. <emphasis>Specific developer testing requirement</emphasis> are mailed as they are available, often these packages will be those found on one of our PPAs.</para> |
| 426 | + <para>A schedule of planned tests will be mailed to the Xubuntu Devel mailing list close to the cycle start. Reminders of upcoming package test requirements are mailed to the Xubuntu devel mailing list as required. <emphasis>Specific developer testing requirement</emphasis> are mailed as they are available, often these packages will be those found on one of our PPAs.</para> |
| 427 | </section> |
| 428 | </chapter> |


General direction and changes are OK; see some minor comments on the formatting inline.