Merge lp:~knome/xubuntu-docs/contributor-doc-improvements into lp:xubuntu-docs/zesty
- contributor-doc-improvements
- Merge into zesty
Proposed by
Pasi Lallinaho
Status: | Merged |
---|---|
Merged at revision: | 631 |
Proposed branch: | lp:~knome/xubuntu-docs/contributor-doc-improvements |
Merge into: | lp:xubuntu-docs/zesty |
Diff against target: |
1136 lines (+471/-349) 24 files modified
contributor-docs/C/common-reference.xml (+2/-2) contributor-docs/C/development.xml (+1/-0) contributor-docs/C/documentation-tasks.xml (+47/-0) contributor-docs/C/documentation-translations.xml (+82/-0) contributor-docs/C/documentation-working.xml (+37/-0) contributor-docs/C/documentation.xml (+9/-92) contributor-docs/C/getting-started.xml (+2/-1) contributor-docs/C/index.xml (+2/-5) contributor-docs/C/processes.xml (+1/-0) contributor-docs/C/qa-bugs.xml (+2/-3) contributor-docs/C/qa-infra.xml (+73/-0) contributor-docs/C/qa-team.xml (+0/-136) contributor-docs/C/qa-tester.xml (+0/-76) contributor-docs/C/qa-testing.xml (+3/-4) contributor-docs/C/qa.xml (+138/-0) contributor-docs/C/strategy-document.xml (+1/-0) contributor-docs/C/website.xml (+5/-4) contributor-docs/Makefile (+3/-3) contributor-docs/libs/xubuntu-contributor.ent (+1/-2) libs-common/css/style.css (+19/-6) libs-common/xubuntu-common.ent (+1/-1) libs-common/xubuntu-docbook-xhtml-contributor.xsl (+35/-0) libs-common/xubuntu-docbook-xhtml.xsl (+6/-10) user-docs/C/index.xml (+1/-4) |
To merge this branch: | bzr merge lp:~knome/xubuntu-docs/contributor-doc-improvements |
Related bugs: |
Reviewer | Review Type | Date Requested | Status |
---|---|---|---|
David Pires | Approve | ||
David Pearson (community) | qa section reorganization | Approve | |
Kev Bowring (community) | Approve | ||
Review via email: mp+318825@code.launchpad.net |
This proposal supersedes a proposal from 2017-03-02.
Commit message
Description of the change
Updated based on Kev's comments.
To post a comment you must log in.
Revision history for this message
Kev Bowring (flocculant) wrote : Posted in a previous version of this proposal | # |
review:
Needs Fixing
Revision history for this message
Kev Bowring (flocculant) wrote : | # |
Thanks Pasi - lgtm - leave it to last person to approve
Revision history for this message
Kev Bowring (flocculant) : | # |
review:
Approve
Revision history for this message
David Pearson (akxwi-dave) : | # |
review:
Approve
(qa section reorganization)
Revision history for this message
David Pires (slickymaster) wrote : Posted in a previous version of this proposal | # |
Approved.
Thanks for these improvements, Pasi.
review:
Approve
Revision history for this message
David Pires (slickymaster) : | # |
review:
Approve
Preview Diff
[H/L] Next/Prev Comment, [J/K] Next/Prev File, [N/P] Next/Prev Hunk
1 | === modified file 'contributor-docs/C/common-reference.xml' |
2 | --- contributor-docs/C/common-reference.xml 2017-02-19 07:48:04 +0000 |
3 | +++ contributor-docs/C/common-reference.xml 2017-03-02 18:48:00 +0000 |
4 | @@ -14,7 +14,7 @@ |
5 | <title>Common Reference</title> |
6 | |
7 | <section id="bzr"> |
8 | - <title>Bazaar (Bzr)</title> |
9 | + <title>Using Bazaar (Bzr)</title> |
10 | |
11 | <para>Bazaar (commonly referred to as Bzr) is the version control system primarily used in Xubuntu development.</para> |
12 | |
13 | @@ -74,7 +74,7 @@ |
14 | </section> |
15 | |
16 | <section id="git"> |
17 | - <title>Git</title> |
18 | + <title>Using Git</title> |
19 | |
20 | <para>Git is the version control system used in Xfce development.</para> |
21 | |
22 | |
23 | === modified file 'contributor-docs/C/development.xml' |
24 | --- contributor-docs/C/development.xml 2017-02-19 07:48:04 +0000 |
25 | +++ contributor-docs/C/development.xml 2017-03-02 18:48:00 +0000 |
26 | @@ -12,6 +12,7 @@ |
27 | ]> |
28 | <chapter id="development"> |
29 | <title>Development</title> |
30 | + <?dbhtml stop-chunking?> |
31 | |
32 | <section id="development-packageset"> |
33 | <title>Xubuntu packageset</title> |
34 | |
35 | === added file 'contributor-docs/C/documentation-tasks.xml' |
36 | --- contributor-docs/C/documentation-tasks.xml 1970-01-01 00:00:00 +0000 |
37 | +++ contributor-docs/C/documentation-tasks.xml 2017-03-02 18:48:00 +0000 |
38 | @@ -0,0 +1,47 @@ |
39 | +<?xml version="1.0" encoding="UTF-8"?> |
40 | +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
41 | +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ |
42 | +<!ENTITY % xubuntu-common SYSTEM "../../libs-common/xubuntu-common.ent"> |
43 | +%xubuntu-common; |
44 | +<!ENTITY % xubuntu-contributor SYSTEM "../libs/xubuntu-contributor.ent"> |
45 | +%xubuntu-contributor; |
46 | +<!ENTITY % xinclude SYSTEM "../../libs-common/xinclude.mod"> |
47 | +%xinclude; |
48 | +<!ENTITY language "&EnglishAmerican;"> |
49 | +<!ENTITY language "C"> |
50 | +]> |
51 | +<section id="docs-tasks"> |
52 | + <title>Tasks</title> |
53 | + |
54 | + <section id="docs-tasks-user"> |
55 | + <title>User documentation</title> |
56 | + |
57 | + <para>The documentation team works with the developers to ensure any new features that are part of the core functionality of the operating system are covered in the documentation. In addition, the documentation team makes sure features highlighted in the installer slideshow or any other marketing material are appropriately documented. When completely new sections are written, the documentation team makes sure the Xubuntu team has a chance to review and propose changes and fixes to the new sections. When any documented features are removed or changed, the team makes sure the documentation does not refer to any removed functionality.</para> |
58 | + |
59 | + <note><para>The team should be aware of changes to new releases, particularly on LTS releases and potential SRUs, as those might affect documentation.</para></note> |
60 | + |
61 | + <para>The documentation team is responsible for making sure the documentation is updated before the Documentation String Freeze prior to uploading. Once the upload is done, the team coordinates translation efforts and makes sure the documentation gets another upload before the Translation Freeze. The team should also request the <ulink url="http://docs.xubuntu.org/">online documentation</ulink> to be updated shortly before the release.</para> |
62 | + |
63 | + <para>The documentation team should also look to improve and expand the existing documentation, especially during the development cycles when most uploads are done for maintenance purposes. The team should involve the community in these efforts the best way they see fit.</para> |
64 | + </section> |
65 | + |
66 | + <section id="docs-tasks-contributor"> |
67 | + <title>Contributor documentation</title> |
68 | + |
69 | + <para>The documentation team lead the efforts to write the contributor documentation. While the various subteams are responsible for their own sections, the documentation team should help the teams to get their content pushed to the main branch and where needed, help contributors to format the content in the DocBook markup.</para> |
70 | + |
71 | + <para>The <ulink url="http://docs.xubuntu.org/contributors/">online contributor documentation</ulink> should be kept updated especially when major changes are made; the documentation team should request an update whenever they see fit.</para> |
72 | + </section> |
73 | + |
74 | + <section id="docs-tasks-other"> |
75 | + <title>Other tasks</title> |
76 | + |
77 | + <para>In addition to the above, the documentation team is strongly encouraged to do the following:</para> |
78 | + |
79 | + <itemizedlist> |
80 | + <listitem><para>Work with the Quality Assurance team to write and maintain testcases</para></listitem> |
81 | + <listitem><para>Work with the website team to improve the website content and write FAQ or other documentation related articles</para></listitem> |
82 | + <listitem><para>Work with the marketing team on various projects, like flyers</para></listitem> |
83 | + </itemizedlist> |
84 | + </section> |
85 | +</section> |
86 | \ No newline at end of file |
87 | |
88 | === added file 'contributor-docs/C/documentation-translations.xml' |
89 | --- contributor-docs/C/documentation-translations.xml 1970-01-01 00:00:00 +0000 |
90 | +++ contributor-docs/C/documentation-translations.xml 2017-03-02 18:48:00 +0000 |
91 | @@ -0,0 +1,82 @@ |
92 | +<?xml version="1.0" encoding="UTF-8"?> |
93 | +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
94 | +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ |
95 | +<!ENTITY % xubuntu-common SYSTEM "../../libs-common/xubuntu-common.ent"> |
96 | +%xubuntu-common; |
97 | +<!ENTITY % xubuntu-contributor SYSTEM "../libs/xubuntu-contributor.ent"> |
98 | +%xubuntu-contributor; |
99 | +<!ENTITY % xinclude SYSTEM "../../libs-common/xinclude.mod"> |
100 | +%xinclude; |
101 | +<!ENTITY language "&EnglishAmerican;"> |
102 | +<!ENTITY language "C"> |
103 | +]> |
104 | +<section id="docs-translations"> |
105 | + <title>Translations</title> |
106 | + |
107 | + <section id="docs-packages"> |
108 | + <title>Packages to be translated</title> |
109 | + |
110 | + <para>These are packages that the Xubuntu team considers important, and should take precedence when translating.</para> |
111 | + |
112 | + <section id="docs-packages-essential"> |
113 | + <title>Packages that only exist in Xubuntu</title> |
114 | + |
115 | + <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> |
116 | + |
117 | + <itemizedlist> |
118 | + <listitem><para><ulink url="https://translations.launchpad.net/xubuntu-docs">Xubuntu Documentation</ulink></para></listitem> |
119 | + <listitem><para><ulink url="https://translations.launchpad.net/xubuntu-default-settings">Xubuntu Default Settings</ulink></para></listitem> |
120 | + <listitem><para><ulink url="https://translations.launchpad.net/ubuntu/&devel-codename;/+source/ubiquity-slideshow-ubuntu/+pots/ubiquity-slideshow-xubuntu">Ubiquity Slideshow for Xubuntu</ulink></para></listitem> |
121 | + </itemizedlist> |
122 | + </section> |
123 | + |
124 | + <section id="docs-packages-xubuntu-important"> |
125 | + <title>Used by Xubuntu</title> |
126 | + |
127 | + <para>These packages are used by Xubuntu and provide features to the Xubuntu experience. When these are translated, the base system is immediately more usable for more people.</para> |
128 | + |
129 | + <itemizedlist> |
130 | + <listitem><para><ulink url="https://translations.launchpad.net/catfish-search">Catfish</ulink></para></listitem> |
131 | + <listitem><para><ulink url="https://translations.launchpad.net/lightdm-gtk-greeter">LightDM GTK+ Greeter</ulink></para></listitem> |
132 | + <listitem><para><ulink url="https://translations.launchpad.net/lightdm-gtk-greeter-settings/">LightDM GTK+ Greeter Settings</ulink></para></listitem> |
133 | + <listitem><para><ulink url="https://translations.launchpad.net/menulibre">MenuLibre</ulink></para></listitem> |
134 | + <listitem><para><ulink url="https://translations.launchpad.net/mugshot">Mugshot</ulink></para></listitem> |
135 | + <listitem><para><ulink url="https://www.transifex.com/projects/p/xfce4-whiskermenu-plugin/">Whiskermenu</ulink></para></listitem> |
136 | + </itemizedlist> |
137 | + </section> |
138 | + </section> |
139 | + |
140 | + <section id="docs-translation-guidelines"> |
141 | + <title>Translation guidelines for Xubuntu packages</title> |
142 | + |
143 | + <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> |
144 | + |
145 | + <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> |
146 | + |
147 | + <para>More general translation guidelines can be found at the <ulink url="https://help.launchpad.net/Translations/Guide">Launchpad translations guide</ulink>.</para> |
148 | + |
149 | + <section id="docs-translation-guidelines-validity"> |
150 | + <title>Maintain translation validity</title> |
151 | + |
152 | + <para><emphasis>Tags should not be translated.</emphasis> Where you see a tag in the source string (for example: "<xref linkend="&xubuntu-web;" />"), the tag and anything inside the tag itself should not be translated. It is very important to copy and paste these tags exactly as they appear in the source string. Note: The exception to this is where a tag contains a URL that has an equivalent, translated version. In those cases the translator should use discretion about whether to localise the URL.</para> |
153 | + |
154 | + <para><emphasis>Entities should not be translated.</emphasis> Where you see a phrase expressed like "&gt;" or "&xubuntu-web;", do not change this.</para> |
155 | + |
156 | + <para><emphasis>Always maintain the order of tags.</emphasis> When you see different tags nested inside each other (for example: "<menuchoice><guimenu>System</guimenu><guimenuitem>Administration</guimenuitem><guimenuitem>Users and Groups</guimenuitem></menuchoice>"), you must always preserve that order carefully - copying and pasting from the source language (English) is the best way to ensure that you do this correctly.</para> |
157 | + |
158 | + <note><para>Different programming languages and software might have different variable syntaxes; make sure you are familiar with the appropriate software variable syntax when translating. More information on this can often be found in the translation string comment.</para></note> |
159 | + </section> |
160 | + |
161 | + <section id="docs-translation-guidelines-conventions"> |
162 | + <title>Follow good and existing conventions</title> |
163 | + |
164 | + <para><emphasis>Use application and label names found in the (graphical) UI.</emphasis> When translating UI labels and application names, use the term or name that is used on the graphical UI. This makes it easier for the user to follow the instructions. Running the system in both the translation target language and English can help with this.</para> |
165 | + |
166 | + <para><emphasis>Do not change the amount of spacing.</emphasis> When translating, do not change the amount of spacing inside our outside tags. Keeping the spacing as it is makes the technical reviewing of the translation easier.</para> |
167 | + |
168 | + <para><emphasis>Do not change the type of quotes used inside the tags.</emphasis> The double quotes ( " ) doesn't have the same significance in a DocBook, XHTML or XML tag as the guillemets ( « » ). Using different kind of quotes can potentially develop into validity problems as well.</para> |
169 | + |
170 | + <para><emphasis>Never change a tag to another.</emphasis> If you think a tag in the source is invalid or not semantic, file a bug against the package itself instead of changing it in the translation.</para> |
171 | + </section> |
172 | + </section> |
173 | +</section> |
174 | \ No newline at end of file |
175 | |
176 | === added file 'contributor-docs/C/documentation-working.xml' |
177 | --- contributor-docs/C/documentation-working.xml 1970-01-01 00:00:00 +0000 |
178 | +++ contributor-docs/C/documentation-working.xml 2017-03-02 18:48:00 +0000 |
179 | @@ -0,0 +1,37 @@ |
180 | +<?xml version="1.0" encoding="UTF-8"?> |
181 | +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
182 | +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ |
183 | +<!ENTITY % xubuntu-common SYSTEM "../../libs-common/xubuntu-common.ent"> |
184 | +%xubuntu-common; |
185 | +<!ENTITY % xubuntu-contributor SYSTEM "../libs/xubuntu-contributor.ent"> |
186 | +%xubuntu-contributor; |
187 | +<!ENTITY % xinclude SYSTEM "../../libs-common/xinclude.mod"> |
188 | +%xinclude; |
189 | +<!ENTITY language "&EnglishAmerican;"> |
190 | +<!ENTITY language "C"> |
191 | +]> |
192 | +<section id="docs-working"> |
193 | + <title>Working with the documentation</title> |
194 | + |
195 | + <section id="docs-working-editing"> |
196 | + <title>Editing the documentation</title> |
197 | + |
198 | + <para>First make sure you have the Bzr branch <literal>&branch;lp:xubuntu-docs</literal> and the build dependencies for <literal>&package;xubuntu-docs</literal>.</para> |
199 | + |
200 | + <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="bzr" />.</para> |
201 | + |
202 | + <para>Similarly, changes to the contributor documentation should be made to the .xml files under <literal>contributor-docs/C/</literal>.</para> |
203 | + </section> |
204 | + |
205 | + <section id="docs-working-notes-contributor"> |
206 | + <title>Notes on the contributor documentation</title> |
207 | + |
208 | + <para>For various reasons, the contributor documentation is more complex in structure than the user documentation. Particularly, pay attention to the following when working with the subteam documentation:</para> |
209 | + |
210 | + <itemizedlist> |
211 | + <listitem><para>If you want to create an introductory paragraph that is shown on the subteam main page, use the <literal><simplesect></literal> element. Otherwise this will be chunked into a separate HTML file. Note that this also removes the section from the Table of Contents.</para></listitem> |
212 | + <listitem><para>If you want a subsection of a section to be visible in the Table of Contents, use the <literal><sect1></literal> element. For an actual example, see the <literal>qa-*</literal> files.</para></listitem> |
213 | + <listitem><para>The sections are chunked up to the first level; this means all direct ascendants of <literal><chapter></literal> elements will be chunked into separate HTML files. If you want to avoid this (for example if your chapter is very short), insert the <literal><?dbhtml stop-chunking?></literal> after the <literal><title></literal> element of your chapter. Note that doing this will not stop the Table of Contents from being printed with each section; you might can use the <literal><simplesect></literal> element again to hide sections from the Table of Contents.</para></listitem> |
214 | + </itemizedlist> |
215 | + </section> |
216 | +</section> |
217 | |
218 | === modified file 'contributor-docs/C/documentation.xml' |
219 | --- contributor-docs/C/documentation.xml 2017-02-19 07:48:04 +0000 |
220 | +++ contributor-docs/C/documentation.xml 2017-03-02 18:48:00 +0000 |
221 | @@ -13,96 +13,13 @@ |
222 | <chapter id="documentation"> |
223 | <title>Documentation</title> |
224 | |
225 | - <section id="docs-building"> |
226 | - <title>Building the documentation locally</title> |
227 | - |
228 | - <itemizedlist> |
229 | - <listitem><para>Get the Bzr branch <literal>&branch;lp:xubuntu-docs</literal>.</para></listitem> |
230 | - <listitem><para>Get the build dependencies for <literal>&package;xubuntu-docs</literal>.</para></listitem> |
231 | - </itemizedlist> |
232 | - </section> |
233 | - |
234 | - <section id="docs-editing"> |
235 | - <title>Editing the User Documentation</title> |
236 | - |
237 | - <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> |
238 | - |
239 | - <para>Similarly, changes to the contributor documentation should be made to the .xml files under <literal>contributor-docs/C/</literal>.</para> |
240 | - </section> |
241 | - |
242 | - <section id="docs-packages"> |
243 | - <title>Packages to be translated</title> |
244 | - |
245 | - <para>These are packages that the Xubuntu team considers important, and should take precedence when translating.</para> |
246 | - |
247 | - <section id="docs-packages-xubuntu-only"> |
248 | - <title>The packages that only exist in Xubuntu</title> |
249 | - |
250 | - <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> |
251 | - |
252 | - <itemizedlist> |
253 | - <listitem><para><ulink url="https://translations.launchpad.net/xubuntu-docs">Xubuntu Documentation</ulink></para></listitem> |
254 | - <listitem><para><ulink url="https://translations.launchpad.net/xubuntu-default-settings">Xubuntu Default Settings</ulink></para></listitem> |
255 | - <listitem><para><ulink url="https://translations.launchpad.net/ubuntu/&devel-codename;/+source/ubiquity-slideshow-ubuntu/+pots/ubiquity-slideshow-xubuntu">Ubiquity Slideshow for Xubuntu</ulink></para></listitem> |
256 | - </itemizedlist> |
257 | - </section> |
258 | - |
259 | - <section id="docs-packages-xubuntu-used"> |
260 | - <title>Used by and essential for Xubuntu</title> |
261 | - |
262 | - <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> |
263 | - |
264 | - <itemizedlist> |
265 | - <listitem><para><ulink url="https://translations.launchpad.net/catfish-search">Catfish</ulink></para></listitem> |
266 | - <listitem><para><ulink url="https://translations.launchpad.net/lightdm-gtk-greeter">LightDM GTK+ Greeter</ulink></para></listitem> |
267 | - <listitem><para><ulink url="https://www.transifex.com/projects/p/xfce4-whiskermenu-plugin/">Whiskermenu</ulink></para></listitem> |
268 | - </itemizedlist> |
269 | - </section> |
270 | - |
271 | - <section id="docs-packages-xubuntu-mainly"> |
272 | - <title>Mainly built for and used by Xubuntu</title> |
273 | - |
274 | - <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> |
275 | - |
276 | - <itemizedlist> |
277 | - <listitem><para><ulink url="https://translations.launchpad.net/lightdm-gtk-greeter-settings/">LightDM GTK+ Greeter Settings</ulink></para></listitem> |
278 | - <listitem><para><ulink url="https://translations.launchpad.net/menulibre">MenuLibre</ulink></para></listitem> |
279 | - <listitem><para><ulink url="https://translations.launchpad.net/mugshot">Mugshot</ulink></para></listitem> |
280 | - </itemizedlist> |
281 | - </section> |
282 | - </section> |
283 | - |
284 | - <section id="docs-translation-guidelines"> |
285 | - <title>Translation guidelines for Xubuntu packages</title> |
286 | - |
287 | - <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> |
288 | - |
289 | - <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> |
290 | - |
291 | - <para>More general translation guidelines can be found at the <ulink url="https://help.launchpad.net/Translations/Guide">Launchpad translations guide</ulink>.</para> |
292 | - |
293 | - <section id="docs-translation-guidelines-validity"> |
294 | - <title>Maintain translation validity</title> |
295 | - |
296 | - <para><emphasis>Tags should not be translated.</emphasis> Where you see a tag in the source string (for example: "<xref linkend="&xubuntu-web;" />"), the tag and anything inside the tag itself should not be translated. It is very important to copy and paste these tags exactly as they appear in the source string. Note: The exception to this is where a tag contains a URL that has an equivalent, translated version. In those cases the translator should use discretion about whether to localise the URL.</para> |
297 | - |
298 | - <para><emphasis>Entities should not be translated.</emphasis> Where you see a phrase expressed like "&gt;" or "&xubuntu-web;", do not change this.</para> |
299 | - |
300 | - <para><emphasis>Always maintain the order of tags.</emphasis> When you see different tags nested inside each other (for example: "<menuchoice><guimenu>System</guimenu><guimenuitem>Administration</guimenuitem><guimenuitem>Users and Groups</guimenuitem></menuchoice>"), you must always preserve that order carefully - copying and pasting from the source language (English) is the best way to ensure that you do this correctly.</para> |
301 | - |
302 | - <note><para>Different programming languages and software might have different variable syntaxes; make sure you are familiar with the appropriate software variable syntax when translating. More information on this can often be found in the translation string comment.</para></note> |
303 | - </section> |
304 | - |
305 | - <section id="docs-translation-guidelines-conventions"> |
306 | - <title>Follow good and existing conventions</title> |
307 | - |
308 | - <para><emphasis>Use application and label names found in the (graphical) UI.</emphasis> When translating UI labels and application names, use the term or name that is used on the graphical UI. This makes it easier for the user to follow the instructions. Running the system in both the translation target language and English can help with this.</para> |
309 | - |
310 | - <para><emphasis>Do not change the amount of spacing.</emphasis> When translating, do not change the amount of spacing inside our outside tags. Keeping the spacing as it is makes the technical reviewing of the translation easier.</para> |
311 | - |
312 | - <para><emphasis>Do not change the type of quotes used inside the tags.</emphasis> The double quotes ( " ) doesn't have the same significance in a DocBook, XHTML or XML tag as the guillemets ( « » ). Using different kind of quotes can potentially develop into validity problems as well.</para> |
313 | - |
314 | - <para><emphasis>Never change a tag to another.</emphasis> If you think a tag in the source is invalid or not semantic, file a bug against the package itself instead of changing it in the translation.</para> |
315 | - </section> |
316 | - </section> |
317 | + <simplesect> |
318 | + <title>Introduction</title> |
319 | + |
320 | + <para>The Xubuntu documentation oversees the user documentation and contributor documentation as translations for the documentation and other packages important to Xubuntu. In addition the team works together with other teams in producing content and more.</para> |
321 | + </simplesect> |
322 | + |
323 | + <xi:include href="documentation-tasks.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
324 | + <xi:include href="documentation-working.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
325 | + <xi:include href="documentation-translations.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
326 | </chapter> |
327 | |
328 | === modified file 'contributor-docs/C/getting-started.xml' |
329 | --- contributor-docs/C/getting-started.xml 2017-01-25 19:18:56 +0000 |
330 | +++ contributor-docs/C/getting-started.xml 2017-03-02 18:48:00 +0000 |
331 | @@ -12,6 +12,7 @@ |
332 | ]> |
333 | <chapter id="getting-started"> |
334 | <title>Getting Started</title> |
335 | + <?dbhtml stop-chunking?> |
336 | |
337 | <section id="important-places"> |
338 | <title>Important Places</title> |
339 | @@ -25,7 +26,7 @@ |
340 | <section id="status-tracker"> |
341 | <title>Status Tracker</title> |
342 | |
343 | - <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> |
344 | + <para>The development for the current Xubuntu release is tracked in the <ulink url="http://dev.xubuntu.org/">Xubuntu development 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> |
345 | </section> |
346 | </section> |
347 | </chapter> |
348 | |
349 | === modified file 'contributor-docs/C/index.xml' |
350 | --- contributor-docs/C/index.xml 2017-01-25 19:18:56 +0000 |
351 | +++ contributor-docs/C/index.xml 2017-03-02 18:48:00 +0000 |
352 | @@ -44,7 +44,7 @@ |
353 | </legalnotice> |
354 | |
355 | <copyright> |
356 | - <year>2015</year> |
357 | + <year>2015–2017</year> |
358 | <holder>The Xubuntu documentation team. Xubuntu and Canonical are registered trademarks of Canonical Ltd.</holder> |
359 | </copyright> |
360 | |
361 | @@ -79,10 +79,7 @@ |
362 | <title>Subteam Documentation</title> |
363 | <xi:include href="development.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
364 | <xi:include href="documentation.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
365 | - <xi:include href="qa-tester.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
366 | - <xi:include href="qa-testing.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
367 | - <xi:include href="qa-bugs.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
368 | - <xi:include href="qa-team.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
369 | + <xi:include href="qa.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
370 | <xi:include href="website.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
371 | </part> |
372 | <!-- Common documentation --> |
373 | |
374 | === modified file 'contributor-docs/C/processes.xml' |
375 | --- contributor-docs/C/processes.xml 2016-08-31 21:49:33 +0000 |
376 | +++ contributor-docs/C/processes.xml 2017-03-02 18:48:00 +0000 |
377 | @@ -12,6 +12,7 @@ |
378 | ]> |
379 | <chapter id="processes"> |
380 | <title>Processes</title> |
381 | + <?dbhtml stop-chunking?> |
382 | |
383 | <para>This section describes some of the community processes for Xubuntu development. The processes should be used as guidelines: the main goal of this section is to describe <emphasis>what we do</emphasis>, not so much to describe <emphasis>what we should do</emphasis>.</para> |
384 | |
385 | |
386 | === modified file 'contributor-docs/C/qa-bugs.xml' |
387 | --- contributor-docs/C/qa-bugs.xml 2017-02-19 07:48:04 +0000 |
388 | +++ contributor-docs/C/qa-bugs.xml 2017-03-02 18:48:00 +0000 |
389 | @@ -10,8 +10,7 @@ |
390 | <!ENTITY language "&EnglishAmerican;"> |
391 | <!ENTITY language "C"> |
392 | ]> |
393 | - |
394 | -<chapter id="qa-bugs"> |
395 | +<sect1 id="qa-bugs"> |
396 | <title>Dealing with bugs</title> |
397 | |
398 | <section id="qa-bugs-tags"> |
399 | @@ -67,4 +66,4 @@ |
400 | |
401 | <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> |
402 | </section> |
403 | -</chapter> |
404 | +</sect1> |
405 | |
406 | === added file 'contributor-docs/C/qa-infra.xml' |
407 | --- contributor-docs/C/qa-infra.xml 1970-01-01 00:00:00 +0000 |
408 | +++ contributor-docs/C/qa-infra.xml 2017-03-02 18:48:00 +0000 |
409 | @@ -0,0 +1,73 @@ |
410 | +<?xml version="1.0" encoding="UTF-8"?> |
411 | +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
412 | +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ |
413 | +<!ENTITY % xubuntu-common SYSTEM "../../libs-common/xubuntu-common.ent"> |
414 | +%xubuntu-common; |
415 | +<!ENTITY % xubuntu-contributor SYSTEM "../libs/xubuntu-contributor.ent"> |
416 | +%xubuntu-contributor; |
417 | +<!ENTITY % xinclude SYSTEM "../../libs-common/xinclude.mod"> |
418 | +%xinclude; |
419 | +<!ENTITY language "&EnglishAmerican;"> |
420 | +<!ENTITY language "C"> |
421 | +]> |
422 | +<sect1 id="qa-infra"> |
423 | + <title>Testing Infrastructure</title> |
424 | + <section id="qa-infra-getting-ready"> |
425 | + <title>Getting ready to test</title> |
426 | + |
427 | + <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> |
428 | + </section> |
429 | + |
430 | + <section id="qa-infra-specs"> |
431 | + <title>Contacts</title> |
432 | + |
433 | + <para>You need a Launchpad account, in order to join the necessary team(s) on it, and log into the 2 QA trackers.</para> |
434 | + |
435 | + <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> |
436 | + |
437 | + <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> |
438 | + |
439 | + <para>Join the Xubuntu Testers <ulink url="https://launchpad.net/~xubuntu-testers">Launchpad</ulink> team.</para> |
440 | + |
441 | + <para>Consider adding your details to the <ulink url="http://wiki.xubuntu.org/qa/teamhardware">Hardware</ulink> page. We can use this data to request specific testing from specific testers.</para> |
442 | + </section> |
443 | + |
444 | + <section id="qa-infra-iso"> |
445 | + <title>Getting the ISO</title> |
446 | + |
447 | + <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> |
448 | + |
449 | + <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> |
450 | + |
451 | + </section> |
452 | + |
453 | + <section id="qa-infra-test"> |
454 | + <title>Methods of testing</title> |
455 | + |
456 | + <para>Now you've set up your basic contact(s) and have your ISO, you are in a position to test it.</para> |
457 | + |
458 | + <para>There are two main methods of testing the ISO:</para> |
459 | + |
460 | + <itemizedlist> |
461 | + <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> |
462 | + <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> |
463 | + </itemizedlist> |
464 | + |
465 | + <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> |
466 | + </section> |
467 | + |
468 | + <section id="qa-infra-track"> |
469 | + <title>Reporting your result</title> |
470 | + |
471 | + <para>There are two QA trackers we use.</para> |
472 | + |
473 | + <itemizedlist> |
474 | + <listitem><para>The ISO tracker mentioned above for any testing done with an ISO either an install or an upgrade test. </para></listitem> |
475 | + <listitem><para>The <ulink url="http://packages.qa.ubuntu.com/">Package</ulink> tracker, which is used when we are testing applications during a cycle.</para></listitem> |
476 | + </itemizedlist> |
477 | + |
478 | + <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> |
479 | + |
480 | + <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> |
481 | + </section> |
482 | +</sect1> |
483 | \ No newline at end of file |
484 | |
485 | === removed file 'contributor-docs/C/qa-team.xml' |
486 | --- contributor-docs/C/qa-team.xml 2017-02-19 07:48:04 +0000 |
487 | +++ contributor-docs/C/qa-team.xml 1970-01-01 00:00:00 +0000 |
488 | @@ -1,136 +0,0 @@ |
489 | -<?xml version="1.0" encoding="UTF-8"?> |
490 | -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
491 | -"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ |
492 | -<!ENTITY % xubuntu-common SYSTEM "../../libs-common/xubuntu-common.ent"> |
493 | -%xubuntu-common; |
494 | -<!ENTITY % xubuntu-contributor SYSTEM "../libs/xubuntu-contributor.ent"> |
495 | -%xubuntu-contributor; |
496 | -<!ENTITY % xinclude SYSTEM "../../libs-common/xinclude.mod"> |
497 | -%xinclude; |
498 | -<!ENTITY language "&EnglishAmerican;"> |
499 | -<!ENTITY language "C"> |
500 | -]> |
501 | - |
502 | -<chapter id="qa-team"> |
503 | - <title>QA Team Responsibilies</title> |
504 | - |
505 | - <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> |
506 | - |
507 | - <section id="qa-team-basics"> |
508 | - <title>QA Team</title> |
509 | - |
510 | - <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> |
511 | - |
512 | - <para>In addition, the team gives people contributing through testing of Xubuntu the opportunity to become part of the <ulink url="https://launchpad.net/~xubuntu-team">Xubuntu Team</ulink>. For that to be of practical use, the QA team should keep an eye on testing reports on the trackers and propose users they have seen taking a keen interest in the work of the QA team.</para> |
513 | - |
514 | - <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> |
515 | - |
516 | - <para>Members of the QA team should check the current Xubuntu QA blueprint, and assign themselves to tasks they feel able to undertake.</para> |
517 | - </section> |
518 | - |
519 | - <section id="qa-team-testing"> |
520 | - <title>Testing Responsibilities</title> |
521 | - |
522 | - <para>At the start of a cycle, the Release Team will discuss which ISO Milestones we will participate in. Then, during a Community Meeting, members of Xubuntu Team will discuss and then ratify Xubuntu's participation during the cycle.</para> |
523 | - |
524 | - <para>Along with general testing of our OS, dealt with further in <xref linkend="qa-testing-exploratory" /> and <xref linkend="qa-testing-ppa" />, further responsibilities lie with ensuring that:</para> |
525 | - |
526 | - <itemizedlist> |
527 | - <listitem><para>Sufficient testing takes place prior to ISO Milestone releases</para></listitem> |
528 | - <listitem><para>Sufficient package testing takes place following calls to testers</para></listitem> |
529 | - <listitem><para>Sufficient testing has taken place by Final Release</para></listitem> |
530 | - <listitem><para>Bugs reported to our trackers are confirmed, or where unable to confirm, further information is requested from the reporter</para></listitem> |
531 | - <listitem><para>Where appropriate, confirmation of bugs can be asked of members of Xubuntu Team in the team devel IRC channel</para></listitem> |
532 | - </itemizedlist> |
533 | - |
534 | - <para>Members of the QA team might find it useful subscribing to the <ulink url="https://launchpad.net/~xubuntu-bugs">Xubuntu Bugs</ulink> team in order to be aware of bugs being reported by users.</para> |
535 | - </section> |
536 | - |
537 | - <section id="qa-team-trackers"> |
538 | - <title>Working with the QA Trackers</title> |
539 | - |
540 | - <para>The initial decisions on what and when to test, will be taken following discussion with the members of the <ulink url="https://launchpad.net/~xubuntu-release">Xubuntu Release</ulink> team.</para> |
541 | - |
542 | - <para>At the start of a cycle, the QA team needs to ensure that:</para> |
543 | - |
544 | - <itemizedlist> |
545 | - <listitem><para>Image testcases we use are still correct.</para></listitem> |
546 | - <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> |
547 | - <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> |
548 | - <listitem><para>Scheduling of ISO, and when appropriate Package, testing should take place amongst the QA team.</para></listitem> |
549 | - </itemizedlist> |
550 | - |
551 | - <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> |
552 | - |
553 | - <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> |
554 | - |
555 | - <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> |
556 | - |
557 | - </section> |
558 | - |
559 | - <section id="qa-team-testedits"> |
560 | - <title>Working with Testcases</title> |
561 | - |
562 | - <para>Information on the basic method of working with testcases can be found at the Ubuntu QA Team <ulink url="https://wiki.ubuntu.com/QATeam/ContributingTestcases/Manual">Manual Testcases</ulink> page.</para> |
563 | - |
564 | - <para><emphasis>We</emphasis> are only concerned with a specific set of tasks: grabbing the branch, making edits and then pushing the changes we need to the main branch. We have people in the Testcase Admin team for the LP Testcases, in addition any member of our Release Team can edit the tracker, this helps ensure that changes are moved through to the trackers quickly.</para> |
565 | - |
566 | - <para>To edit a testcase:</para> |
567 | - |
568 | - <itemizedlist> |
569 | - <listitem><para><ulink url="https://bugs.launchpad.net/ubuntu-manual-tests/+filebug">Report</ulink> the required change as a bug against the testcase project</para></listitem> |
570 | - <listitem><para>Assign yourself to the bug</para></listitem> |
571 | - <listitem><para>Create a local branch: <userinput>bzr branch lp:ubuntu-manual-tests</userinput></para></listitem> |
572 | - <listitem><para>Make changes to the testcase in your local branch</para></listitem> |
573 | - <listitem><para>Commit the changes: <userinput>bzr commit -m "Fix LP bug #BUGNO."</userinput></para></listitem> |
574 | - <listitem><para>Push to a personal remote branch: <userinput>bzr push lp:~username/ubuntu-manual-tests/bug-BUGNO</userinput></para></listitem> |
575 | - </itemizedlist> |
576 | - |
577 | - <para>Once pushed to a personal remote branch, propose the change for merging - <xref linkend="bzr-merge-proposal" />.</para> |
578 | - |
579 | - <para>Respond to any requests for changes when asked by the Testcase Admins in order to get the required change through in a timely manner.</para> |
580 | - </section> |
581 | - |
582 | - <section id="qa-team-users"> |
583 | - <title>Communicating with Testers and Users</title> |
584 | - |
585 | - <para>While we have two sets of people in the community that we contact about required testing, Testers will get regular contact from us, but we should only, in general, call on Users at later stages.</para> |
586 | - |
587 | - <para>The QA Lead will be an administrator on the Testers Launchpad page and can contact those users via LP. Copies of testing calls sent to the devel mailing list should go to this group each time.</para> |
588 | - |
589 | - <para>Any member of the QA team can:</para> |
590 | - |
591 | - <itemizedlist> |
592 | - <listitem><para>Mail the devel list with a testing call</para></listitem> |
593 | - <listitem><para>Just prior to an upcoming ISO Milestone testing call, warn on the devel list</para></listitem> |
594 | - <listitem><para>Make an ISO Milestone testing call</para></listitem> |
595 | - </itemizedlist> |
596 | - |
597 | - <para>Xubuntu Users will be contacted for ISO testing at later ISO Milestones, at the earliest the Beta 1 milestone, depending on the state of the current ISO and our packages.</para> |
598 | - </section> |
599 | - |
600 | - <section id="qa-team-release"> |
601 | - <title>Release Responsibilities</title> |
602 | - |
603 | - <para>Much of the responsibility for the QA team at any release lies with the QA Lead.</para> |
604 | - |
605 | - <para>However, <emphasis>any</emphasis> member of the QA team can:</para> |
606 | - |
607 | - <itemizedlist> |
608 | - <listitem><para>Work with the testing wiki <ulink url="https://wiki.ubuntu.com/Xubuntu/Testing/ReleaseNote">Release Note</ulink></para></listitem> |
609 | - <listitem><para>Check status of bugs listed on the above draft</para></listitem> |
610 | - <listitem><para>Check status of work items on the QA blueprint, marking as appropriate</para></listitem> |
611 | - </itemizedlist> |
612 | - </section> |
613 | - |
614 | - <section id="qa-post-release"> |
615 | - <title>Post Release Tasks</title> |
616 | - |
617 | - <para>Following release, there are a few tasks that need to be done before the next release cycle begins.</para> |
618 | - |
619 | - <itemizedlist> |
620 | - <listitem><para>QA Lead should set up the blueprints for both the QA team and the Bugs that the whole team uses</para></listitem> |
621 | - <listitem><para>Check that the draft Release Note is up to date</para></listitem> |
622 | - </itemizedlist> |
623 | - </section> |
624 | -</chapter> |
625 | |
626 | === removed file 'contributor-docs/C/qa-tester.xml' |
627 | --- contributor-docs/C/qa-tester.xml 2017-02-19 07:48:04 +0000 |
628 | +++ contributor-docs/C/qa-tester.xml 1970-01-01 00:00:00 +0000 |
629 | @@ -1,76 +0,0 @@ |
630 | -<?xml version="1.0" encoding="UTF-8"?> |
631 | -<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
632 | -"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ |
633 | -<!ENTITY % xubuntu-common SYSTEM "../../libs-common/xubuntu-common.ent"> |
634 | -%xubuntu-common; |
635 | -<!ENTITY % xubuntu-contributor SYSTEM "../libs/xubuntu-contributor.ent"> |
636 | -%xubuntu-contributor; |
637 | -<!ENTITY % xinclude SYSTEM "../../libs-common/xinclude.mod"> |
638 | -%xinclude; |
639 | -<!ENTITY language "&EnglishAmerican;"> |
640 | -<!ENTITY language "C"> |
641 | -]> |
642 | - |
643 | -<chapter id="qa-tester"> |
644 | - <title>Testing Infrastructure</title> |
645 | - <section id="qa-infra"> |
646 | - <title>Getting ready to test</title> |
647 | - |
648 | - <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> |
649 | - </section> |
650 | - |
651 | - <section id="qa-infra-specs"> |
652 | - <title>Contacts</title> |
653 | - |
654 | - <para>You need a Launchpad account, in order to join the necessary team(s) on it, and log into the 2 QA trackers.</para> |
655 | - |
656 | - <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> |
657 | - |
658 | - <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> |
659 | - |
660 | - <para>Join the Xubuntu Testers <ulink url="https://launchpad.net/~xubuntu-testers">Launchpad</ulink> team.</para> |
661 | - |
662 | - <para>Consider adding your details to the <ulink url="http://wiki.xubuntu.org/qa/teamhardware">Hardware</ulink> page. We can use this data to request specific testing from specific testers.</para> |
663 | - </section> |
664 | - |
665 | - <section id="qa-infra-iso"> |
666 | - <title>Getting the ISO</title> |
667 | - |
668 | - <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> |
669 | - |
670 | - <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> |
671 | - |
672 | - </section> |
673 | - |
674 | - <section id="qa-infra-test"> |
675 | - <title>Methods of testing</title> |
676 | - |
677 | - <para>Now you've set up your basic contact(s) and have your ISO, you are in a position to test it.</para> |
678 | - |
679 | - <para>There are two main methods of testing the ISO:</para> |
680 | - |
681 | - <itemizedlist> |
682 | - <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> |
683 | - <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> |
684 | - </itemizedlist> |
685 | - |
686 | - <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> |
687 | - </section> |
688 | - |
689 | - <section id="qa-infra-track"> |
690 | - <title>Reporting your result</title> |
691 | - |
692 | - <para>There are two QA trackers we use.</para> |
693 | - |
694 | - <itemizedlist> |
695 | - <listitem><para>The ISO tracker mentioned above for any testing done with an ISO either an install or an upgrade test. </para></listitem> |
696 | - <listitem><para>The <ulink url="http://packages.qa.ubuntu.com/">Package</ulink> tracker, which is used when we are testing applications during a cycle.</para></listitem> |
697 | - </itemizedlist> |
698 | - |
699 | - <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> |
700 | - |
701 | - <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> |
702 | - </section> |
703 | - |
704 | - |
705 | -</chapter> |
706 | |
707 | === modified file 'contributor-docs/C/qa-testing.xml' |
708 | --- contributor-docs/C/qa-testing.xml 2017-02-19 07:48:04 +0000 |
709 | +++ contributor-docs/C/qa-testing.xml 2017-03-02 18:48:00 +0000 |
710 | @@ -10,10 +10,9 @@ |
711 | <!ENTITY language "&EnglishAmerican;"> |
712 | <!ENTITY language "C"> |
713 | ]> |
714 | - |
715 | -<chapter id="qa-testing"> |
716 | +<sect1 id="qa-testing"> |
717 | <title>Package and ISO Testing</title> |
718 | - <section id="qa-iso"> |
719 | + <section id="qa-testing-iso"> |
720 | <title>ISOs</title> |
721 | |
722 | <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> |
723 | @@ -111,4 +110,4 @@ |
724 | |
725 | <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> |
726 | </section> |
727 | -</chapter> |
728 | +</sect1> |
729 | |
730 | === added file 'contributor-docs/C/qa.xml' |
731 | --- contributor-docs/C/qa.xml 1970-01-01 00:00:00 +0000 |
732 | +++ contributor-docs/C/qa.xml 2017-03-02 18:48:00 +0000 |
733 | @@ -0,0 +1,138 @@ |
734 | +<?xml version="1.0" encoding="UTF-8"?> |
735 | +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" |
736 | +"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ |
737 | +<!ENTITY % xubuntu-common SYSTEM "../../libs-common/xubuntu-common.ent"> |
738 | +%xubuntu-common; |
739 | +<!ENTITY % xubuntu-contributor SYSTEM "../libs/xubuntu-contributor.ent"> |
740 | +%xubuntu-contributor; |
741 | +<!ENTITY % xinclude SYSTEM "../../libs-common/xinclude.mod"> |
742 | +%xinclude; |
743 | +<!ENTITY language "&EnglishAmerican;"> |
744 | +<!ENTITY language "C"> |
745 | +]> |
746 | +<chapter id="qa"> |
747 | + <title>Quality Assurance (QA)</title> |
748 | + |
749 | + <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> |
750 | + |
751 | + <simplesect> |
752 | + <title>Introduction</title> |
753 | + |
754 | + <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> |
755 | + |
756 | + <para>In addition, the team gives people contributing through testing of Xubuntu the opportunity to become part of the <ulink url="https://launchpad.net/~xubuntu-team">Xubuntu Team</ulink>. For that to be of practical use, the QA team should keep an eye on testing reports on the trackers and propose users they have seen taking a keen interest in the work of the QA team.</para> |
757 | + |
758 | + <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> |
759 | + |
760 | + <para>Members of the QA team should check the current Xubuntu QA blueprint, and assign themselves to tasks they feel able to undertake.</para> |
761 | + </simplesect> |
762 | + |
763 | + <section id="qa-team-testing"> |
764 | + <title>Testing</title> |
765 | + |
766 | + <para>At the start of a cycle, the Release Team will discuss which ISO Milestones we will participate in. Then, during a Community Meeting, members of Xubuntu Team will discuss and then ratify Xubuntu's participation during the cycle.</para> |
767 | + |
768 | + <para>Along with general testing of our OS, dealt with further in <xref linkend="qa-testing-exploratory" /> and <xref linkend="qa-testing-ppa" />, further responsibilities lie with ensuring that:</para> |
769 | + |
770 | + <itemizedlist> |
771 | + <listitem><para>Sufficient testing takes place prior to ISO Milestone releases</para></listitem> |
772 | + <listitem><para>Sufficient package testing takes place following calls to testers</para></listitem> |
773 | + <listitem><para>Sufficient testing has taken place by Final Release</para></listitem> |
774 | + <listitem><para>Bugs reported to our trackers are confirmed, or where unable to confirm, further information is requested from the reporter</para></listitem> |
775 | + <listitem><para>Where appropriate, confirmation of bugs can be asked of members of Xubuntu Team in the team devel IRC channel</para></listitem> |
776 | + </itemizedlist> |
777 | + |
778 | + <para>Members of the QA team might find it useful subscribing to the <ulink url="https://launchpad.net/~xubuntu-bugs">Xubuntu Bugs</ulink> team in order to be aware of bugs being reported by users.</para> |
779 | + |
780 | + <xi:include href="qa-infra.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
781 | + <xi:include href="qa-testing.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
782 | + <xi:include href="qa-bugs.xml" xmlns:xi="http://www.w3.org/2001/XInclude"/> |
783 | + </section> |
784 | + |
785 | + <section id="qa-team-trackers"> |
786 | + <title>Working with trackers</title> |
787 | + |
788 | + <para>The initial decisions on what and when to test, will be taken following discussion with the members of the <ulink url="https://launchpad.net/~xubuntu-release">Xubuntu Release</ulink> team.</para> |
789 | + |
790 | + <para>At the start of a cycle, the QA team needs to ensure that:</para> |
791 | + |
792 | + <itemizedlist> |
793 | + <listitem><para>Image testcases we use are still correct.</para></listitem> |
794 | + <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> |
795 | + <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> |
796 | + <listitem><para>Scheduling of ISO, and when appropriate Package, testing should take place amongst the QA team.</para></listitem> |
797 | + </itemizedlist> |
798 | + |
799 | + <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> |
800 | + |
801 | + <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> |
802 | + |
803 | + <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> |
804 | + </section> |
805 | + |
806 | + <section id="qa-team-testcases"> |
807 | + <title>Working with testcases</title> |
808 | + |
809 | + <para>Information on the basic method of working with testcases can be found at the Ubuntu QA Team <ulink url="https://wiki.ubuntu.com/QATeam/ContributingTestcases/Manual">Manual Testcases</ulink> page.</para> |
810 | + |
811 | + <para><emphasis>We</emphasis> are only concerned with a specific set of tasks: grabbing the branch, making edits and then pushing the changes we need to the main branch. We have people in the Testcase Admin team for the LP Testcases, in addition any member of our Release Team can edit the tracker, this helps ensure that changes are moved through to the trackers quickly.</para> |
812 | + |
813 | + <para>To edit a testcase:</para> |
814 | + |
815 | + <itemizedlist> |
816 | + <listitem><para><ulink url="https://bugs.launchpad.net/ubuntu-manual-tests/+filebug">Report</ulink> the required change as a bug against the testcase project</para></listitem> |
817 | + <listitem><para>Assign yourself to the bug</para></listitem> |
818 | + <listitem><para>Create a local branch: <userinput>bzr branch lp:ubuntu-manual-tests</userinput></para></listitem> |
819 | + <listitem><para>Make changes to the testcase in your local branch</para></listitem> |
820 | + <listitem><para>Commit the changes: <userinput>bzr commit -m "Fix LP bug #BUGNO."</userinput></para></listitem> |
821 | + <listitem><para>Push to a personal remote branch: <userinput>bzr push lp:~username/ubuntu-manual-tests/bug-BUGNO</userinput></para></listitem> |
822 | + </itemizedlist> |
823 | + |
824 | + <para>Once pushed to a personal remote branch, propose the change for merging - <xref linkend="bzr-merge-proposal" />.</para> |
825 | + |
826 | + <para>Respond to any requests for changes when asked by the Testcase Admins in order to get the required change through in a timely manner.</para> |
827 | + </section> |
828 | + |
829 | + <section id="qa-team-communication"> |
830 | + <title>Communicating with Testers and Users</title> |
831 | + |
832 | + <para>While we have two sets of people in the community that we contact about required testing, Testers will get regular contact from us, but we should only, in general, call on Users at later stages.</para> |
833 | + |
834 | + <para>The QA Lead will be an administrator on the Testers Launchpad page and can contact those users via LP. Copies of testing calls sent to the devel mailing list should go to this group each time.</para> |
835 | + |
836 | + <para>Any member of the QA team can:</para> |
837 | + |
838 | + <itemizedlist> |
839 | + <listitem><para>Mail the devel list with a testing call</para></listitem> |
840 | + <listitem><para>Just prior to an upcoming ISO Milestone testing call, warn on the devel list</para></listitem> |
841 | + <listitem><para>Make an ISO Milestone testing call</para></listitem> |
842 | + </itemizedlist> |
843 | + |
844 | + <para>Xubuntu Users will be contacted for ISO testing at later ISO Milestones, at the earliest the Beta 1 milestone, depending on the state of the current ISO and our packages.</para> |
845 | + </section> |
846 | + |
847 | + <section id="qa-team-release"> |
848 | + <title>Release Responsibilities</title> |
849 | + |
850 | + <para>Much of the responsibility for the QA team at any release lies with the QA Lead.</para> |
851 | + |
852 | + <para>However, <emphasis>any</emphasis> member of the QA team can:</para> |
853 | + |
854 | + <itemizedlist> |
855 | + <listitem><para>Work with the testing wiki <ulink url="https://wiki.ubuntu.com/Xubuntu/Testing/ReleaseNote">Release Note</ulink></para></listitem> |
856 | + <listitem><para>Check status of bugs listed on the above draft</para></listitem> |
857 | + <listitem><para>Check status of work items on the QA blueprint, marking as appropriate</para></listitem> |
858 | + </itemizedlist> |
859 | + </section> |
860 | + |
861 | + <section id="qa-team-post-release"> |
862 | + <title>Post Release Tasks</title> |
863 | + |
864 | + <para>Following release, there are a few tasks that need to be done before the next release cycle begins.</para> |
865 | + |
866 | + <itemizedlist> |
867 | + <listitem><para>QA Lead should set up the blueprints for both the QA team and the Bugs that the whole team uses</para></listitem> |
868 | + <listitem><para>Check that the draft Release Note is up to date</para></listitem> |
869 | + </itemizedlist> |
870 | + </section> |
871 | +</chapter> |
872 | |
873 | === modified file 'contributor-docs/C/strategy-document.xml' |
874 | --- contributor-docs/C/strategy-document.xml 2016-09-02 20:41:05 +0000 |
875 | +++ contributor-docs/C/strategy-document.xml 2017-03-02 18:48:00 +0000 |
876 | @@ -12,6 +12,7 @@ |
877 | ]> |
878 | <appendix id="xsd"> |
879 | <title>Strategy Document</title> |
880 | + <?dbhtml stop-chunking?> |
881 | |
882 | <section id="xsd-introduction"> |
883 | <title>Introduction</title> |
884 | |
885 | === modified file 'contributor-docs/C/website.xml' |
886 | --- contributor-docs/C/website.xml 2015-11-22 14:44:04 +0000 |
887 | +++ contributor-docs/C/website.xml 2017-03-02 18:48:00 +0000 |
888 | @@ -12,11 +12,12 @@ |
889 | ]> |
890 | <chapter id="website"> |
891 | <title>Website</title> |
892 | + <?dbhtml stop-chunking?> |
893 | |
894 | <section id="website-introduction"> |
895 | <title>Introduction to the Xubuntu web presence</title> |
896 | |
897 | - <section id="website-introduction-xubuntu-org"> |
898 | + <simplesect id="website-introduction-xubuntu-org"> |
899 | <title>Xubuntu.org</title> |
900 | |
901 | <para><emphasis>The website is the main output for end-users.</emphasis> The content on the website should be easily understandable and approachable.</para> |
902 | @@ -24,12 +25,12 @@ |
903 | <para>The website is a WordPress instance on a server maintained by the Canonical IS. The website content is overseen and administrated by the Xubuntu website team. The website team can submit tickets to the Canonical IS for any problems. Bugs that are related to the website can be submitted on Launchpad, under the <ulink url="https://bugs.launchpad.net/xubuntu-website/+bugs">bugs for xubuntu-website</ulink>.</para> |
904 | |
905 | <para>The source code for the website is available at <literal>&branch;lp:xubuntu-website</literal> (the theme) and <literal>&branch;lp:xubuntu-website/plugins</literal> (the plugins).</para> |
906 | - </section> |
907 | + </simplesect> |
908 | |
909 | - <section id="website-introduction-wiki"> |
910 | + <simplesect id="website-introduction-wiki"> |
911 | <title>Xubuntu wiki</title> |
912 | |
913 | <para><emphasis>The Xubuntu wiki is used for some developer communication and serves as an archive for older release roadmaps and specification.</emphasis></para> |
914 | - </section> |
915 | + </simplesect> |
916 | </section> |
917 | </chapter> |
918 | \ No newline at end of file |
919 | |
920 | === modified file 'contributor-docs/Makefile' |
921 | --- contributor-docs/Makefile 2015-11-24 22:10:36 +0000 |
922 | +++ contributor-docs/Makefile 2017-03-02 18:48:00 +0000 |
923 | @@ -10,7 +10,7 @@ |
924 | endif |
925 | |
926 | # Xubuntu Docbook Customization Layers |
927 | -XUBUNTUXSL_HTML = ../libs-common/xubuntu-docbook-xhtml.xsl |
928 | +XUBUNTUXSL_HTML_CONTRIBUTOR = ../libs-common/xubuntu-docbook-xhtml-contributor.xsl |
929 | XUBUNTUXSL_PDF = ../libs-common/xubuntu-docbook-pdf.xsl |
930 | |
931 | # All available translations |
932 | @@ -23,7 +23,7 @@ |
933 | all: clean html html-translations pdf pdf-translations |
934 | |
935 | html: html-style |
936 | - xsltproc --xinclude -o ../build/contributor/C/index.html $(XUBUNTUXSL_HTML) C/index.xml |
937 | + xsltproc --xinclude -o ../build/contributor/C/index.html $(XUBUNTUXSL_HTML_CONTRIBUTOR) C/index.xml |
938 | |
939 | pdf: |
940 | xsltproc --stringparam paper.type A4 --xinclude -o fo/C-A4.fo $(XUBUNTUXSL_PDF) C/index.xml |
941 | @@ -60,7 +60,7 @@ |
942 | |
943 | html-translations: html-style translate |
944 | for dir in $(TRANSLATIONS); do \ |
945 | - xsltproc --xinclude -o ../build/contributor/$$dir/index.html $(XUBUNTUXSL_HTML) $$dir/index.xml; \ |
946 | + xsltproc --xinclude -o ../build/contributor/$$dir/index.html $(XUBUNTUXSL_HTML_CONTRIBUTOR) $$dir/index.xml; \ |
947 | done |
948 | |
949 | pdf-translations: translate |
950 | |
951 | === modified file 'contributor-docs/libs/xubuntu-contributor.ent' |
952 | --- contributor-docs/libs/xubuntu-contributor.ent 2016-12-15 17:50:54 +0000 |
953 | +++ contributor-docs/libs/xubuntu-contributor.ent 2017-03-02 18:48:00 +0000 |
954 | @@ -1,2 +1,1 @@ |
955 | -<?xml version="1.0" encoding="UTF-8"?> |
956 | -<!ENTITY status-tracker 'http://dev.xubuntu.org/' > |
957 | +<?xml version="1.0" encoding="UTF-8"?> |
958 | \ No newline at end of file |
959 | |
960 | === modified file 'libs-common/css/style.css' |
961 | --- libs-common/css/style.css 2016-03-17 11:35:25 +0000 |
962 | +++ libs-common/css/style.css 2017-03-02 18:48:00 +0000 |
963 | @@ -120,6 +120,10 @@ |
964 | font-size: 90%; |
965 | } |
966 | |
967 | +dd span.sect1 { |
968 | + line-height: 1.5em; |
969 | +} |
970 | + |
971 | .emphasis em { |
972 | font-weight: bold; |
973 | } |
974 | @@ -203,29 +207,38 @@ |
975 | |
976 | div.toc { |
977 | margin: 1em; |
978 | - padding: 1em 1em 0.5em 1.5em; |
979 | + padding: 0 1em 0 1.5em; |
980 | border-left: 2px solid #777; /* #2774e7 */ |
981 | } |
982 | |
983 | .toc p strong { |
984 | - font-weight: normal; |
985 | - font-size: 130%; |
986 | + display: none; |
987 | } |
988 | |
989 | .toc dt { |
990 | font-weight: bold; |
991 | } |
992 | |
993 | + .section .toc dt, |
994 | + .appendix .toc dt, |
995 | .chapter .toc dt { |
996 | margin-bottom: 0; |
997 | } |
998 | |
999 | + .section .toc a:empty { |
1000 | + display: none; |
1001 | + } |
1002 | + .section .toc dt, |
1003 | + .section .toc dd { |
1004 | + margin-left: 0; |
1005 | + } |
1006 | + |
1007 | .toc dd dl dt { |
1008 | margin-top: 0.2em; |
1009 | font-weight: normal; |
1010 | } |
1011 | |
1012 | - .chapter .toc + p { |
1013 | + .toc + p { |
1014 | margin-top: 2em; |
1015 | } |
1016 | |
1017 | @@ -278,8 +291,8 @@ |
1018 | div.note img, |
1019 | div.tip img, |
1020 | div.warning img { |
1021 | - margin-bottom: -32px; |
1022 | - margin-right: 16px; |
1023 | + margin-bottom: -20px; |
1024 | + margin-right: 4px; |
1025 | padding-bottom: 16px; |
1026 | } |
1027 | |
1028 | |
1029 | === modified file 'libs-common/xubuntu-common.ent' |
1030 | --- libs-common/xubuntu-common.ent 2015-11-22 14:44:04 +0000 |
1031 | +++ libs-common/xubuntu-common.ent 2017-03-02 18:48:00 +0000 |
1032 | @@ -6,7 +6,7 @@ |
1033 | produce unwanted side-effects. |
1034 | --> |
1035 | |
1036 | -<!ENTITY devel-codename 'xenial' > |
1037 | +<!ENTITY devel-codename 'zesty' > |
1038 | |
1039 | <!ENTITY branch '<inlinemediaobject role="icon-branch"><imageobject><imagedata role="icon-pad" fileref="../../libs-common/images/icon_branch.png" /></imageobject></inlinemediaobject>' > |
1040 | <!ENTITY package '<inlinemediaobject role="icon-pkg"><imageobject><imagedata role="icon-pad" fileref="../../libs-common/images/icon_package.png" /></imageobject></inlinemediaobject>' > |
1041 | |
1042 | === added file 'libs-common/xubuntu-docbook-xhtml-contributor.xsl' |
1043 | --- libs-common/xubuntu-docbook-xhtml-contributor.xsl 1970-01-01 00:00:00 +0000 |
1044 | +++ libs-common/xubuntu-docbook-xhtml-contributor.xsl 2017-03-02 18:48:00 +0000 |
1045 | @@ -0,0 +1,35 @@ |
1046 | +<?xml version="1.0" encoding="UTF-8" ?> |
1047 | +<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform" |
1048 | + xmlns:fo="http://www.w3.org/1999/XSL/Format" version="1.0"> |
1049 | + <!-- This file is a customization layer for HTML --> |
1050 | + |
1051 | + <!-- Imports --> |
1052 | + <xsl:import href="xubuntu-docbook-xhtml.xsl"/> |
1053 | + |
1054 | + <!-- Params --> |
1055 | + <xsl:param name="toc.max.depth" select="3"/> |
1056 | + <xsl:param name="chunk.section.depth" select="1" /> |
1057 | + <xsl:param name="chunk.first.sections" select="1" /> |
1058 | + <xsl:param name="generate.section.toc.level" select="3"/> |
1059 | + |
1060 | + <xsl:param name="generate.toc"> |
1061 | + appendix toc |
1062 | + appendix/section nop |
1063 | + appendix/section/section nop |
1064 | + book toc |
1065 | + chapter toc |
1066 | + chapter/section/section nop |
1067 | + part toc |
1068 | + section toc |
1069 | + </xsl:param> |
1070 | + |
1071 | + <xsl:template match="chapter" mode="toc"> |
1072 | + <xsl:call-template name="subtoc"> |
1073 | + <xsl:with-param name="nodes" select="section|section/sect1"/> |
1074 | + </xsl:call-template> |
1075 | + </xsl:template> |
1076 | + |
1077 | + <xsl:template match="sect1" mode="toc"> |
1078 | + <dd><xsl:call-template name="toc.line"/></dd> |
1079 | + </xsl:template> |
1080 | +</xsl:stylesheet> |
1081 | |
1082 | === modified file 'libs-common/xubuntu-docbook-xhtml.xsl' |
1083 | --- libs-common/xubuntu-docbook-xhtml.xsl 2015-11-22 14:44:04 +0000 |
1084 | +++ libs-common/xubuntu-docbook-xhtml.xsl 2017-03-02 18:48:00 +0000 |
1085 | @@ -12,6 +12,7 @@ |
1086 | <xsl:param name="use.id.as.filename" select="1"/> |
1087 | <xsl:param name="toc.section.depth" select="1"/> |
1088 | <xsl:param name="chunker.output.indent" select="'yes'"/> |
1089 | + <xsl:param name="chunk.section.depth" select="0" /> |
1090 | <xsl:param name="body.font.master" select="10"/> |
1091 | <xsl:param name="html.stylesheet" select="'../../libs-common/css/style.css'"/> |
1092 | <xsl:param name="shade.verbatim" select="0"/> |
1093 | @@ -30,13 +31,11 @@ |
1094 | |
1095 | <!-- Print header with logo --> |
1096 | <xsl:template name="header.navigation"> |
1097 | - <xsl:variable name="home" select="/*[1]"/> |
1098 | - <xsl:variable name="up" select="parent::*"/> |
1099 | - <div id="masthead"> |
1100 | - <a href="index.html"> |
1101 | - <img src="../../libs-common/images/logo.png" alt="Xubuntu" /> |
1102 | - </a> |
1103 | - </div> |
1104 | + <div id="masthead"> |
1105 | + <a href="index.html"> |
1106 | + <img src="../../libs-common/images/logo.png" alt="Xubuntu" /> |
1107 | + </a> |
1108 | + </div> |
1109 | </xsl:template> |
1110 | |
1111 | <!-- Navigation Graphics --> |
1112 | @@ -51,9 +50,6 @@ |
1113 | <xsl:param name="admon.graphics.path" select="'../../libs-common/images/'"/> |
1114 | <xsl:param name="admon.graphics.extension" select="'.png'"/> |
1115 | |
1116 | - <!-- Show all subpages directly below the mainpage --> |
1117 | - <xsl:param name="chunk.section.depth" select="0" /> |
1118 | - |
1119 | <!-- Formatting --> |
1120 | <xsl:template match="application"> |
1121 | <xsl:call-template name="inline.boldseq"/> |
1122 | |
1123 | === modified file 'user-docs/C/index.xml' |
1124 | --- user-docs/C/index.xml 2016-03-10 23:36:50 +0000 |
1125 | +++ user-docs/C/index.xml 2017-03-02 18:48:00 +0000 |
1126 | @@ -62,10 +62,7 @@ |
1127 | </legalnotice> |
1128 | |
1129 | <copyright> |
1130 | - <year>2012</year> |
1131 | - <year>2013</year> |
1132 | - <year>2014</year> |
1133 | - <year>2015</year> |
1134 | + <year>2012–2017</year> |
1135 | <holder>The Xubuntu documentation team. Xubuntu and Canonical are registered trademarks of Canonical Ltd.</holder> |
1136 | </copyright> |
1137 |
comments in line