Paste #l8oDqhn3ZEl9yO5YKrGO
=== modified file 'contributor-docs/C/common-reference.xml'
| 146 | 146 | </section> |
|---|---|---|
| 147 | 147 | |
| 148 | 148 | <section id="qa-team-links"> |
| 149 | |
|
| 149 | <title>Useful QA Links</title> | |
| 150 | 150 | |
| 151 | <itemizedlist> | |
| 152 | <listitem><para><ulink url="https://launchpad.net/~xubuntu-qa">Xubuntu QA</ulink></para></listitem> | |
| 153 | <listitem><para><ulink url="https://launchpad.net/~xubuntu-testers">Xubuntu Testers</ulink></para></listitem> | |
| 154 | <listitem><para><ulink url="http://iso.qa.ubuntu.com/qatracker">ISO Tracker</ulink></para></listitem> | |
| 155 | <listitem><para><ulink url="http://packages.qa.ubuntu.com/">Package Tracker</ulink></para></listitem> | |
| 156 | <listitem><para><ulink url="https://wiki.ubuntu.com/QATeam">Ubuntu QA Team Wiki</ulink></para></listitem> | |
| 157 | <listitem><para><ulink url="https://launchpad.net/ubuntu-manual-tests/">Ubuntu Manual Tests</ulink></para></listitem> | |
| 158 | </itemizedlist> | |
| 151 | <itemizedlist> | |
| 152 | <listitem><para><ulink url="https://launchpad.net/~xubuntu-qa">Xubuntu QA</ulink></para></listitem> | |
| 153 | <listitem><para><ulink url="https://launchpad.net/~xubuntu-testers">Xubuntu Testers</ulink></para></listitem> | |
| 154 | <listitem><para><ulink url="http://iso.qa.ubuntu.com/qatracker">ISO Tracker</ulink></para></listitem> | |
| 155 | <listitem><para><ulink url="http://packages.qa.ubuntu.com/">Package Tracker</ulink></para></listitem> | |
| 156 | <listitem><para><ulink url="https://wiki.ubuntu.com/QATeam">Ubuntu QA Team Wiki</ulink></para></listitem> | |
| 157 | <listitem><para><ulink url="https://launchpad.net/ubuntu-manual-tests/">Ubuntu Manual Tests</ulink></para></listitem> | |
| 158 | </itemizedlist> | |
| 159 | 159 | </section> |
| 160 | 160 | </appendix> |
| 16 | 16 | <section id="development-packageset"> |
|---|---|---|
| 17 | 17 | <title>Xubuntu packageset</title> |
| 18 | 18 | |
| 19 | <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> |
|
| 19 | <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>.</para> | |
| 20 | 20 | |
| 21 | 21 | </section> |
| 22 | 22 |
| 24 | 24 | |
|---|---|---|
| 25 | 25 | <section id="docs-editing"> |
| 26 | 26 | <title>Editing the User Documentation</title> |
| 27 | <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> | |
| 28 | ||
| 29 | <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> | |
| 27 | ||
| 28 | <para>Changes to the user documentation should be made to the .xml files under <literal>user-docs/C/</literal>. Once edited and saved, push changes to your local branch as detailed in <xref linkend="common-reference" />.</para> | |
| 29 | ||
| 30 | <para>Similarly, changes to the contributor documentation should be made to the .xml files under <literal>contributor-docs/C/</literal>.</para> | |
| 30 | 31 | </section> |
| 31 | 32 | |
| 32 | 33 | <section id="docs-packages"> |
| … | ||
| 57 | 58 | <listitem><para><ulink url="https://www.transifex.com/projects/p/xfce4-whiskermenu-plugin/">Whiskermenu</ulink></para></listitem> |
| 58 | 59 | </itemizedlist> |
| 59 | 60 | </section> |
| 60 | </section> | |
| 61 | ||
| 62 | 61 | |
| 63 | 62 | <section id="docs-packages-xubuntu-mainly"> |
| 64 | 63 | <title>Mainly built for and used by Xubuntu</title> |
| … | ||
| 71 | 70 | <listitem><para><ulink url="https://translations.launchpad.net/mugshot">Mugshot</ulink></para></listitem> |
| 72 | 71 | </itemizedlist> |
| 73 | 72 | </section> |
| 74 | ||
| 73 | </section> | |
| 75 | 74 | |
| 76 | 75 | <section id="docs-translation-guidelines"> |
| 77 | 76 | <title>Translation guidelines for Xubuntu packages</title> |
| 78 | 77 | |
| 79 | 78 | <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> |
| 80 | 79 | |
| 81 | <para>The <ulink url="https://wiki.ubuntu.com/Translations/Contact/Teams">language-specific translation |
|
| 80 | <para>The <ulink url="https://wiki.ubuntu.com/Translations/Contact/Teams">language-specific translation teams</ulink> usually want to encourage some conventions; please contact the appropriate language-specific team before translating.</para> | |
| 82 | 81 | |
| 83 | 82 | <para>More general translation guidelines can be found at the <ulink url="https://help.launchpad.net/Translations/Guide">Launchpad translations guide</ulink>.</para> |
| 84 | 83 | |
| 34 | 34 | <para>Before submitting a bug, you should look at the <ulink url="https://launchpad.net/ubuntu/+bugs">existing bug reports</ulink> and release notes to verify the bug hasn’t been reported already. If the bug has not already been reported, you should file a new bug report. It is sensible to read through the <ulink url="https://help.ubuntu.com/community/ReportingBugs">bug reporting guidelines</ulink> before filing your first bug.</para> |
|---|---|---|
| 35 | 35 | |
| 36 | 36 | <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> |
| 37 | ||
| 38 | <note><para>If you are unsure of the package name to report against, you can use your mouse to click on the application windowi; in a terminal run <userinput>ubuntu-bug -w</userinput>, click to close the message window and then click on the application window.</para></note> | |
| 37 | 39 | </section> |
| 38 | 40 | |
| 39 | <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> | |
| 40 | ||
| 41 | 41 | <section id="qa-bugs-ppa"> |
| 42 | 42 | <title>Reporting bugs with PPAs</title> |
| 43 | 43 | |
| 44 | <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 |
|
| 44 | <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 <literal>https://bugs.launchpad.net/ubuntu/+source/PACKAGENAME/+filebug</literal>.</para> | |
| 45 | 45 | |
| 46 | <para>Crash logs related to the package can be found in |
|
| 46 | <para>Crash logs related to the package can be found in <literal>/var/crash/</literal>. This directory sometimes requires superuser (<literal>sudo</literal>) 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> | |
| 47 | 47 | |
| 48 | 48 | <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> |
| 49 | 49 | </section> |
| … | ||
| 53 | 53 | |
| 54 | 54 | <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> |
| 55 | 55 | |
| 56 | <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 |
|
| 56 | <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 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> | |
| 57 | 57 | |
| 58 | 58 | <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> |
| 59 | 59 | </section> |
| 14 | 14 | <chapter id="qa-team"> |
|---|---|---|
| 15 | 15 | <title>QA Team Responsibilies</title> |
| 16 | 16 | |
| 17 | |
|
| 17 | <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> | |
| 18 | 18 | |
| 19 | |
|
| 19 | <section id="qa-team-basics"> | |
| 20 | 20 | <title>QA Team</title> |
| 21 | 21 | |
| 22 | 22 | <para>The Xubuntu QA team was formed to ensure that the quality of a released Xubuntu conforms to the parameters laid out in the Xubuntu Processes documents. In order to successfully accomplish this, close team working relationships, especially with the development team and the Xubuntu Council are paramount. Xubuntu's success is based on close working amongst all of its various teams.</para> |
| … | ||
| 62 | 62 | |
| 63 | 63 | <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> |
| 64 | 64 | |
| 65 | <para>When a package during test constantly fails, or bug reports indicate a failure in a package for something not tested |
|
| 65 | <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> | |
| 66 | 66 | |
| 67 | 67 | <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> |
| 68 | 68 | |
| 16 | 16 | <section id="qa-infra"> |
|---|---|---|
| 17 | 17 | <title>Getting ready to test</title> |
| 18 | 18 | |
| 19 | <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. |
|
| 19 | <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> | |
| 20 | 20 | </section> |
| 21 | 21 | |
| 22 | 22 | <section id="qa-infra-specs"> |
| 23 | 23 | <title>Contacts</title> |
| 24 | 24 | |
| 25 | <para>You need a Launchpad account, |
|
| 25 | <para>You need a Launchpad account, in order to join the necessary team(s) on it, and log into the 2 QA trackers.</para> | |
| 26 | 26 | |
| 27 | <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"> |
|
| 27 | <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> | |
| 28 | 28 | |
| 29 | 29 | <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> |
| 30 | 30 | |
| … | ||
| 36 | 36 | <section id="qa-infra-iso"> |
| 37 | 37 | <title>Getting the ISO</title> |
| 38 | 38 | |
| 39 | <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 |
|
| 39 | <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> | |
| 40 | 40 | |
| 41 | 41 | <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> |
| 42 | 42 | |
| … | ||
| 45 | 45 | <section id="qa-infra-test"> |
| 46 | 46 | <title>Methods of testing</title> |
| 47 | 47 | |
| 48 | <para>Now you've set up your basic contact(s) |
|
| 48 | <para>Now you've set up your basic contact(s) and have your ISO, you are in a position to test it.</para> | |
| 49 | 49 | |
| 50 | 50 | <para>There are two main methods of testing the ISO:</para> |
| 51 | 51 | |
| 52 | 52 | <itemizedlist> |
| 53 | 53 | <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> |
| 54 | ||
| 55 | <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> | |
| 56 | ||
| 57 | 54 | <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> |
| 58 | 55 | </itemizedlist> |
| 56 | ||
| 57 | <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> | |
| 59 | 58 | </section> |
| 60 | 59 | |
| 61 | 60 | <section id="qa-infra-track"> |
| … | ||
| 70 | 69 | |
| 71 | 70 | <para>These trackers form the backbone of what we are able to gain from your testing. It is important that you report your results.</para> |
| 72 | 71 | |
| 73 | <para>The next two sections of these documents go into more detail on how you can test for us and how to report bugs for us |
|
| 72 | <para>The next two sections of these documents go into more detail on how you can test for us and how to report bugs for us.</para> | |
| 74 | 73 | </section> |
| 75 | 74 | |
| 76 | 75 | |
| 16 | 16 | <section id="qa-iso"> |
|---|---|---|
| 17 | 17 | <title>ISOs</title> |
| 18 | 18 | |
| 19 | <para>In general links for specific |
|
| 19 | <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></para> | |
| 20 | 20 | |
| 21 | 21 | <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> |
| 22 | </para> | |
| 23 | 22 | </section> |
| 24 | 23 | |
| 25 | 24 | <section id="qa-testing-exploratory"> |
| … | ||
| 66 | 65 | |
| 67 | 66 | <itemizedlist> |
| 68 | 67 | <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> |
| 69 | <listitem><para>While milestone testing is in progress, please watch for rebuilds. A rebuilt |
|
| 68 | <listitem><para>While milestone testing is in progress, please watch for rebuilds. A rebuilt ISO will have <literal>.something</literal> appended to its name (e.g. <literal>.1</literal>). These will take place either when we have reason to rebuild, e.g. following a bug fix landing, or more likely when the Ubuntu Release Team have cause to do so.</para></listitem> | |
| 70 | 69 | </itemizedlist> |
| 71 | 70 | </section> |
| 72 | 71 | |
| … | ||
| 93 | 92 | </section> |
| 94 | 93 | |
| 95 | 94 | <section id="qa-testing-upgrade"> |
| 96 | <title>Upgrade Testing</title> | |
| 97 | ||
| 98 | <para>About half way through any development cycle (around the beta milestones) we need to test upgrades from the previous release to the new development version. When the development version is intended to be the next LTS release, we need to test both upgrade paths: LTS to LTS and regular to LTS.</para> | |
| 99 | ||
| 100 | <para>The ISO tracker has a section for upgrade tests which does not change daily, but runs from Friday to Friday. This enables us to test upgrades for a week rather than a day. During these tests it is preferred that the image used for testing is the one built on the first Friday, except where bugs are reported and fixes landed.</para> | |
| 101 | ||
| 102 | <itemizedlist> | |
| 103 | <listitem><para>Upgrade: tested using the update-manager</para></listitem> | |
| 104 | <listitem><para>Upgrade (image): tested using the daily image</para></listitem> | |
| 105 | </itemizedlist> | |
| 106 | ||
| 95 | <title>Upgrade Testing</title> | |
| 96 | ||
| 97 | <para>About half way through any development cycle (around the beta milestones) we need to test upgrades from the previous release to the new development version. When the development version is intended to be the next LTS release, we need to test both upgrade paths: LTS to LTS and regular to LTS.</para> | |
| 98 | ||
| 99 | <para>The ISO tracker has a section for upgrade tests which does not change daily, but runs from Friday to Friday. This enables us to test upgrades for a week rather than a day. During these tests it is preferred that the image used for testing is the one built on the first Friday, except where bugs are reported and fixes landed.</para> | |
| 100 | ||
| 101 | <itemizedlist> | |
| 102 | <listitem><para>Upgrade: tested using the update-manager</para></listitem> | |
| 103 | <listitem><para>Upgrade (image): tested using the daily image</para></listitem> | |
| 104 | </itemizedlist> | |
| 105 | </section> | |
| 107 | 106 | |
| 108 | 107 | <section id="qa-testing-package"> |
| 109 | 108 | <title>Package Testing</title> |