nettika/geary
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Update user manual to add Contributing and improve the Bugs page.

Browse source
This commit is contained in:
Michael James Gratton 2018-06-13 20:30:43 +10:00
parent e8c3bf1b7b
commit 0f110d5acb
4 changed files with 75 additions and 34 deletions
Download patch file Download diff file Expand all files Collapse all files

47
help/C/bugs.page
View file

@ -2,21 +2,34 @@
type="guide"
id="bugs">
<info>
<link type="guide" xref="index#bug"/>
</info>
<title>Think you've found a bug?</title>
<p>If you suspect you've found a bug in Geary, follow these steps to report it:</p>
<steps>
<item><p>Search Geary's <link href="https://bugzilla.gnome.org/browse.cgi?product=geary">bug
database</link> to see if someone else has reported the bug.</p></item>
<item><p>Don't see your bug listed? Congratulations! You've found a new bug. To create an bug report,
create an account on GNOME's Bugzilla and
<link href="https://bugzilla.gnome.org/enter_bug.cgi?product=geary">file a new bug</link>. Be as
specific as you can and describe the steps to reproduce it. Don't forget to include details about
your operating system and what version of Geary you're running.</p></item>
<item><p>For general inquiries, please join the
<link href="https://mail.gnome.org/mailman/listinfo/geary-list"> Geary mailing
list</link>.</p></item>
</steps>
<title>Found a bug?</title>
<info>
<link type="guide" xref="index#contribute"/>
<link type="next" xref="limits"/>
</info>
<p>If you suspect you've found a bug in Geary, please <link
href="https://wiki.gnome.org/Apps/Geary/Contact">get in touch</link>
about it so it can be fixed.</p>
<p>To help diagnose the problem as fast as possible, please include
the following information:</p>
<list>
<item><p>Geary version</p></item>
<item><p>Geary installation method (Package? Flathub? Source
code?)</p></item>
<item><p>Your desktop (GNOME? KDE? Something else?)</p></item>
<item><p>Your operating system and version (Ubuntu 16.04? Fedora
28? Rolled your own?)</p></item>
<item><p>GTK+ version (3.something-something?)</p></item>
<item><p>Email provider (Gmail, Yahoo!, Outlook.com, or someone
else?)</p></item>
<item><p>How to reproduce the bug</p></item>
<item><p>What happened?</p></item>
<item><p>What did you expect to happen?</p></item>
</list>
<p>Thanks for your help!</p>
</page>

26
help/C/contributing.page Normal file
View file

@ -0,0 +1,26 @@
<page xmlns="http://projectmallard.org/1.0/"
type="guide"
id="contributing">
<title>Contribute to Geary</title>
<info>
<link type="guide" xref="index#contribute"/>
<link type="next" xref="bugs" />
</info>
<p>Want to help improve Geary? There are a number of ways you can
contribute:</p>
<list>
<item><p><link
href="https://wiki.gnome.org/Apps/Geary/ReportingABug">Bug
reporting</link>—report new bugs or request new features</p></item>
<item><p><link href="https://wiki.gnome.org/Apps/Geary/Design">User Experience Design</link>—research and develop Geary’s user experience</p></item>
<item><p><link href="https://wiki.gnome.org/Apps/Geary/Development">Development</link>—fix bugs and add new features</p></item>
<item><p><link href="https://wiki.gnome.org/Apps/Geary/Translating">Translating</link>—translate Geary’s user interface and user manual into new languages</p></item>
<item><p><link href="https://wiki.gnome.org/Apps/Geary/Contact">Join the discussion</link>—on the mailing list or IRC channel</p></item>
</list>
<p>Thanks for your help making Geary better!</p>
</page>

7
help/C/index.page
View file

@ -2,8 +2,7 @@
type="guide"
id="index">
<title><media type="image" src="figures/geary.svg"></media>
Geary</title>
<title><media type="image" src="figures/geary.svg"></media> Geary</title>
<section id="introduction" style="2column">
<title>Introduction</title>
@ -13,8 +12,8 @@ Geary</title>
<title>Using Geary</title>
</section>
<section id="bug" style="2column">
<title>Bugs</title>
<section id="contribute" style="2column">
<title>Contributing and bug reporting</title>
</section>
</page>

29
help/C/limits.page
View file

@ -2,17 +2,20 @@
type="topic"
id="limits">
<info>
<link type="guide" xref="index#bug"/>
<link type="next" xref="bugs" />
</info>
<title>Limitations</title>
<p>Geary is still in early development. Geary supports IMAP and has been tested with Gmail, Yahoo, and the free Dovecot mail server. Experimental support for Outlook.com is provided. Geary may not yet work well with some IMAP servers. At this time Geary is still missing numerous features including offline mode.</p>
<p>To learn more about the features we're working on and the future of Geary, please visit Geary's <link href="https://wiki.gnome.org/Apps/Geary">wiki page</link>.</p>
<title>Limitations</title>
<info>
<link type="guide" xref="index#contribute"/>
</info>
<p>Geary is still in early development. Geary supports IMAP and has
been tested with Gmail, Yahoo, and the free Dovecot mail server.
Experimental support for Outlook.com is provided. Geary may not yet
work well with some IMAP servers. At this time Geary is still
missing numerous features including offline mode.</p>
<p>To learn more about the features we're working on and the future
of Geary, please visit Geary's <link
href="https://wiki.gnome.org/Apps/Geary">wiki page</link>.</p>
</page>